BastionClientCompositeOperations¶
- class oci.bastion.BastionClientCompositeOperations(client, **kwargs)¶
This class provides a wrapper around
BastionClientand 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 BastionClientCompositeOperations object
create_bastion_and_wait_for_state(...[, ...])Calls
create_bastion()and waits for theWorkRequestto enter the given state(s).create_session_and_wait_for_state(...[, ...])Calls
create_session()and waits for theWorkRequestto enter the given state(s).delete_bastion_and_wait_for_state(bastion_id)Calls
delete_bastion()and waits for theWorkRequestto enter the given state(s).delete_session_and_wait_for_state(session_id)Calls
delete_session()and waits for theWorkRequestto enter the given state(s).update_bastion_and_wait_for_state(...[, ...])Calls
update_bastion()and waits for theWorkRequestto enter the given state(s).update_session_and_wait_for_state(...[, ...])Calls
update_session()and waits for theSessionacted upon to enter the given state(s).- __init__(client, **kwargs)¶
Creates a new BastionClientCompositeOperations object
- Parameters
client (BastionClient) – The service client which will be wrapped by this object
- create_bastion_and_wait_for_state(create_bastion_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_bastion()and waits for theWorkRequestto enter the given state(s).- Parameters
create_bastion_details (oci.bastion.models.CreateBastionDetails) – (required) Details for the new bastion.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_bastion()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- create_session_and_wait_for_state(create_session_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
create_session()and waits for theWorkRequestto enter the given state(s).- Parameters
create_session_details (oci.bastion.models.CreateSessionDetails) – (required) Details for the new session.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
create_session()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_bastion_and_wait_for_state(bastion_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_bastion()and waits for theWorkRequestto enter the given state(s).- Parameters
bastion_id (str) – (required) The unique identifier (OCID) of the bastion.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_bastion()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- delete_session_and_wait_for_state(session_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
delete_session()and waits for theWorkRequestto enter the given state(s).- Parameters
session_id (str) – (required) The unique identifier (OCID) of the session.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
delete_session()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_bastion_and_wait_for_state(bastion_id, update_bastion_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_bastion()and waits for theWorkRequestto enter the given state(s).- Parameters
bastion_id (str) – (required) The unique identifier (OCID) of the bastion.
update_bastion_details (oci.bastion.models.UpdateBastionDetails) – (required) The bastion information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
statusoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_bastion()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait
- update_session_and_wait_for_state(session_id, update_session_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶
Calls
update_session()and waits for theSessionacted upon to enter the given state(s).- Parameters
session_id (str) – (required) The unique identifier (OCID) of the session.
update_session_details (oci.bastion.models.UpdateSessionDetails) – (required) The session information to be updated.
wait_for_states (list[str]) – An array of states to wait on. These should be valid values for
lifecycle_stateoperation_kwargs (dict) – A dictionary of keyword arguments to pass to
update_session()waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the
oci.wait_until()function. For example, you could passmax_interval_secondsormax_interval_secondsas dictionary keys to modify how long the waiter function will wait between retries and the maximum amount of time it will wait