func GetQueryableFieldDescriptionFieldTypeEnumStringValues() []string
GetQueryableFieldDescriptionFieldTypeEnumStringValues Enumerates the set of values in String for QueryableFieldDescriptionFieldTypeEnum
func GetSearchDetailsMatchingContextTypeEnumStringValues() []string
GetSearchDetailsMatchingContextTypeEnumStringValues Enumerates the set of values in String for SearchDetailsMatchingContextTypeEnum
FreeTextSearchDetails A request containing arbitrary text that must be present in the resource.
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"`
}
func (m FreeTextSearchDetails) GetMatchingContextType() SearchDetailsMatchingContextTypeEnum
GetMatchingContextType returns MatchingContextType
func (m FreeTextSearchDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FreeTextSearchDetails) String() string
func (m FreeTextSearchDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetResourceTypeRequest wrapper for the GetResourceType operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcesearch/GetResourceType.go.html to see an example of how to use 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
}
func (request GetResourceTypeRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetResourceTypeRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetResourceTypeRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetResourceTypeRequest) String() string
func (request GetResourceTypeRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetResourceTypeResponse wrapper for the GetResourceType operation
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"`
}
func (response GetResourceTypeResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetResourceTypeResponse) String() string
ListResourceTypesRequest wrapper for the ListResourceTypes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcesearch/ListResourceTypes.go.html to see an example of how to use 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
}
func (request ListResourceTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListResourceTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListResourceTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListResourceTypesRequest) String() string
func (request ListResourceTypesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListResourceTypesResponse wrapper for the ListResourceTypes operation
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"`
}
func (response ListResourceTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListResourceTypesResponse) String() string
QueryableFieldDescription An individual field that can be used as part of a query filter.
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"`
}
func (m QueryableFieldDescription) String() string
func (m QueryableFieldDescription) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
QueryableFieldDescriptionFieldTypeEnum Enum with underlying type: string
type QueryableFieldDescriptionFieldTypeEnum string
Set of constants representing the allowable values for QueryableFieldDescriptionFieldTypeEnum
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"
)
func GetMappingQueryableFieldDescriptionFieldTypeEnum(val string) (QueryableFieldDescriptionFieldTypeEnum, bool)
GetMappingQueryableFieldDescriptionFieldTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetQueryableFieldDescriptionFieldTypeEnumValues() []QueryableFieldDescriptionFieldTypeEnum
GetQueryableFieldDescriptionFieldTypeEnumValues Enumerates the set of values for QueryableFieldDescriptionFieldTypeEnum
ResourceSearchClient a client for ResourceSearch
type ResourceSearchClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client *ResourceSearchClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcesearch/GetResourceType.go.html to see an example of how to use GetResourceType API. A default retry strategy applies to this operation GetResourceType()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcesearch/ListResourceTypes.go.html to see an example of how to use ListResourceTypes API. A default retry strategy applies to this operation ListResourceTypes()
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcesearch/SearchResources.go.html to see an example of how to use SearchResources API. A default retry strategy applies to this operation SearchResources()
func (client *ResourceSearchClient) SetRegion(region string)
SetRegion overrides the region of this client.
ResourceSummary A resource that exists in the cloud network that you're querying.
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.oracle.com/iaas/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.oracle.com/iaas/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.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"`
// Additional resource attribute fields of this resource that match queries with a return clause, if any.
// For example, if you ran a query to find the private IP addresses, public IP addresses, and isPrimary field of
// the VNIC attachment on instance resources, that field would be included in the ResourceSummary object as:
// {"additionalDetails": {"attachedVnic": [{"publicIP" : "172.110.110.110","privateIP" : "10.10.10.10","isPrimary" : true},
// {"publicIP" : "172.110.110.111","privateIP" : "10.10.10.11","isPrimary" : false}]}.
// The structure of the additional details attribute fields depends on the matching resource.
AdditionalDetails map[string]interface{} `mandatory:"false" json:"additionalDetails"`
}
func (m ResourceSummary) String() string
func (m ResourceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResourceSummaryCollection A summary representation of resources that matched the search criteria.
type ResourceSummaryCollection struct {
// A list of resources.
Items []ResourceSummary `mandatory:"false" json:"items"`
}
func (m ResourceSummaryCollection) String() string
func (m ResourceSummaryCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResourceType Defines a type of resource that you can find with a search or query.
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"`
}
func (m ResourceType) String() string
func (m ResourceType) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SearchContext Contains search context, such as highlighting, for found resources.
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"`
}
func (m SearchContext) String() string
func (m SearchContext) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SearchDetails A base request type that contains common criteria for searching for resources.
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
}
SearchDetailsMatchingContextTypeEnum Enum with underlying type: string
type SearchDetailsMatchingContextTypeEnum string
Set of constants representing the allowable values for SearchDetailsMatchingContextTypeEnum
const (
SearchDetailsMatchingContextTypeNone SearchDetailsMatchingContextTypeEnum = "NONE"
SearchDetailsMatchingContextTypeHighlights SearchDetailsMatchingContextTypeEnum = "HIGHLIGHTS"
)
func GetMappingSearchDetailsMatchingContextTypeEnum(val string) (SearchDetailsMatchingContextTypeEnum, bool)
GetMappingSearchDetailsMatchingContextTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSearchDetailsMatchingContextTypeEnumValues() []SearchDetailsMatchingContextTypeEnum
GetSearchDetailsMatchingContextTypeEnumValues Enumerates the set of values for SearchDetailsMatchingContextTypeEnum
SearchResourcesRequest wrapper for the SearchResources operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcesearch/SearchResources.go.html to see an example of how to use SearchResourcesRequest.
type SearchResourcesRequest struct {
// Request parameters that describe query criteria. For more information, see SearchDetails.
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
}
func (request SearchResourcesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SearchResourcesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SearchResourcesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SearchResourcesRequest) String() string
func (request SearchResourcesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SearchResourcesResponse wrapper for the SearchResources operation
type SearchResourcesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ResourceSummaryCollection instances
ResourceSummaryCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response, then there are additional items still to get. Include this value as the page parameter for the subsequent GET request. For information about pagination, see ListPagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For pagination of a list of items. When paging through a list, if this header appears in the response, then there are additional items in previous pages to get. Include this value as the page parameter for the subsequent GET request. The absence of this header indicates that you have reached the first page of the list. For more information, see ListPagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPreviousPage *string `presentIn:"header" name:"opc-previous-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"`
}
func (response SearchResourcesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SearchResourcesResponse) String() string
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.oracle.com/iaas/Content/Search/Concepts/querysyntax.htm).
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"`
}
func (m StructuredSearchDetails) GetMatchingContextType() SearchDetailsMatchingContextTypeEnum
GetMatchingContextType returns MatchingContextType
func (m StructuredSearchDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StructuredSearchDetails) String() string
func (m StructuredSearchDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly