resourcesearch

package
v24.3.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 8, 2020 License: Apache-2.0, UPL-1.0 Imports: 5 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FreeTextSearchDetails 

type FreeTextSearchDetails struct {

	// The text to search for.
	Text *string `mandatory:"true" json:"text"`

	// The type of matching context returned in the response. If you specify `HIGHLIGHTS`, then the service will highlight fragments in its response. (For more information, see ResourceSummary.searchContext and SearchContext.) The default setting is `NONE`.
	MatchingContextType SearchDetailsMatchingContextTypeEnum `mandatory:"false" json:"matchingContextType,omitempty"`
}

FreeTextSearchDetails A request containing arbitrary text that must be present in the resource.

func (FreeTextSearchDetails) GetMatchingContextType 

func (m FreeTextSearchDetails) GetMatchingContextType() SearchDetailsMatchingContextTypeEnum

GetMatchingContextType returns MatchingContextType

func (FreeTextSearchDetails) MarshalJSON 

func (m FreeTextSearchDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (FreeTextSearchDetails) String 

func (m FreeTextSearchDetails) String() string

type GetResourceTypeRequest 

type GetResourceTypeRequest struct {

	// The name of the resource type.
	Name *string `mandatory:"true" contributesTo:"path" name:"name"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
	// request, please provide the complete request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetResourceTypeRequest wrapper for the GetResourceType operation

func (GetResourceTypeRequest) HTTPRequest 

func (request GetResourceTypeRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetResourceTypeRequest) RetryPolicy 

func (request GetResourceTypeRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetResourceTypeRequest) String 

func (request GetResourceTypeRequest) String() string

type GetResourceTypeResponse 

type GetResourceTypeResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The ResourceType instance
	ResourceType `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetResourceTypeResponse wrapper for the GetResourceType operation

func (GetResourceTypeResponse) HTTPResponse 

func (response GetResourceTypeResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetResourceTypeResponse) String 

func (response GetResourceTypeResponse) String() string

type ListResourceTypesRequest 

type ListResourceTypesRequest struct {

	// The maximum number of items to return. The value must be between 1 and 1000.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page at which to start retrieving results.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
	// request, please provide the complete request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListResourceTypesRequest wrapper for the ListResourceTypes operation

func (ListResourceTypesRequest) HTTPRequest 

func (request ListResourceTypesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListResourceTypesRequest) RetryPolicy 

func (request ListResourceTypesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListResourceTypesRequest) String 

func (request ListResourceTypesRequest) String() string

type ListResourceTypesResponse 

type ListResourceTypesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of []ResourceType instances
	Items []ResourceType `presentIn:"body"`

	// Pagination token
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListResourceTypesResponse wrapper for the ListResourceTypes operation

func (ListResourceTypesResponse) HTTPResponse 

func (response ListResourceTypesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListResourceTypesResponse) String 

func (response ListResourceTypesResponse) String() string

type QueryableFieldDescription 

type QueryableFieldDescription struct {

	// The type of the field, which dictates what semantics and query constraints you can use when searching or querying.
	FieldType QueryableFieldDescriptionFieldTypeEnum `mandatory:"true" json:"fieldType"`

	// The name of the field to use when constructing the query. Field names are present for all types except `OBJECT`.
	FieldName *string `mandatory:"true" json:"fieldName"`

	// Indicates that this field is actually an array of the specified field type.
	IsArray *bool `mandatory:"false" json:"isArray"`

	// If the field type is `OBJECT`, then this property will provide all the individual properties of the object that can
	// be queried.
	ObjectProperties []QueryableFieldDescription `mandatory:"false" json:"objectProperties"`
}

QueryableFieldDescription An individual field that can be used as part of a query filter.

func (QueryableFieldDescription) String 

func (m QueryableFieldDescription) String() string

type QueryableFieldDescriptionFieldTypeEnum 

type QueryableFieldDescriptionFieldTypeEnum string

QueryableFieldDescriptionFieldTypeEnum Enum with underlying type: string 

const (
	QueryableFieldDescriptionFieldTypeIdentifier QueryableFieldDescriptionFieldTypeEnum = "IDENTIFIER"
	QueryableFieldDescriptionFieldTypeString     QueryableFieldDescriptionFieldTypeEnum = "STRING"
	QueryableFieldDescriptionFieldTypeInteger    QueryableFieldDescriptionFieldTypeEnum = "INTEGER"
	QueryableFieldDescriptionFieldTypeRational   QueryableFieldDescriptionFieldTypeEnum = "RATIONAL"
	QueryableFieldDescriptionFieldTypeBoolean    QueryableFieldDescriptionFieldTypeEnum = "BOOLEAN"
	QueryableFieldDescriptionFieldTypeDatetime   QueryableFieldDescriptionFieldTypeEnum = "DATETIME"
	QueryableFieldDescriptionFieldTypeIp         QueryableFieldDescriptionFieldTypeEnum = "IP"
	QueryableFieldDescriptionFieldTypeObject     QueryableFieldDescriptionFieldTypeEnum = "OBJECT"
)

Set of constants representing the allowable values for QueryableFieldDescriptionFieldTypeEnum

func GetQueryableFieldDescriptionFieldTypeEnumValues 

func GetQueryableFieldDescriptionFieldTypeEnumValues() []QueryableFieldDescriptionFieldTypeEnum

GetQueryableFieldDescriptionFieldTypeEnumValues Enumerates the set of values for QueryableFieldDescriptionFieldTypeEnum

type ResourceSearchClient 

type ResourceSearchClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

ResourceSearchClient a client for ResourceSearch

func NewResourceSearchClientWithConfigurationProvider 

func NewResourceSearchClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ResourceSearchClient, err error)

NewResourceSearchClientWithConfigurationProvider Creates a new default ResourceSearch client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewResourceSearchClientWithOboToken 

func NewResourceSearchClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ResourceSearchClient, err error)

NewResourceSearchClientWithOboToken Creates a new default ResourceSearch client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer 

as well as reading the region

func (*ResourceSearchClient) ConfigurationProvider 

func (client *ResourceSearchClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (ResourceSearchClient) GetResourceType 

func (client ResourceSearchClient) GetResourceType(ctx context.Context, request GetResourceTypeRequest) (response GetResourceTypeResponse, err error)

GetResourceType Gets detailed information about a resource type by using the resource type name.

func (ResourceSearchClient) ListResourceTypes 

func (client ResourceSearchClient) ListResourceTypes(ctx context.Context, request ListResourceTypesRequest) (response ListResourceTypesResponse, err error)

ListResourceTypes Lists all resource types that you can search or query for.

func (ResourceSearchClient) SearchResources 

func (client ResourceSearchClient) SearchResources(ctx context.Context, request SearchResourcesRequest) (response SearchResourcesResponse, err error)

SearchResources Queries any and all compartments in the specified tenancy to find resources that match the specified criteria. Results include resources that you have permission to view and can span different resource types. You can also sort results based on a specified resource attribute.

func (*ResourceSearchClient) SetRegion 

func (client *ResourceSearchClient) SetRegion(region string)

SetRegion overrides the region of this client.

type ResourceSummary 

type ResourceSummary struct {

	// The resource type name.
	ResourceType *string `mandatory:"true" json:"resourceType"`

	// The unique identifier for this particular resource, usually an OCID.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The OCID of the compartment that contains this resource.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The time that this resource was created.
	TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`

	// The display name (or name) of this resource, if one exists.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The availability domain where this resource exists, if applicable.
	AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

	// The lifecycle state of this resource, if applicable.
	LifecycleState *string `mandatory:"false" json:"lifecycleState"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// System tags associated with this resource, if any. System tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces.
	// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{orcl-cloud: {free-tier-retain: true}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`

	SearchContext *SearchContext `mandatory:"false" json:"searchContext"`

	// Additional identifiers to use together in a "Get" request for a specified resource, only required for resource types
	// that explicitly cannot be retrieved by using a single identifier, such as the resource's OCID.
	IdentityContext map[string]interface{} `mandatory:"false" json:"identityContext"`
}

ResourceSummary A resource that exists in the cloud network that you're querying.

func (ResourceSummary) String 

func (m ResourceSummary) String() string

type ResourceSummaryCollection 

type ResourceSummaryCollection struct {

	// A list of resources.
	Items []ResourceSummary `mandatory:"false" json:"items"`
}

ResourceSummaryCollection A summary representation of resources that matched the search criteria.

func (ResourceSummaryCollection) String 

func (m ResourceSummaryCollection) String() string

type ResourceType 

type ResourceType struct {

	// The unique name of the resource type, which matches the value returned as part of the ResourceSummary object.
	Name *string `mandatory:"true" json:"name"`

	// List of all the fields and their value type that are indexed for querying.
	Fields []QueryableFieldDescription `mandatory:"true" json:"fields"`
}

ResourceType Defines a type of resource that you can find with a search or query.

func (ResourceType) String 

func (m ResourceType) String() string

type SearchContext 

type SearchContext struct {

	// Describes what in each field matched the search criteria by showing highlighted values, but only for free text searches or for structured
	// queries that use a MATCHING clause. The list of strings represents fragments of values that matched the query conditions. Highlighted
	// values are wrapped with <h1>..</h1> tags. All values are HTML-encoded (except <h1> tags).
	Highlights map[string][]string `mandatory:"false" json:"highlights"`
}

SearchContext Contains search context, such as highlighting, for found resources.

func (SearchContext) String 

func (m SearchContext) String() string

type SearchDetails 

type SearchDetails interface {

	// The type of matching context returned in the response. If you specify `HIGHLIGHTS`, then the service will highlight fragments in its response. (For more information, see ResourceSummary.searchContext and SearchContext.) The default setting is `NONE`.
	GetMatchingContextType() SearchDetailsMatchingContextTypeEnum
}

SearchDetails A base request type that contains common criteria for searching for resources.

type SearchDetailsMatchingContextTypeEnum 

type SearchDetailsMatchingContextTypeEnum string

SearchDetailsMatchingContextTypeEnum Enum with underlying type: string 

const (
	SearchDetailsMatchingContextTypeNone       SearchDetailsMatchingContextTypeEnum = "NONE"
	SearchDetailsMatchingContextTypeHighlights SearchDetailsMatchingContextTypeEnum = "HIGHLIGHTS"
)

Set of constants representing the allowable values for SearchDetailsMatchingContextTypeEnum

func GetSearchDetailsMatchingContextTypeEnumValues 

func GetSearchDetailsMatchingContextTypeEnumValues() []SearchDetailsMatchingContextTypeEnum

GetSearchDetailsMatchingContextTypeEnumValues Enumerates the set of values for SearchDetailsMatchingContextTypeEnum

type SearchResourcesRequest 

type SearchResourcesRequest struct {

	// Request parameters that describe query criteria.
	SearchDetails `contributesTo:"body"`

	// The maximum number of items to return. The value must be between 1 and 1000.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The page at which to start retrieving results.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The tenancy ID, which can be used to specify a different tenancy (for cross-tenancy authorization) when searching for resources in a different tenancy.
	TenantId *string `mandatory:"false" contributesTo:"query" name:"tenantId"`

	// The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular
	// request, please provide the complete request ID.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

SearchResourcesRequest wrapper for the SearchResources operation

func (SearchResourcesRequest) HTTPRequest 

func (request SearchResourcesRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (SearchResourcesRequest) RetryPolicy 

func (request SearchResourcesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (SearchResourcesRequest) String 

func (request SearchResourcesRequest) String() string

type SearchResourcesResponse 

type SearchResourcesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of ResourceSummaryCollection instances
	ResourceSummaryCollection `presentIn:"body"`

	// Pagination token
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

SearchResourcesResponse wrapper for the SearchResources operation

func (SearchResourcesResponse) HTTPResponse 

func (response SearchResourcesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (SearchResourcesResponse) String 

func (response SearchResourcesResponse) String() string

type StructuredSearchDetails 

type StructuredSearchDetails struct {

	// The structured query describing which resources to search for.
	Query *string `mandatory:"true" json:"query"`

	// The type of matching context returned in the response. If you specify `HIGHLIGHTS`, then the service will highlight fragments in its response. (For more information, see ResourceSummary.searchContext and SearchContext.) The default setting is `NONE`.
	MatchingContextType SearchDetailsMatchingContextTypeEnum `mandatory:"false" json:"matchingContextType,omitempty"`
}

StructuredSearchDetails A request that uses Search's structured query language to specify filter conditions to apply to search results. For more information about writing queries, see Search Language Syntax (https://docs.cloud.oracle.com/en-us/iaas/Content/Search/Concepts/querysyntax.htm).

func (StructuredSearchDetails) GetMatchingContextType 

func (m StructuredSearchDetails) GetMatchingContextType() SearchDetailsMatchingContextTypeEnum

GetMatchingContextType returns MatchingContextType

func (StructuredSearchDetails) MarshalJSON 

func (m StructuredSearchDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (StructuredSearchDetails) String 

func (m StructuredSearchDetails) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.