Oracle Cloud Infrastructure Documentation
Try Free Tier

Resource Search Common Types

DBMS_CLOUD_OCI_RESOURCE_SEARCH_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_RESOURCE_SEARCH_ERROR_T Type

The representation of an error.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing. See API Errors.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_RESOURCE_SEARCH_SEARCH_DETAILS_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_search_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_type varchar2(32767),
  matching_context_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_search_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_search_details_t (
    l_type varchar2,
    matching_context_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

l_type

(required) The type of SearchDetails, whether `FreeText` or `Structured`.

matching_context_type

(optional) 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`.

Allowed values are: 'NONE', 'HIGHLIGHTS'

DBMS_CLOUD_OCI_RESOURCE_SEARCH_FREE_TEXT_SEARCH_DETAILS_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_free_text_search_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_resource_search_search_details_t (
  text varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_free_text_search_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_free_text_search_details_t (
    l_type varchar2,
    matching_context_type varchar2,
    text varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_resource_search_free_text_search_details_t is a subtype of the dbms_cloud_oci_resource_search_search_details_t type.

Fields

Field Description

text

(required) The text to search for.

DBMS_CLOUD_OCI_RESOURCE_SEARCH_QUERYABLE_FIELD_DESCRIPTION_ABS_T

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_queryable_field_description_abs_t FORCE AUTHID CURRENT_USER IS OBJECT (
  field_type varchar2(32767),
  field_name varchar2(32767),
  is_array number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_queryable_field_description_abs_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_queryable_field_description_abs_t (
    field_type varchar2,
    field_name varchar2,
    is_array number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

field_type

(required) The type of the field, which dictates what semantics and query constraints you can use when searching or querying.

Allowed values are: 'IDENTIFIER', 'STRING', 'INTEGER', 'RATIONAL', 'BOOLEAN', 'DATETIME', 'IP', 'OBJECT'

field_name

(required) The name of the field to use when constructing the query. Field names are present for all types except `OBJECT`.

is_array

(optional) Indicates that this field is actually an array of the specified field type.

DBMS_CLOUD_OCI_RESOURCE_SEARCH_QUERYABLE_FIELD_DESCRIPTION_ABS_TBL Type

Nested table type of dbms_cloud_oci_resource_search_queryable_field_description_abs_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_queryable_field_description_abs_tbl FORCE IS TABLE OF (dbms_cloud_oci_resource_search_queryable_field_description_abs_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_RESOURCE_SEARCH_QUERYABLE_FIELD_DESCRIPTION_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_queryable_field_description_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_resource_search_queryable_field_description_abs_t (
  object_properties dbms_cloud_oci_resource_search_queryable_field_description_abs_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_queryable_field_description_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_queryable_field_description_t (
    field_type varchar2,
    field_name varchar2,
    is_array number,
    object_properties dbms_cloud_oci_resource_search_queryable_field_description_abs_tbl
  ) RETURN SELF AS RESULT
);

Fields

Field Description

object_properties

(optional) If the field type is `OBJECT`, then this property will provide all the individual properties of the object that can be queried.

DBMS_CLOUD_OCI_RESOURCE_SEARCH_QUERYABLE_FIELD_DESCRIPTION_TBL Type

Nested table type of dbms_cloud_oci_resource_search_queryable_field_description_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_queryable_field_description_tbl FORCE IS TABLE OF (dbms_cloud_oci_resource_search_queryable_field_description_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_RESOURCE_SEARCH_SEARCH_CONTEXT_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_search_context_t FORCE AUTHID CURRENT_USER IS OBJECT (
  highlights json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_search_context_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_search_context_t (
    highlights json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

highlights

(optional) 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).

DBMS_CLOUD_OCI_RESOURCE_SEARCH_RESOURCE_SUMMARY_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_resource_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  resource_type varchar2(32767),
  identifier varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  display_name varchar2(32767),
  availability_domain varchar2(32767),
  lifecycle_state varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  search_context dbms_cloud_oci_resource_search_search_context_t,
  identity_context json_element_t,
  additional_details json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_resource_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_resource_summary_t (
    resource_type varchar2,
    identifier varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    display_name varchar2,
    availability_domain varchar2,
    lifecycle_state varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t,
    search_context dbms_cloud_oci_resource_search_search_context_t,
    identity_context json_element_t,
    additional_details json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

resource_type

(required) The resource type name.

identifier

(required) The unique identifier for this particular resource, usually an OCID.

compartment_id

(required) The OCID of the compartment that contains this resource.

time_created

(optional) The time that this resource was created.

display_name

(optional) The display name (or name) of this resource, if one exists.

availability_domain

(optional) The availability domain where this resource exists, if applicable.

lifecycle_state

(optional) The lifecycle state of this resource, if applicable.

freeform_tags

(optional) 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. Example: `{\"Department\": \"Finance\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

system_tags

(optional) 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. Example: `{orcl-cloud: {free-tier-retain: true}}`

search_context

(optional)

identity_context

(optional) 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.

additional_details

(optional) 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.

DBMS_CLOUD_OCI_RESOURCE_SEARCH_RESOURCE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_resource_search_resource_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_resource_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_resource_search_resource_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_RESOURCE_SEARCH_RESOURCE_SUMMARY_COLLECTION_T Type

A summary representation of resources that matched the search criteria.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_resource_summary_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_resource_search_resource_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_resource_summary_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_resource_summary_collection_t (
    items dbms_cloud_oci_resource_search_resource_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) A list of resources.

DBMS_CLOUD_OCI_RESOURCE_SEARCH_RESOURCE_TYPE_T Type

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

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_resource_type_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  fields dbms_cloud_oci_resource_search_queryable_field_description_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_resource_type_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_resource_type_t (
    name varchar2,
    fields dbms_cloud_oci_resource_search_queryable_field_description_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) The unique name of the resource type, which matches the value returned as part of the ResourceSummary object.

fields

(required) List of all the fields and their value type that are indexed for querying.

DBMS_CLOUD_OCI_RESOURCE_SEARCH_STRUCTURED_SEARCH_DETAILS_T Type

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.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_resource_search_structured_search_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_resource_search_search_details_t (
  query varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_structured_search_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_resource_search_structured_search_details_t (
    l_type varchar2,
    matching_context_type varchar2,
    query varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_resource_search_structured_search_details_t is a subtype of the dbms_cloud_oci_resource_search_search_details_t type.

Fields

Field Description

query

(required) The structured query describing which resources to search for.

Was this article helpful?