DiscoveryClient¶

class oci.cloud_bridge.DiscoveryClient(config, **kwargs)¶

API for Oracle Cloud Bridge service.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_asset_source_compartment`(…)	Moves a resource into a different compartment.
`change_discovery_schedule_compartment`(…)	Moves the specified discovery schedule into a different compartment.
`create_asset_source`(…)	Creates an asset source.
`create_discovery_schedule`(…)	Creates the discovery schedule.
`delete_asset_source`(asset_source_id, **kwargs)	Deletes the asset source by ID.
`delete_discovery_schedule`(…)	Deletes the specified discovery schedule.
`get_asset_source`(asset_source_id, **kwargs)	Gets the asset source by ID.
`get_discovery_schedule`(…)	Reads information about the specified discovery schedule.
`list_asset_source_connections`(…)	Gets known connections to the asset source by the asset source ID.
`list_asset_sources`(compartment_id, **kwargs)	Returns a list of asset sources.
`list_discovery_schedules`(compartment_id, …)	Lists discovery schedules.
`list_supported_cloud_regions`(**kwargs)	Returns a list of supported cloud regions related to AssetSourceTypeParam.
`refresh_asset_source`(asset_source_id, **kwargs)	Initiates the process of asset metadata synchronization with the related asset source.
`update_asset_source`(asset_source_id, …)	Updates the asset source.
`update_discovery_schedule`(…)	Updates the specified discovery schedule.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_asset_source_compartment(asset_source_id, change_asset_source_compartment_details, **kwargs)¶

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

Parameters:	asset_source_id (str) – (required) The OCID of the asset source. change_asset_source_compartment_details (oci.cloud_bridge.models.ChangeAssetSourceCompartmentDetails) – (required) Details for the compartment move. if_match (str) – (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 (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_asset_source_compartment API.

change_discovery_schedule_compartment(discovery_schedule_id, change_discovery_schedule_compartment_details, **kwargs)¶

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

Parameters:	discovery_schedule_id (str) – (required) The OCID of the discovery schedule. change_discovery_schedule_compartment_details (oci.cloud_bridge.models.ChangeDiscoveryScheduleCompartmentDetails) – (required) Information about the compartment in to which the discovery schedule should be moved. if_match (str) – (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 (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_discovery_schedule_compartment API.

create_asset_source(create_asset_source_details, **kwargs)¶

Creates an asset source.

Parameters:	create_asset_source_details (oci.cloud_bridge.models.CreateAssetSourceDetails) – (required) Details for the new asset source. opc_retry_token (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AssetSource`
Return type:	`Response`
Example:

Click here to see an example of how to use create_asset_source API.

create_discovery_schedule(create_discovery_schedule_details, **kwargs)¶

Creates the discovery schedule.

Parameters:	create_discovery_schedule_details (oci.cloud_bridge.models.CreateDiscoveryScheduleDetails) – (required) Information about the discovery schedule being created. opc_retry_token (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DiscoverySchedule`
Return type:	`Response`
Example:

Click here to see an example of how to use create_discovery_schedule API.

delete_asset_source(asset_source_id, **kwargs)¶

Deletes the asset source by ID.

Parameters:	asset_source_id (str) – (required) The OCID of the asset source. if_match (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_asset_source API.

delete_discovery_schedule(discovery_schedule_id, **kwargs)¶

Deletes the specified discovery schedule.

Parameters:	discovery_schedule_id (str) – (required) The OCID of the discovery schedule. if_match (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_discovery_schedule API.

get_asset_source(asset_source_id, **kwargs)¶

Gets the asset source by ID.

Parameters:	asset_source_id (str) – (required) The OCID of the asset source. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AssetSource`
Return type:	`Response`
Example:

Click here to see an example of how to use get_asset_source API.

get_discovery_schedule(discovery_schedule_id, **kwargs)¶

Reads information about the specified discovery schedule.

Parameters:	discovery_schedule_id (str) – (required) The OCID of the discovery schedule. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DiscoverySchedule`
Return type:	`Response`
Example:

Click here to see an example of how to use get_discovery_schedule API.

list_asset_source_connections(asset_source_id, **kwargs)¶

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

Parameters:	asset_source_id (str) – (required) The OCID of the asset source. limit (int) – (optional) The maximum number of items to return. page (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AssetSourceConnectionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_asset_source_connections API.

list_asset_sources(compartment_id, **kwargs)¶

Returns a list of asset sources.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. asset_source_id (str) – (optional) The OCID of the asset source. sort_by (str) – (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 (str) – (optional) The current state of the asset source. Allowed values are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “UPDATING”, “NEEDS_ATTENTION” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” display_name (str) – (optional) A filter to return only resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. page (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AssetSourceCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_asset_sources API.

list_discovery_schedules(compartment_id, **kwargs)¶

Lists discovery schedules.

Parameters:	compartment_id (str) – (required) The ID of the compartment in which to list resources. discovery_schedule_id (str) – (optional) The OCID of the discovery schedule. lifecycle_state (str) – (optional) The current state of the discovery schedule. Allowed values are: “ACTIVE”, “DELETED” sort_by (str) – (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 (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” display_name (str) – (optional) A filter to return only resources that match the entire display name given. limit (int) – (optional) The maximum number of items to return. page (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DiscoveryScheduleCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_discovery_schedules API.

list_supported_cloud_regions(**kwargs)¶

Returns a list of supported cloud regions related to AssetSourceTypeParam.

Parameters:	asset_source_type (str) – (optional) The asset source type. Allowed values are: “VMWARE”, “AWS” name_contains (str) – (optional) A filter to return only supported cloud regions which name contains given nameContains as sub-string. sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. By default, name is in ascending order. Allowed values are: “name” sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” limit (int) – (optional) The maximum number of items to return. page (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `SupportedCloudRegionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_supported_cloud_regions API.

refresh_asset_source(asset_source_id, **kwargs)¶

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

Parameters:	asset_source_id (str) – (required) The OCID of the asset source. opc_request_id (str) – (optional) The client request ID for tracing. opc_retry_token (str) – (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. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use refresh_asset_source API.

update_asset_source(asset_source_id, update_asset_source_details, **kwargs)¶

Updates the asset source.

Parameters:	asset_source_id (str) – (required) The OCID of the asset source. update_asset_source_details (oci.cloud_bridge.models.UpdateAssetSourceDetails) – (required) Asset source information to be updated. if_match (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_asset_source API.

update_discovery_schedule(update_discovery_schedule_details, discovery_schedule_id, **kwargs)¶

Updates the specified discovery schedule.

Parameters:	update_discovery_schedule_details (oci.cloud_bridge.models.UpdateDiscoveryScheduleDetails) – (required) Discovery schedule information to be updated. discovery_schedule_id (str) – (required) The OCID of the discovery schedule. if_match (str) – (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 (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DiscoverySchedule`
Return type:	`Response`
Example:

Click here to see an example of how to use update_discovery_schedule API.