RoverBundleClient¶

class oci.rover.RoverBundleClient(config, **kwargs)¶

A description of the RoverCloudService API.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`list_rover_cluster_rover_bundle_requests`(…)	List all the roverBundleRequests for a given roverClusterId.
`list_rover_node_rover_bundle_requests`(…)	List all the roverBundleRequests for a given roverNodeId.
`request_bundle_rover_cluster`(…)	Request to get rover bundle to the bucket in customer’s tenancy.
`request_bundle_rover_node`(…)	Request to get rover bundle to the bucket in customer’s tenancy.
`retrieve_available_bundle_versions_rover_cluster`(…)	Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
`retrieve_available_bundle_versions_rover_node`(…)	Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
`retrieve_bundle_status_rover_cluster`(…)	Retrieve the status and progress of a rover bundle copy request.
`retrieve_bundle_status_rover_node`(…)	Retrieve the status and progress of a rover bundle copy request.

__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.

list_rover_cluster_rover_bundle_requests(rover_cluster_id, **kwargs)¶

List all the roverBundleRequests for a given roverClusterId.

Parameters:	rover_cluster_id (str) – (required) Unique RoverCluster identifier opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeTaskCreated is descending. If no value is specified timeTaskCreated is default. Allowed values are: “timeTaskCreated” 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 `RoverBundleRequestCollection`
Return type:	`Response`
Example:

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

list_rover_node_rover_bundle_requests(rover_node_id, **kwargs)¶

List all the roverBundleRequests for a given roverNodeId.

Parameters:	rover_node_id (str) – (required) Unique RoverNode identifier opc_request_id (str) – (optional) The client request ID for tracing. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for timeTaskCreated is descending. If no value is specified timeTaskCreated is default. Allowed values are: “timeTaskCreated” 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 `RoverBundleRequestCollection`
Return type:	`Response`
Example:

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

request_bundle_rover_cluster(request_rover_bundle_details, rover_cluster_id, **kwargs)¶

Request to get rover bundle to the bucket in customer’s tenancy.

Parameters:	request_rover_bundle_details (oci.rover.models.RequestRoverBundleDetails) – (required) Request the rover bundle details. rover_cluster_id (str) – (required) Unique RoverCluster identifier 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 request_bundle_rover_cluster API.

request_bundle_rover_node(request_rover_bundle_details, rover_node_id, **kwargs)¶

Request to get rover bundle to the bucket in customer’s tenancy.

Parameters:	request_rover_bundle_details (oci.rover.models.RequestRoverBundleDetails) – (required) Request the rover bundle details. rover_node_id (str) – (required) Unique RoverNode identifier 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 request_bundle_rover_node API.

retrieve_available_bundle_versions_rover_cluster(current_rover_bundle_details, rover_cluster_id, **kwargs)¶

Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.

Parameters:	current_rover_bundle_details (oci.rover.models.CurrentRoverBundleDetails) – (required) Provide the current rover bundle details. rover_cluster_id (str) – (required) Unique RoverCluster identifier 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 `RoverBundleVersion`
Return type:	`Response`
Example:

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

retrieve_available_bundle_versions_rover_node(current_rover_bundle_details, rover_node_id, **kwargs)¶

Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.

Parameters:	current_rover_bundle_details (oci.rover.models.CurrentRoverBundleDetails) – (required) Provide the current rover bundle details. rover_node_id (str) – (required) Unique RoverNode identifier 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 `RoverBundleVersion`
Return type:	`Response`
Example:

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

retrieve_bundle_status_rover_cluster(rover_bundle_status_details, rover_cluster_id, **kwargs)¶

Retrieve the status and progress of a rover bundle copy request.

Parameters:	rover_bundle_status_details (oci.rover.models.RoverBundleStatusDetails) – (required) Provide the rover bundle details that requires to retrieve its status. rover_cluster_id (str) – (required) Unique RoverCluster identifier 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 `RoverBundleStatus`
Return type:	`Response`
Example:

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

retrieve_bundle_status_rover_node(rover_bundle_status_details, rover_node_id, **kwargs)¶

Retrieve the status and progress of a rover bundle copy request.

Parameters:	rover_bundle_status_details (oci.rover.models.RoverBundleStatusDetails) – (required) Provide the rover bundle details that requires to retrieve its status. rover_node_id (str) – (required) Unique RoverNode identifier 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 `RoverBundleStatus`
Return type:	`Response`
Example:

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