BlockchainPlatformClientCompositeOperations¶
-
class
oci.blockchain.
BlockchainPlatformClientCompositeOperations
(client, **kwargs)¶ This class provides a wrapper around
BlockchainPlatformClient
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 BlockchainPlatformClientCompositeOperations object
Parameters: client (BlockchainPlatformClient) – The service client which will be wrapped by this object
-
change_blockchain_platform_compartment_and_wait_for_state
(blockchain_platform_id, change_blockchain_platform_compartment_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
change_blockchain_platform_compartment()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- change_blockchain_platform_compartment_details (oci.blockchain.models.ChangeBlockchainPlatformCompartmentDetails) – (required) Input payload to move the resource to a different compartment.
- 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
change_blockchain_platform_compartment()
- 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
-
create_blockchain_platform_and_wait_for_state
(create_blockchain_platform_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_blockchain_platform()
and waits for theWorkRequest
to enter the given state(s).Parameters: - create_blockchain_platform_details (oci.blockchain.models.CreateBlockchainPlatformDetails) – (required) Details for the new service.
- 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
create_blockchain_platform()
- 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
-
create_osn_and_wait_for_state
(blockchain_platform_id, create_osn_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_osn()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- create_osn_details (oci.blockchain.models.CreateOsnDetails) – (required) Input payload to create blockchain platform OSN. The payload cannot be empty.
- 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
create_osn()
- 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
-
create_peer_and_wait_for_state
(blockchain_platform_id, create_peer_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
create_peer()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- create_peer_details (oci.blockchain.models.CreatePeerDetails) – (required) Input payload to create a blockchain platform peer. The payload cannot be empty.
- 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
create_peer()
- 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_blockchain_platform_and_wait_for_state
(blockchain_platform_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_blockchain_platform()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- 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
delete_blockchain_platform()
- 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_osn_and_wait_for_state
(blockchain_platform_id, osn_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_osn()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- osn_id (str) – (required) OSN identifier.
- 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
delete_osn()
- 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_peer_and_wait_for_state
(blockchain_platform_id, peer_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_peer()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- peer_id (str) – (required) Peer identifier.
- 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
delete_peer()
- 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_work_request_and_wait_for_state
(work_request_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
delete_work_request()
and waits for theWorkRequest
to enter the given state(s).Parameters: - work_request_id (str) – (required) The ID of the asynchronous request.
- 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
delete_work_request()
- 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
-
scale_blockchain_platform_and_wait_for_state
(blockchain_platform_id, scale_blockchain_platform_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
scale_blockchain_platform()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- scale_blockchain_platform_details (oci.blockchain.models.ScaleBlockchainPlatformDetails) – (required) Input payload to scaleout blockchain platform. The payload cannot be empty.
- 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
scale_blockchain_platform()
- 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
-
start_blockchain_platform_and_wait_for_state
(blockchain_platform_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
start_blockchain_platform()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- 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
start_blockchain_platform()
- 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
-
stop_blockchain_platform_and_wait_for_state
(blockchain_platform_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
stop_blockchain_platform()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- 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
stop_blockchain_platform()
- 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_blockchain_platform_and_wait_for_state
(update_blockchain_platform_details, blockchain_platform_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_blockchain_platform()
and waits for theWorkRequest
to enter the given state(s).Parameters: - update_blockchain_platform_details (oci.blockchain.models.UpdateBlockchainPlatformDetails) – (required) The Blockchain Platform fields to update. Fields that are not provided will not be updated.
- blockchain_platform_id (str) – (required) Unique service identifier.
- 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
update_blockchain_platform()
- 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_osn_and_wait_for_state
(blockchain_platform_id, osn_id, update_osn_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_osn()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- osn_id (str) – (required) OSN identifier.
- update_osn_details (oci.blockchain.models.UpdateOsnDetails) – (required) Input payload to update a blockchain platform OSN. The payload cannot be empty.
- 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
update_osn()
- 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_peer_and_wait_for_state
(blockchain_platform_id, peer_id, update_peer_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
update_peer()
and waits for theWorkRequest
to enter the given state(s).Parameters: - blockchain_platform_id (str) – (required) Unique service identifier.
- peer_id (str) – (required) Peer identifier.
- update_peer_details (oci.blockchain.models.UpdatePeerDetails) – (required) Input payload to update a blockchain platform peer. The payload cannot be empty.
- 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
update_peer()
- 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
-
upgrade_blockchain_platform_and_wait_for_state
(upgrade_blockchain_platform_details, blockchain_platform_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶ Calls
upgrade_blockchain_platform()
and waits for theWorkRequest
to enter the given state(s).Parameters: - upgrade_blockchain_platform_details (oci.blockchain.models.UpgradeBlockchainPlatformDetails) – (required) Details for the new version to which it needs to be upgraded.
- blockchain_platform_id (str) – (required) Unique service identifier.
- 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
upgrade_blockchain_platform()
- 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
-