BlockstorageClientCompositeOperations

class oci.core.BlockstorageClientCompositeOperations(client, work_request_client=None, **kwargs)

This class provides a wrapper around BlockstorageClient 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 functionality

Methods:

__init__(client[, work_request_client])

Creates a new BlockstorageClientCompositeOperations object

copy_boot_volume_backup_and_wait_for_state(...)

Calls copy_boot_volume_backup() and waits for the BootVolumeBackup acted upon to enter the given state(s).

copy_boot_volume_backup_and_wait_for_work_request(...)

Calls copy_boot_volume_backup() and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).

copy_volume_backup_and_wait_for_state(...[, ...])

Calls copy_volume_backup() and waits for the VolumeBackup acted upon to enter the given state(s).

copy_volume_backup_and_wait_for_work_request(...)

Calls copy_volume_backup() and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).

copy_volume_group_backup_and_wait_for_state(...)

Calls copy_volume_group_backup() and waits for the VolumeGroupBackup acted upon to enter the given state(s).

create_boot_volume_and_wait_for_state(...[, ...])

Calls create_boot_volume() and waits for the BootVolume acted upon to enter the given state(s).

create_boot_volume_backup_and_wait_for_state(...)

Calls create_boot_volume_backup() and waits for the BootVolumeBackup acted upon to enter the given state(s).

create_volume_and_wait_for_state(...[, ...])

Calls create_volume() and waits for the Volume acted upon to enter the given state(s).

create_volume_backup_and_wait_for_state(...)

Calls create_volume_backup() and waits for the VolumeBackup acted upon to enter the given state(s).

create_volume_group_and_wait_for_state(...)

Calls create_volume_group() and waits for the VolumeGroup acted upon to enter the given state(s).

create_volume_group_backup_and_wait_for_state(...)

Calls create_volume_group_backup() and waits for the VolumeGroupBackup acted upon to enter the given state(s).

delete_boot_volume_and_wait_for_state(...[, ...])

Calls delete_boot_volume() and waits for the BootVolume acted upon to enter the given state(s).

delete_boot_volume_backup_and_wait_for_state(...)

Calls delete_boot_volume_backup() and waits for the BootVolumeBackup acted upon to enter the given state(s).

delete_volume_and_wait_for_state(volume_id)

Calls delete_volume() and waits for the Volume acted upon to enter the given state(s).

delete_volume_backup_and_wait_for_state(...)

Calls delete_volume_backup() and waits for the VolumeBackup acted upon to enter the given state(s).

delete_volume_group_and_wait_for_state(...)

Calls delete_volume_group() and waits for the VolumeGroup acted upon to enter the given state(s).

delete_volume_group_backup_and_wait_for_state(...)

Calls delete_volume_group_backup() and waits for the VolumeGroupBackup acted upon to enter the given state(s).

update_boot_volume_and_wait_for_state(...[, ...])

Calls update_boot_volume() and waits for the BootVolume acted upon to enter the given state(s).

update_boot_volume_backup_and_wait_for_state(...)

Calls update_boot_volume_backup() and waits for the BootVolumeBackup acted upon to enter the given state(s).

update_volume_and_wait_for_state(volume_id, ...)

Calls update_volume() and waits for the Volume acted upon to enter the given state(s).

update_volume_backup_and_wait_for_state(...)

Calls update_volume_backup() and waits for the VolumeBackup acted upon to enter the given state(s).

update_volume_group_and_wait_for_state(...)

Calls update_volume_group() and waits for the VolumeGroup acted upon to enter the given state(s).

update_volume_group_backup_and_wait_for_state(...)

Calls update_volume_group_backup() and waits for the VolumeGroupBackup acted upon to enter the given state(s).

__init__(client, work_request_client=None, **kwargs)

Creates a new BlockstorageClientCompositeOperations object

