oci-go-sdk: github.com/oracle/oci-go-sdk/resourcesearch Index | Files

package resourcesearch

import "github.com/oracle/oci-go-sdk/resourcesearch"

Index

Package Files

free_text_search_details.go get_resource_type_request_response.go list_resource_types_request_response.go queryable_field_description.go resource_summary.go resource_summary_collection.go resource_type.go resourcesearch_client.go search_context.go search_details.go search_resources_request_response.go structured_search_details.go

type FreeTextSearchDetails Uses

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. (See ResourceSummary.searchContext and SearchContext for more information.) 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 Uses

func (m FreeTextSearchDetails) GetMatchingContextType() SearchDetailsMatchingContextTypeEnum

GetMatchingContextType returns MatchingContextType

func (FreeTextSearchDetails) MarshalJSON Uses

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

MarshalJSON marshals to json representation

func (FreeTextSearchDetails) String Uses

func (m FreeTextSearchDetails) String() string

type GetResourceTypeRequest Uses

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 Uses

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

HTTPRequest implements the OCIRequest interface

func (GetResourceTypeRequest) RetryPolicy Uses

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

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

func (GetResourceTypeRequest) String Uses

func (request GetResourceTypeRequest) String() string

type GetResourceTypeResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (GetResourceTypeResponse) String Uses

func (response GetResourceTypeResponse) String() string

type ListResourceTypesRequest Uses

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 Uses

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

HTTPRequest implements the OCIRequest interface

func (ListResourceTypesRequest) RetryPolicy Uses

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

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

func (ListResourceTypesRequest) String Uses

func (request ListResourceTypesRequest) String() string

type ListResourceTypesResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (ListResourceTypesResponse) String Uses

func (response ListResourceTypesResponse) String() string

type QueryableFieldDescription Uses

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 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 on 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 Uses

func (m QueryableFieldDescription) String() string

type QueryableFieldDescriptionFieldTypeEnum Uses

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 Uses

func GetQueryableFieldDescriptionFieldTypeEnumValues() []QueryableFieldDescriptionFieldTypeEnum

GetQueryableFieldDescriptionFieldTypeEnumValues Enumerates the set of values for QueryableFieldDescriptionFieldTypeEnum

type ResourceSearchClient Uses

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

ResourceSearchClient a client for ResourceSearch

func NewResourceSearchClientWithConfigurationProvider Uses

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 Uses

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 Uses

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

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

func (ResourceSearchClient) GetResourceType Uses

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 Uses

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 Uses

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

SearchResources Queries any and all compartments in the 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 Uses

func (client *ResourceSearchClient) SetRegion(region string)

SetRegion overrides the region of this client.

type ResourceSummary Uses

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 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 this resource is located in, if applicable.
    AvailabilityDomain *string `mandatory:"false" json:"availabilityDomain"`

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

    // The freeform tags associated with this resource, if any.
    FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

    // The defined tags associated with this resource, if any.
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

    // Contains search context, such as highlighting, for found resources.
    SearchContext *SearchContext `mandatory:"false" json:"searchContext"`
}

ResourceSummary A resource that exists in the user's cloud network.

func (ResourceSummary) String Uses

func (m ResourceSummary) String() string

type ResourceSummaryCollection Uses

type ResourceSummaryCollection struct {

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

ResourceSummaryCollection Summary representation of resources that matched the search criteria.

func (ResourceSummaryCollection) String Uses

func (m ResourceSummaryCollection) String() string

type ResourceType Uses

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 Uses

func (m ResourceType) String() string

type SearchContext Uses

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 <hl>..</hl> tags. All values are HTML-encoded (except <hl> tags).
    Highlights map[string][]string `mandatory:"false" json:"highlights"`
}

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

func (SearchContext) String Uses

func (m SearchContext) String() string

type SearchDetails Uses

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. (See ResourceSummary.searchContext and SearchContext for more information.) The default setting is `NONE`.
    GetMatchingContextType() SearchDetailsMatchingContextTypeEnum
}

SearchDetails A base request type containing common criteria for searching for resources.

type SearchDetailsMatchingContextTypeEnum Uses

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 Uses

func GetSearchDetailsMatchingContextTypeEnumValues() []SearchDetailsMatchingContextTypeEnum

GetSearchDetailsMatchingContextTypeEnumValues Enumerates the set of values for SearchDetailsMatchingContextTypeEnum

type SearchResourcesRequest Uses

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 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 Uses

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

HTTPRequest implements the OCIRequest interface

func (SearchResourcesRequest) RetryPolicy Uses

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

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

func (SearchResourcesRequest) String Uses

func (request SearchResourcesRequest) String() string

type SearchResourcesResponse Uses

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 Uses

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

HTTPResponse implements the OCIResponse interface

func (SearchResourcesResponse) String Uses

func (response SearchResourcesResponse) String() string

type StructuredSearchDetails Uses

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. (See ResourceSummary.searchContext and SearchContext for more information.) The default setting is `NONE`.
    MatchingContextType SearchDetailsMatchingContextTypeEnum `mandatory:"false" json:"matchingContextType,omitempty"`
}

StructuredSearchDetails A request containing search filters using the structured search query language.

func (StructuredSearchDetails) GetMatchingContextType Uses

func (m StructuredSearchDetails) GetMatchingContextType() SearchDetailsMatchingContextTypeEnum

GetMatchingContextType returns MatchingContextType

func (StructuredSearchDetails) MarshalJSON Uses

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

MarshalJSON marshals to json representation

func (StructuredSearchDetails) String Uses

func (m StructuredSearchDetails) String() string

Package resourcesearch imports 5 packages (graph). Updated 2020-04-08. Refresh now. Tools for package owners.