Cloud Bridge Discovery Functions

Package: DBMS_CLOUD_OCI_CB_DISCOVERY

CHANGE_ASSET_SOURCE_COMPARTMENT Function

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_asset_source_compartment (
  asset_source_id varchar2,
  change_asset_source_compartment_details dbms_cloud_oci_cloud_bridge_change_asset_source_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_change_asset_source_compartment_response_t;

Parameters

Parameter Description

asset_source_id

(required) The OCID of the asset source.

change_asset_source_compartment_details

(required) Details for the compartment move.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DISCOVERY_SCHEDULE_COMPARTMENT Function

Moves the specified discovery schedule into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_discovery_schedule_compartment (
  discovery_schedule_id varchar2,
  change_discovery_schedule_compartment_details dbms_cloud_oci_cloud_bridge_change_discovery_schedule_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_change_discovery_schedule_compartment_response_t;

Parameters

Parameter Description

discovery_schedule_id

(required) The OCID of the discovery schedule.

change_discovery_schedule_compartment_details

(required) Information about the compartment in to which the discovery schedule should be moved.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ASSET_SOURCE Function

Creates an asset source.

Syntax

FUNCTION create_asset_source (
  create_asset_source_details dbms_cloud_oci_cloud_bridge_create_asset_source_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_create_asset_source_response_t;

Parameters

Parameter Description

create_asset_source_details

(required) Details for the new asset source.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DISCOVERY_SCHEDULE Function

Creates the discovery schedule.

Syntax

FUNCTION create_discovery_schedule (
  create_discovery_schedule_details dbms_cloud_oci_cloud_bridge_create_discovery_schedule_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_create_discovery_schedule_response_t;

Parameters

Parameter Description

create_discovery_schedule_details

(required) Information about the discovery schedule being created.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ASSET_SOURCE Function

Deletes the asset source by ID.

Syntax

FUNCTION delete_asset_source (
  asset_source_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_delete_asset_source_response_t;

Parameters

Parameter Description

asset_source_id

(required) The OCID of the asset source.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DISCOVERY_SCHEDULE Function

Deletes the specified discovery schedule.

Syntax

FUNCTION delete_discovery_schedule (
  discovery_schedule_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_delete_discovery_schedule_response_t;

Parameters

Parameter Description

discovery_schedule_id

(required) The OCID of the discovery schedule.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ASSET_SOURCE Function

Gets the asset source by ID.

Syntax

FUNCTION get_asset_source (
  asset_source_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_get_asset_source_response_t;

Parameters

Parameter Description

asset_source_id

(required) The OCID of the asset source.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DISCOVERY_SCHEDULE Function

Reads information about the specified discovery schedule.

Syntax

FUNCTION get_discovery_schedule (
  discovery_schedule_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_get_discovery_schedule_response_t;

Parameters

Parameter Description

discovery_schedule_id

(required) The OCID of the discovery schedule.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ASSET_SOURCE_CONNECTIONS Function

Gets known connections to the asset source by the asset source ID.

Syntax

FUNCTION list_asset_source_connections (
  asset_source_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_list_asset_source_connections_response_t;

Parameters

Parameter Description

asset_source_id

(required) The OCID of the asset source.

limit

(optional) The maximum number of items to return.

page

(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ASSET_SOURCES Function

Returns a list of asset sources.

Syntax

FUNCTION list_asset_sources (
  compartment_id varchar2,
  asset_source_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_list_asset_sources_response_t;

Parameters

Parameter Description

compartment_id

(required) The ID of the compartment in which to list resources.

asset_source_id

(optional) The OCID of the asset source.

sort_by

(optional) The field to sort by. Only one sort order may be provided. By default, the timeCreated is in descending order and displayName is in ascending order.

Allowed values are: 'timeCreated', 'displayName'

lifecycle_state

(optional) The current state of the asset source.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'UPDATING', 'NEEDS_ATTENTION'

sort_order

(optional) The sort order to use, either 'ASC' or 'DESC'.

Allowed values are: 'ASC', 'DESC'

display_name

(optional) A filter to return only resources that match the entire display name given.

limit

(optional) The maximum number of items to return.

page

(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DISCOVERY_SCHEDULES Function

Lists discovery schedules.

Syntax

FUNCTION list_discovery_schedules (
  compartment_id varchar2,
  discovery_schedule_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_list_discovery_schedules_response_t;

Parameters

Parameter Description

compartment_id

(required) The ID of the compartment in which to list resources.

discovery_schedule_id

(optional) The OCID of the discovery schedule.

lifecycle_state

(optional) The current state of the discovery schedule.

Allowed values are: 'ACTIVE', 'DELETED'

sort_by

(optional) The field to sort by. Only one sort order may be provided. By default, the timeCreated is in descending order and displayName is in ascending order.

Allowed values are: 'timeCreated', 'displayName'

sort_order

(optional) The sort order to use, either 'ASC' or 'DESC'.

Allowed values are: 'ASC', 'DESC'

display_name

(optional) A filter to return only resources that match the entire display name given.

limit

(optional) The maximum number of items to return.

page

(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

REFRESH_ASSET_SOURCE Function

Initiates the process of asset metadata synchronization with the related asset source.

Syntax

FUNCTION refresh_asset_source (
  asset_source_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_refresh_asset_source_response_t;

Parameters

Parameter Description

asset_source_id

(required) The OCID of the asset source.

opc_request_id

(optional) The client request ID for tracing.

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ASSET_SOURCE Function

Updates the asset source.

Syntax

FUNCTION update_asset_source (
  asset_source_id varchar2,
  update_asset_source_details dbms_cloud_oci_cloud_bridge_update_asset_source_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_update_asset_source_response_t;

Parameters

Parameter Description

asset_source_id

(required) The OCID of the asset source.

update_asset_source_details

(required) Asset source information to be updated.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DISCOVERY_SCHEDULE Function

Updates the specified discovery schedule.

Syntax

FUNCTION update_discovery_schedule (
  update_discovery_schedule_details dbms_cloud_oci_cloud_bridge_update_discovery_schedule_details_t,
  discovery_schedule_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cb_discovery_update_discovery_schedule_response_t;

Parameters

Parameter Description

update_discovery_schedule_details

(required) Discovery schedule information to be updated.

discovery_schedule_id

(required) The OCID of the discovery schedule.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_request_id

(optional) The client request ID for tracing.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://cloudbridge.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.