RoverClusterClientCompositeOperations¶
-
class
oci.rover.
RoverClusterClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
RoverClusterClient
and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionalityMethods
__init__
(client, **kwargs)Creates a new RoverClusterClientCompositeOperations object create_rover_cluster_and_wait_for_state
(…)Calls create_rover_cluster()
and waits for theRoverCluster
acted upon to enter the given state(s).delete_rover_cluster_and_wait_for_state
(…)Calls delete_rover_cluster()
and waits for theRoverCluster
acted upon to enter the given state(s).request_additional_nodes_and_wait_for_state
(…)Calls request_additional_nodes()
and waits for theWorkRequest
to enter the given state(s).update_rover_cluster_and_wait_for_state
(…)Calls update_rover_cluster()
and waits for theRoverCluster
acted upon to enter the given state(s).-
__init__
(client, **kwargs)¶ Creates a new RoverClusterClientCompositeOperations object
Parameters: client (RoverClusterClient) – The service client which will be wrapped by this object
-
create_rover_cluster_and_wait_for_state
(create_rover_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_rover_cluster()
and waits for theRoverCluster
acted upon to enter the given state(s).Parameters: - create_rover_cluster_details (oci.rover.models.CreateRoverClusterDetails) – (required) Details for the new RoverCluster.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_rover_cluster()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
delete_rover_cluster_and_wait_for_state
(rover_cluster_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_rover_cluster()
and waits for theRoverCluster
acted upon to enter the given state(s).Parameters: - rover_cluster_id (str) – (required) Unique RoverCluster identifier
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_rover_cluster()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
request_additional_nodes_and_wait_for_state
(rover_cluster_id, request_additional_nodes_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
request_additional_nodes()
and waits for theWorkRequest
to enter the given state(s).Parameters: - rover_cluster_id (str) – (required) Unique RoverCluster identifier
- request_additional_nodes_details (oci.rover.models.RequestAdditionalNodesDetails) – (required) Details object to request additional nodes.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
status
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
request_additional_nodes()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-
update_rover_cluster_and_wait_for_state
(rover_cluster_id, update_rover_cluster_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_rover_cluster()
and waits for theRoverCluster
acted upon to enter the given state(s).Parameters: - rover_cluster_id (str) – (required) Unique RoverCluster identifier
- update_rover_cluster_details (oci.rover.models.UpdateRoverClusterDetails) – (required) The information to be updated.
- wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_state
- operation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_rover_cluster()
- waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()
function. For example, you could passmax_interval_seconds
ormax_interval_seconds
as dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
-