Parameters
copy_boot_volume_backup_and_wait_for_state(boot_volume_backup_id, copy_boot_volume_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls copy_boot_volume_backup() and waits for the BootVolumeBackup acted upon to enter the given state(s).

Parameters
  • boot_volume_backup_id (str) – (required) The OCID of the boot volume backup.

  • copy_boot_volume_backup_details (oci.core.models.CopyBootVolumeBackupDetails) – (required) Request to create a cross-region copy of given boot volume backup.

  • 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 copy_boot_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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

copy_boot_volume_backup_and_wait_for_work_request(boot_volume_backup_id, copy_boot_volume_backup_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})

Calls copy_boot_volume_backup() and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).

Parameters
  • boot_volume_backup_id (str) – (required) The OCID of the boot volume backup.

  • copy_boot_volume_backup_details (oci.core.models.CopyBootVolumeBackupDetails) – (required) Request to create a cross-region copy of given boot volume backup.

  • work_request_states (list[str]) – (optional) An array of work requests states to wait on. These should be valid values for status Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED]

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to copy_boot_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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

copy_volume_backup_and_wait_for_state(volume_backup_id, copy_volume_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls copy_volume_backup() and waits for the VolumeBackup acted upon to enter the given state(s).

Parameters
  • volume_backup_id (str) – (required) The OCID of the volume backup.

  • copy_volume_backup_details (oci.core.models.CopyVolumeBackupDetails) – (required) Request to create a cross-region copy of given backup.

  • 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 copy_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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

copy_volume_backup_and_wait_for_work_request(volume_backup_id, copy_volume_backup_details, work_request_states=[], operation_kwargs={}, waiter_kwargs={})

Calls copy_volume_backup() and waits for the oci.work_requests.models.WorkRequest to enter the given state(s).

Parameters
  • volume_backup_id (str) – (required) The OCID of the volume backup.

  • copy_volume_backup_details (oci.core.models.CopyVolumeBackupDetails) – (required) Request to create a cross-region copy of given backup.

  • work_request_states (list[str]) – (optional) An array of work requests states to wait on. These should be valid values for status Default values are termination states: [STATUS_SUCCEEDED, STATUS_FAILED, STATUS_CANCELED]

  • operation_kwargs (dict) – A dictionary of keyword arguments to pass to copy_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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

copy_volume_group_backup_and_wait_for_state(volume_group_backup_id, copy_volume_group_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls copy_volume_group_backup() and waits for the VolumeGroupBackup acted upon to enter the given state(s).

Parameters
  • volume_group_backup_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.

  • copy_volume_group_backup_details (oci.core.models.CopyVolumeGroupBackupDetails) – (required) Request to create a cross-region copy of given volume group backup.

  • 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 copy_volume_group_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_boot_volume_and_wait_for_state(create_boot_volume_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_boot_volume() and waits for the BootVolume acted upon to enter the given state(s).

Parameters
  • create_boot_volume_details (oci.core.models.CreateBootVolumeDetails) – (required) Request to create a new boot volume.

  • 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_boot_volume()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_boot_volume_backup_and_wait_for_state(create_boot_volume_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_boot_volume_backup() and waits for the BootVolumeBackup acted upon to enter the given state(s).

Parameters
  • create_boot_volume_backup_details (oci.core.models.CreateBootVolumeBackupDetails) – (required) Request to create a new backup of given boot volume.

  • 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_boot_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_and_wait_for_state(create_volume_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_volume() and waits for the Volume acted upon to enter the given state(s).

Parameters
  • create_volume_details (oci.core.models.CreateVolumeDetails) – (required) Request to create a new volume.

  • 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_volume()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_backup_and_wait_for_state(create_volume_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_volume_backup() and waits for the VolumeBackup acted upon to enter the given state(s).

Parameters
  • create_volume_backup_details (oci.core.models.CreateVolumeBackupDetails) – (required) Request to create a new backup of given volume.

  • 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_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_group_and_wait_for_state(create_volume_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_volume_group() and waits for the VolumeGroup acted upon to enter the given state(s).

Parameters
  • create_volume_group_details (oci.core.models.CreateVolumeGroupDetails) – (required) Request to create a new volume group.

  • 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_volume_group()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_group_backup_and_wait_for_state(create_volume_group_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls create_volume_group_backup() and waits for the VolumeGroupBackup acted upon to enter the given state(s).

Parameters
  • create_volume_group_backup_details (oci.core.models.CreateVolumeGroupBackupDetails) – (required) Request to create a new backup group of given volume group.

  • 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_volume_group_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_boot_volume_and_wait_for_state(boot_volume_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_boot_volume() and waits for the BootVolume acted upon to enter the given state(s).

Parameters
  • boot_volume_id (str) – (required) The OCID of the boot volume.

  • 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_boot_volume()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_boot_volume_backup_and_wait_for_state(boot_volume_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_boot_volume_backup() and waits for the BootVolumeBackup acted upon to enter the given state(s).

Parameters
  • boot_volume_backup_id (str) – (required) The OCID of the boot volume backup.

  • 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_boot_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_and_wait_for_state(volume_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_volume() and waits for the Volume acted upon to enter the given state(s).

Parameters
  • volume_id (str) – (required) The OCID of the volume.

  • 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_volume()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_backup_and_wait_for_state(volume_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_volume_backup() and waits for the VolumeBackup acted upon to enter the given state(s).

Parameters
  • volume_backup_id (str) – (required) The OCID of the volume backup.

  • 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_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_group_and_wait_for_state(volume_group_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_volume_group() and waits for the VolumeGroup acted upon to enter the given state(s).

Parameters
  • volume_group_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group.

  • 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_volume_group()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_group_backup_and_wait_for_state(volume_group_backup_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls delete_volume_group_backup() and waits for the VolumeGroupBackup acted upon to enter the given state(s).

Parameters
  • volume_group_backup_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.

  • 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_volume_group_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_boot_volume_and_wait_for_state(boot_volume_id, update_boot_volume_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_boot_volume() and waits for the BootVolume acted upon to enter the given state(s).

Parameters
  • boot_volume_id (str) – (required) The OCID of the boot volume.

  • update_boot_volume_details (oci.core.models.UpdateBootVolumeDetails) – (required) Update boot volume’s display name.

  • 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_boot_volume()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_boot_volume_backup_and_wait_for_state(boot_volume_backup_id, update_boot_volume_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_boot_volume_backup() and waits for the BootVolumeBackup acted upon to enter the given state(s).

Parameters
  • boot_volume_backup_id (str) – (required) The OCID of the boot volume backup.

  • update_boot_volume_backup_details (oci.core.models.UpdateBootVolumeBackupDetails) – (required) Update boot volume backup fields

  • 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_boot_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_and_wait_for_state(volume_id, update_volume_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_volume() and waits for the Volume acted upon to enter the given state(s).

Parameters
  • volume_id (str) – (required) The OCID of the volume.

  • update_volume_details (oci.core.models.UpdateVolumeDetails) – (required) Update volume’s display name. Avoid entering confidential information.

  • 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_volume()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_backup_and_wait_for_state(volume_backup_id, update_volume_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_volume_backup() and waits for the VolumeBackup acted upon to enter the given state(s).

Parameters
  • volume_backup_id (str) – (required) The OCID of the volume backup.

  • update_volume_backup_details (oci.core.models.UpdateVolumeBackupDetails) – (required) Update volume backup fields

  • 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_volume_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_group_and_wait_for_state(volume_group_id, update_volume_group_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_volume_group() and waits for the VolumeGroup acted upon to enter the given state(s).

Parameters
  • volume_group_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group.

  • update_volume_group_details (oci.core.models.UpdateVolumeGroupDetails) – (required) Update volume group’s set of volumes and/or display name

  • 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_volume_group()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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_volume_group_backup_and_wait_for_state(volume_group_backup_id, update_volume_group_backup_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})

Calls update_volume_group_backup() and waits for the VolumeGroupBackup acted upon to enter the given state(s).

Parameters
  • volume_group_backup_id (str) – (required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.

  • update_volume_group_backup_details (oci.core.models.UpdateVolumeGroupBackupDetails) – (required) Update volume group backup fields

  • 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_volume_group_backup()

  • waiter_kwargs (dict) – A dictionary of keyword arguments to pass to the oci.wait_until() function. For example, you could pass max_interval_seconds or max_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