swagger

package module

v1.0.0 Latest Latest Go to latest Published: Jul 2, 2021 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mattcui/ibm-global-search-client

Links

Open Source Insights

README ¶

Go API client for swagger

Search for resources with the global and shared resource properties repository integrated in the IBM Cloud platform. The search repository stores and searches cloud resources attributes, which categorize or classify resources. A resource is a physical or logical component that can be created or reserved for an application or service instance and is owned by resource providers, such as Cloud Foundry, IBM Kubernetes Service, or resource controller in IBM Cloud. Resources are uniquely identified by a Cloud Resource Name (CRN) or by an IMS ID. The properties of a resource include tags and system properties. Both properties are defined in an IBM Cloud billing account, and span across many regions.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 3.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://api.global-search-tagging.cloud.ibm.com

Class	Method	HTTP request	Description
ResourceTypesApi	GetSupportedTypes	Get /v2/resources/supported_types	DEPRECATED. Get all GhoST indices.
SearchApi	Search	Post /v3/resources/search	Find instances of resources (v3)
SearchApi	V2Search	Post /v2/resources/search	Find instances of resources (v2)

Documentation For Models

Documentation For Authorization

IAM

Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation ¶

Overview ¶

* Global Search * * Search for resources with the global and shared resource properties repository integrated in the IBM Cloud platform. The search repository stores and searches cloud resources attributes, which categorize or classify resources. A resource is a physical or logical component that can be created or reserved for an application or service instance and is owned by resource providers, such as Cloud Foundry, IBM Kubernetes Service, or resource controller in IBM Cloud. Resources are uniquely identified by a Cloud Resource Name (CRN) or by an IMS ID. The properties of a resource include tags and system properties. Both properties are defined in an IBM Cloud billing account, and span across many regions. * * API version: 3.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type BasicAuth
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type Errors
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type ModelError
type ResourceTypesApiService
- func (a *ResourceTypesApiService) GetSupportedTypes(ctx context.Context) (SupportedTypesList, *http.Response, error)
type ScanBody
type ScanResult
type SearchApiSearchOpts
type SearchApiService
- func (a *SearchApiService) Search(ctx context.Context, body ScanBody, localVarOptionals *SearchApiSearchOpts) (ScanResult, *http.Response, error)
- func (a *SearchApiService) V2Search(ctx context.Context, body SearchBody, localVarOptionals *SearchApiV2SearchOpts) (SearchResults, *http.Response, error)
type SearchApiV2SearchOpts
type SearchBody
type SearchResults
type SupportedTypesList

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	ResourceTypesApi *ResourceTypesApiService

	SearchApi *SearchApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Global Search API v3.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type Errors ¶

type Errors struct {
	// List of errors encountered in processing the request
	Errors []ModelError `json:"errors,omitempty"`
}

Error response

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type ModelError ¶

type ModelError struct {
	// A code that identifies the error.
	Code string `json:"code,omitempty"`
	// A description of the solution to the error.
	Description string `json:"description,omitempty"`
	// The severity level of the error.
	Level string `json:"level,omitempty"`
	// A description of the error detected in the request.
	Message string `json:"message,omitempty"`
	// The location of additional information about the error.
	MoreInfo string `json:"more_info,omitempty"`
	// The response received for the request.
	Response string `json:"response,omitempty"`
}

Error encountered in processing in the request

type ResourceTypesApiService ¶

type ResourceTypesApiService service

func (*ResourceTypesApiService) GetSupportedTypes ¶

func (a *ResourceTypesApiService) GetSupportedTypes(ctx context.Context) (SupportedTypesList, *http.Response, error)

ResourceTypesApiService DEPRECATED. Get all GhoST indices. Retrieves a list of all GhoST indices.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SupportedTypesList

type ScanBody ¶

type ScanBody struct {
	// The Lucene-formatted query string. Default to '*' if not set
	Query string `json:"query,omitempty"`
	// The list of the fields returned by the search. Defaults to all. `crn` is always returned.
	Fields []string `json:"fields,omitempty"`
	// An opaque search cursor that is returned on each operation call and that must be set on next call.
	SearchCursor string `json:"search_cursor,omitempty"`
}

The request body associated with a search request.

type ScanResult ¶

type ScanResult struct {
	// The search cursor to use on all calls after the first one.
	SearchCursor string `json:"search_cursor"`
	// Value of the limit parameter specified by the user
	Limit int32 `json:"limit,omitempty"`
	// The array of results. Each item represents a resource. An empty array signals the end of the result set, there are no more hits to fetch
	Items []ModelMap `json:"items"`
}

The search scan response

type SearchApiSearchOpts ¶

type SearchApiSearchOpts struct {
	TransactionId optional.String
	AccountId     optional.String
	Limit         optional.Int32
	Timeout       optional.Int32
	Sort          optional.Interface
}

type SearchApiService ¶

type SearchApiService service

func (*SearchApiService) Search ¶

func (a *SearchApiService) Search(ctx context.Context, body ScanBody, localVarOptionals *SearchApiSearchOpts) (ScanResult, *http.Response, error)

func (*SearchApiService) V2Search ¶

func (a *SearchApiService) V2Search(ctx context.Context, body SearchBody, localVarOptionals *SearchApiV2SearchOpts) (SearchResults, *http.Response, error)

type SearchApiV2SearchOpts ¶

type SearchApiV2SearchOpts struct {
	TransactionId optional.String
	AccountId     optional.String
	Limit         optional.Int32
	Timeout       optional.Int32
	Offset        optional.Int32
	Sort          optional.String
	Provider      optional.String
}

type SearchBody ¶

type SearchBody struct {
	// The query string
	Query []string `json:"query"`
	// The list of the fields that are returned by the search. The CRN is always returned.
	Fields []string `json:"fields,omitempty"`
	// An opaque token. Initially set to null or undefined, then pass the value returned by the previous call
	Token string `json:"token,omitempty"`
}

search body

type SearchResults ¶

type SearchResults struct {
	// The array of results. Each item will represent a resource and will contains all visible properties associated with it.
	Items []ModelMap `json:"items"`
	// If false, there is no more data to retrieve on the next page. If true, it's possible that there is more data to retrieve on the next page.
	MoreData bool `json:"more_data"`
	// The search token to use on the next call.
	Token string `json:"token,omitempty"`
	// It is set to true if the result is partial of an IAM error when validating user authorization on one or more resources. This field is DEPRECATED and will be removed in future versions of this API
	FilterError bool `json:"filter_error"`
	// Indicates if the result that is set might be partial or not. Value 0 means the result set is complete. A value greater than 0 means the result set might be incomplete. Its single bits identify the cause. The first bit means the error is in the IAM filter. The second bit means errors are in elasticsearch shards.
	PartialData int32 `json:"partial_data"`
	// Offset parameter specified by the user
	Offset int32 `json:"offset"`
	// Limit parameter specified by the user
	Limit int32 `json:"limit"`
}

The results of the requested search.

type SupportedTypesList ¶

type SupportedTypesList struct {
	// A list of all GhoST indices.
	SupportedTypes []string `json:"supported_types,omitempty"`
}

A list of all GhoST indices.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL