FileStorageClientCompositeOperations¶

class oci.file_storage.FileStorageClientCompositeOperations(client, **kwargs)¶

This class provides a wrapper around FileStorageClient 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, **kwargs)	Creates a new FileStorageClientCompositeOperations object
`add_export_lock_and_wait_for_state`(…[, …])	Calls `add_export_lock()` and waits for the `Export` acted upon to enter the given state(s).
`add_file_system_lock_and_wait_for_state`(…)	Calls `add_file_system_lock()` and waits for the `FileSystem` acted upon to enter the given state(s).
`add_filesystem_snapshot_policy_lock_and_wait_for_state`(…)	Calls `add_filesystem_snapshot_policy_lock()` and waits for the `FilesystemSnapshotPolicy` acted upon to enter the given state(s).
`add_mount_target_lock_and_wait_for_state`(…)	Calls `add_mount_target_lock()` and waits for the `MountTarget` acted upon to enter the given state(s).
`add_outbound_connector_lock_and_wait_for_state`(…)	Calls `add_outbound_connector_lock()` and waits for the `OutboundConnector` acted upon to enter the given state(s).
`add_replication_lock_and_wait_for_state`(…)	Calls `add_replication_lock()` and waits for the `Replication` acted upon to enter the given state(s).
`add_snapshot_lock_and_wait_for_state`(…[, …])	Calls `add_snapshot_lock()` and waits for the `Snapshot` acted upon to enter the given state(s).
`cancel_downgrade_shape_mount_target_and_wait_for_state`(…)	Calls `cancel_downgrade_shape_mount_target()` and waits for the `MountTarget` acted upon to enter the given state(s).
`create_export_and_wait_for_state`(…[, …])	Calls `create_export()` and waits for the `Export` acted upon to enter the given state(s).
`create_file_system_and_wait_for_state`(…[, …])	Calls `create_file_system()` and waits for the `FileSystem` acted upon to enter the given state(s).
`create_filesystem_snapshot_policy_and_wait_for_state`(…)	Calls `create_filesystem_snapshot_policy()` and waits for the `FilesystemSnapshotPolicy` acted upon to enter the given state(s).
`create_mount_target_and_wait_for_state`(…)	Calls `create_mount_target()` and waits for the `MountTarget` acted upon to enter the given state(s).
`create_outbound_connector_and_wait_for_state`(…)	Calls `create_outbound_connector()` and waits for the `OutboundConnector` acted upon to enter the given state(s).
`create_replication_and_wait_for_state`(…[, …])	Calls `create_replication()` and waits for the `Replication` acted upon to enter the given state(s).
`create_snapshot_and_wait_for_state`(…[, …])	Calls `create_snapshot()` and waits for the `Snapshot` acted upon to enter the given state(s).
`delete_export_and_wait_for_state`(export_id)	Calls `delete_export()` and waits for the `Export` acted upon to enter the given state(s).
`delete_file_system_and_wait_for_state`(…[, …])	Calls `delete_file_system()` and waits for the `FileSystem` acted upon to enter the given state(s).
`delete_filesystem_snapshot_policy_and_wait_for_state`(…)	Calls `delete_filesystem_snapshot_policy()` and waits for the `FilesystemSnapshotPolicy` acted upon to enter the given state(s).
`delete_mount_target_and_wait_for_state`(…)	Calls `delete_mount_target()` and waits for the `MountTarget` acted upon to enter the given state(s).
`delete_outbound_connector_and_wait_for_state`(…)	Calls `delete_outbound_connector()` and waits for the `OutboundConnector` acted upon to enter the given state(s).
`delete_replication_and_wait_for_state`(…[, …])	Calls `delete_replication()` and waits for the `Replication` acted upon to enter the given state(s).
`delete_replication_target_and_wait_for_state`(…)	Calls `delete_replication_target()` and waits for the `ReplicationTarget` acted upon to enter the given state(s).
`delete_snapshot_and_wait_for_state`(snapshot_id)	Calls `delete_snapshot()` and waits for the `Snapshot` acted upon to enter the given state(s).
`pause_filesystem_snapshot_policy_and_wait_for_state`(…)	Calls `pause_filesystem_snapshot_policy()` and waits for the `FilesystemSnapshotPolicy` acted upon to enter the given state(s).
`remove_export_lock_and_wait_for_state`(…[, …])	Calls `remove_export_lock()` and waits for the `Export` acted upon to enter the given state(s).
`remove_file_system_lock_and_wait_for_state`(…)	Calls `remove_file_system_lock()` and waits for the `FileSystem` acted upon to enter the given state(s).
`remove_filesystem_snapshot_policy_lock_and_wait_for_state`(…)	Calls `remove_filesystem_snapshot_policy_lock()` and waits for the `FilesystemSnapshotPolicy` acted upon to enter the given state(s).
`remove_mount_target_lock_and_wait_for_state`(…)	Calls `remove_mount_target_lock()` and waits for the `MountTarget` acted upon to enter the given state(s).
`remove_outbound_connector_lock_and_wait_for_state`(…)	Calls `remove_outbound_connector_lock()` and waits for the `OutboundConnector` acted upon to enter the given state(s).
`remove_replication_lock_and_wait_for_state`(…)	Calls `remove_replication_lock()` and waits for the `Replication` acted upon to enter the given state(s).
`remove_snapshot_lock_and_wait_for_state`(…)	Calls `remove_snapshot_lock()` and waits for the `Snapshot` acted upon to enter the given state(s).
`schedule_downgrade_shape_mount_target_and_wait_for_state`(…)	Calls `schedule_downgrade_shape_mount_target()` and waits for the `MountTarget` acted upon to enter the given state(s).
`unpause_filesystem_snapshot_policy_and_wait_for_state`(…)	Calls `unpause_filesystem_snapshot_policy()` and waits for the `FilesystemSnapshotPolicy` acted upon to enter the given state(s).
`update_export_and_wait_for_state`(export_id, …)	Calls `update_export()` and waits for the `Export` acted upon to enter the given state(s).
`update_export_set_and_wait_for_state`(…[, …])	Calls `update_export_set()` and waits for the `ExportSet` acted upon to enter the given state(s).
`update_file_system_and_wait_for_state`(…[, …])	Calls `update_file_system()` and waits for the `FileSystem` acted upon to enter the given state(s).
`update_filesystem_snapshot_policy_and_wait_for_state`(…)	Calls `update_filesystem_snapshot_policy()` and waits for the `FilesystemSnapshotPolicy` acted upon to enter the given state(s).
`update_mount_target_and_wait_for_state`(…)	Calls `update_mount_target()` and waits for the `MountTarget` acted upon to enter the given state(s).
`update_outbound_connector_and_wait_for_state`(…)	Calls `update_outbound_connector()` and waits for the `OutboundConnector` acted upon to enter the given state(s).
`update_replication_and_wait_for_state`(…[, …])	Calls `update_replication()` and waits for the `Replication` acted upon to enter the given state(s).
`update_snapshot_and_wait_for_state`(…[, …])	Calls `update_snapshot()` and waits for the `Snapshot` acted upon to enter the given state(s).
`upgrade_shape_mount_target_and_wait_for_state`(…)	Calls `upgrade_shape_mount_target()` and waits for the `MountTarget` acted upon to enter the given state(s).

__init__(client, **kwargs)¶

Creates a new FileStorageClientCompositeOperations object

Parameters:	client (FileStorageClient) – The service client which will be wrapped by this object

add_export_lock_and_wait_for_state(export_id, add_export_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_export_lock() and waits for the Export acted upon to enter the given state(s).

Parameters:

export_id (str) –
(required) The OCID of the export.
add_export_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the AddLock.
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 add_export_lock()
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

add_file_system_lock_and_wait_for_state(file_system_id, add_file_system_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_file_system_lock() and waits for the FileSystem acted upon to enter the given state(s).

Parameters:

file_system_id (str) –
(required) The OCID of the file system.
add_file_system_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the AddLock.
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 add_file_system_lock()
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

add_filesystem_snapshot_policy_lock_and_wait_for_state(filesystem_snapshot_policy_id, add_filesystem_snapshot_policy_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_filesystem_snapshot_policy_lock() and waits for the FilesystemSnapshotPolicy acted upon to enter the given state(s).

Parameters:

filesystem_snapshot_policy_id (str) –
(required) The OCID of the file system snapshot policy.
add_filesystem_snapshot_policy_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the AddLock.
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 add_filesystem_snapshot_policy_lock()
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

add_mount_target_lock_and_wait_for_state(mount_target_id, add_mount_target_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_mount_target_lock() and waits for the MountTarget acted upon to enter the given state(s).

Parameters:

mount_target_id (str) –
(required) The OCID of the mount target.
add_mount_target_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the AddLock.
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 add_mount_target_lock()
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

add_outbound_connector_lock_and_wait_for_state(outbound_connector_id, add_outbound_connector_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_outbound_connector_lock() and waits for the OutboundConnector acted upon to enter the given state(s).

Parameters:

outbound_connector_id (str) –
(required) The OCID of the outbound connector.
add_outbound_connector_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the AddLock.
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 add_outbound_connector_lock()
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

add_replication_lock_and_wait_for_state(replication_id, add_replication_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_replication_lock() and waits for the Replication acted upon to enter the given state(s).

Parameters:

replication_id (str) –
(required) The OCID of the replication.
add_replication_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the AddLock.
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 add_replication_lock()
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

add_snapshot_lock_and_wait_for_state(snapshot_id, add_snapshot_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls add_snapshot_lock() and waits for the Snapshot acted upon to enter the given state(s).

Parameters:

snapshot_id (str) –
(required) The OCID of the snapshot.
add_snapshot_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the AddLock.
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 add_snapshot_lock()
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

cancel_downgrade_shape_mount_target_and_wait_for_state(mount_target_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls cancel_downgrade_shape_mount_target() and waits for the MountTarget acted upon to enter the given state(s).

Parameters:

mount_target_id (str) –
(required) The OCID of the mount target.
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 cancel_downgrade_shape_mount_target()
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_export_and_wait_for_state(create_export_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_export() and waits for the Export acted upon to enter the given state(s).

Parameters:

create_export_details (oci.file_storage.models.CreateExportDetails) – (required) Details for creating a new export.
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_export()
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_file_system_and_wait_for_state(create_file_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_file_system() and waits for the FileSystem acted upon to enter the given state(s).

Parameters:

create_file_system_details (oci.file_storage.models.CreateFileSystemDetails) – (required) Details for creating a new file system.
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_file_system()
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_filesystem_snapshot_policy_and_wait_for_state(create_filesystem_snapshot_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_filesystem_snapshot_policy() and waits for the FilesystemSnapshotPolicy acted upon to enter the given state(s).

Parameters:

create_filesystem_snapshot_policy_details (oci.file_storage.models.CreateFilesystemSnapshotPolicyDetails) – (required) Details for creating a new file system snapshot policy.
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_filesystem_snapshot_policy()
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_mount_target_and_wait_for_state(create_mount_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_mount_target() and waits for the MountTarget acted upon to enter the given state(s).

Parameters:

create_mount_target_details (oci.file_storage.models.CreateMountTargetDetails) – (required) Details for creating a new mount target.
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_mount_target()
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_outbound_connector_and_wait_for_state(create_outbound_connector_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_outbound_connector() and waits for the OutboundConnector acted upon to enter the given state(s).

Parameters:

create_outbound_connector_details (oci.file_storage.models.CreateOutboundConnectorDetails) – (required) Details for creating a new outbound connector.
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_outbound_connector()
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_replication_and_wait_for_state(create_replication_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_replication() and waits for the Replication acted upon to enter the given state(s).

Parameters:

create_replication_details (oci.file_storage.models.CreateReplicationDetails) – (required) Details for creating a new replication.
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_replication()
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_snapshot_and_wait_for_state(create_snapshot_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls create_snapshot() and waits for the Snapshot acted upon to enter the given state(s).

Parameters:

create_snapshot_details (oci.file_storage.models.CreateSnapshotDetails) – (required) Details for creating a new snapshot.
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_snapshot()
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_export_and_wait_for_state(export_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_export() and waits for the Export acted upon to enter the given state(s).

Parameters:

export_id (str) –
(required) The OCID of the export.
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_export()
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_file_system_and_wait_for_state(file_system_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_file_system() and waits for the FileSystem acted upon to enter the given state(s).

Parameters:

file_system_id (str) –
(required) The OCID of the file system.
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_file_system()
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_filesystem_snapshot_policy_and_wait_for_state(filesystem_snapshot_policy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_filesystem_snapshot_policy() and waits for the FilesystemSnapshotPolicy acted upon to enter the given state(s).

Parameters:

filesystem_snapshot_policy_id (str) –
(required) The OCID of the file system snapshot policy.
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_filesystem_snapshot_policy()
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_mount_target_and_wait_for_state(mount_target_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_mount_target() and waits for the MountTarget acted upon to enter the given state(s).

Parameters:

mount_target_id (str) –
(required) The OCID of the mount target.
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_mount_target()
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_outbound_connector_and_wait_for_state(outbound_connector_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_outbound_connector() and waits for the OutboundConnector acted upon to enter the given state(s).

Parameters:

outbound_connector_id (str) –
(required) The OCID of the outbound connector.
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_outbound_connector()
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_replication_and_wait_for_state(replication_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_replication() and waits for the Replication acted upon to enter the given state(s).

Parameters:

replication_id (str) –
(required) The OCID of the replication.
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_replication()
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_replication_target_and_wait_for_state(replication_target_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_replication_target() and waits for the ReplicationTarget acted upon to enter the given state(s).

Parameters:

replication_target_id (str) –
(required) The OCID of the replication target.
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_replication_target()
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_snapshot_and_wait_for_state(snapshot_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls delete_snapshot() and waits for the Snapshot acted upon to enter the given state(s).

Parameters:

snapshot_id (str) –
(required) The OCID of the snapshot.
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_snapshot()
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

pause_filesystem_snapshot_policy_and_wait_for_state(filesystem_snapshot_policy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls pause_filesystem_snapshot_policy() and waits for the FilesystemSnapshotPolicy acted upon to enter the given state(s).

Parameters:

filesystem_snapshot_policy_id (str) –
(required) The OCID of the file system snapshot policy.
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 pause_filesystem_snapshot_policy()
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

remove_export_lock_and_wait_for_state(export_id, remove_export_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_export_lock() and waits for the Export acted upon to enter the given state(s).

Parameters:

export_id (str) –
(required) The OCID of the export.
remove_export_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the RemoveLock.
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 remove_export_lock()
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

remove_file_system_lock_and_wait_for_state(file_system_id, remove_file_system_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_file_system_lock() and waits for the FileSystem acted upon to enter the given state(s).

Parameters:

file_system_id (str) –
(required) The OCID of the file system.
remove_file_system_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the RemoveLock.
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 remove_file_system_lock()
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

remove_filesystem_snapshot_policy_lock_and_wait_for_state(filesystem_snapshot_policy_id, remove_filesystem_snapshot_policy_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_filesystem_snapshot_policy_lock() and waits for the FilesystemSnapshotPolicy acted upon to enter the given state(s).

Parameters:

filesystem_snapshot_policy_id (str) –
(required) The OCID of the file system snapshot policy.
remove_filesystem_snapshot_policy_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the RemoveLock.
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 remove_filesystem_snapshot_policy_lock()
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

remove_mount_target_lock_and_wait_for_state(mount_target_id, remove_mount_target_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_mount_target_lock() and waits for the MountTarget acted upon to enter the given state(s).

Parameters:

mount_target_id (str) –
(required) The OCID of the mount target.
remove_mount_target_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the RemoveLock.
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 remove_mount_target_lock()
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

remove_outbound_connector_lock_and_wait_for_state(outbound_connector_id, remove_outbound_connector_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_outbound_connector_lock() and waits for the OutboundConnector acted upon to enter the given state(s).

Parameters:

outbound_connector_id (str) –
(required) The OCID of the outbound connector.
remove_outbound_connector_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the RemoveLock.
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 remove_outbound_connector_lock()
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

remove_replication_lock_and_wait_for_state(replication_id, remove_replication_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_replication_lock() and waits for the Replication acted upon to enter the given state(s).

Parameters:

replication_id (str) –
(required) The OCID of the replication.
remove_replication_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the RemoveLock.
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 remove_replication_lock()
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

remove_snapshot_lock_and_wait_for_state(snapshot_id, remove_snapshot_lock_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls remove_snapshot_lock() and waits for the Snapshot acted upon to enter the given state(s).

Parameters:

snapshot_id (str) –
(required) The OCID of the snapshot.
remove_snapshot_lock_details (oci.file_storage.models.ResourceLock) – (required) The details to be updated for the RemoveLock.
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 remove_snapshot_lock()
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

schedule_downgrade_shape_mount_target_and_wait_for_state(mount_target_id, schedule_downgrade_shape_mount_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls schedule_downgrade_shape_mount_target() and waits for the MountTarget acted upon to enter the given state(s).

Parameters:

mount_target_id (str) –
(required) The OCID of the mount target.
schedule_downgrade_shape_mount_target_details (oci.file_storage.models.ScheduleDowngradeShapeMountTargetDetails) – (required) Details for changing the shape of mount target.
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 schedule_downgrade_shape_mount_target()
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

unpause_filesystem_snapshot_policy_and_wait_for_state(filesystem_snapshot_policy_id, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls unpause_filesystem_snapshot_policy() and waits for the FilesystemSnapshotPolicy acted upon to enter the given state(s).

Parameters:

filesystem_snapshot_policy_id (str) –
(required) The OCID of the file system snapshot policy.
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 unpause_filesystem_snapshot_policy()
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_export_and_wait_for_state(export_id, update_export_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_export() and waits for the Export acted upon to enter the given state(s).

Parameters:

export_id (str) –
(required) The OCID of the export.
update_export_details (oci.file_storage.models.UpdateExportDetails) – (required) Details object for updating an export.
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_export()
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_export_set_and_wait_for_state(export_set_id, update_export_set_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_export_set() and waits for the ExportSet acted upon to enter the given state(s).

Parameters:

export_set_id (str) –
(required) The OCID of the export set.
update_export_set_details (oci.file_storage.models.UpdateExportSetDetails) – (required) Details object for updating an export set.
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_export_set()
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_file_system_and_wait_for_state(file_system_id, update_file_system_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_file_system() and waits for the FileSystem acted upon to enter the given state(s).

Parameters:

file_system_id (str) –
(required) The OCID of the file system.
update_file_system_details (oci.file_storage.models.UpdateFileSystemDetails) – (required) Details object for updating a file system.
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_file_system()
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_filesystem_snapshot_policy_and_wait_for_state(filesystem_snapshot_policy_id, update_filesystem_snapshot_policy_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_filesystem_snapshot_policy() and waits for the FilesystemSnapshotPolicy acted upon to enter the given state(s).

Parameters:

filesystem_snapshot_policy_id (str) –
(required) The OCID of the file system snapshot policy.
update_filesystem_snapshot_policy_details (oci.file_storage.models.UpdateFilesystemSnapshotPolicyDetails) – (required) Details object for updating a file system snapshot policy.
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_filesystem_snapshot_policy()
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_mount_target_and_wait_for_state(mount_target_id, update_mount_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_mount_target() and waits for the MountTarget acted upon to enter the given state(s).

Parameters:

mount_target_id (str) –
(required) The OCID of the mount target.
update_mount_target_details (oci.file_storage.models.UpdateMountTargetDetails) – (required) Details object for updating a mount target.
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_mount_target()
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_outbound_connector_and_wait_for_state(outbound_connector_id, update_outbound_connector_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_outbound_connector() and waits for the OutboundConnector acted upon to enter the given state(s).

Parameters:

outbound_connector_id (str) –
(required) The OCID of the outbound connector.
update_outbound_connector_details (oci.file_storage.models.UpdateOutboundConnectorDetails) – (required) Details object for updating a outbound connector.
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_outbound_connector()
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_replication_and_wait_for_state(replication_id, update_replication_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_replication() and waits for the Replication acted upon to enter the given state(s).

Parameters:

replication_id (str) –
(required) The OCID of the replication.
update_replication_details (oci.file_storage.models.UpdateReplicationDetails) – (required) Details object for updating a replication.
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_replication()
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_snapshot_and_wait_for_state(snapshot_id, update_snapshot_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls update_snapshot() and waits for the Snapshot acted upon to enter the given state(s).

Parameters:

snapshot_id (str) –
(required) The OCID of the snapshot.
update_snapshot_details (oci.file_storage.models.UpdateSnapshotDetails) – (required) Details object for updating a snapshot.
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_snapshot()
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

upgrade_shape_mount_target_and_wait_for_state(mount_target_id, upgrade_shape_mount_target_details, wait_for_states=[], operation_kwargs={}, waiter_kwargs={})¶

Calls upgrade_shape_mount_target() and waits for the MountTarget acted upon to enter the given state(s).

Parameters:

mount_target_id (str) –
(required) The OCID of the mount target.
upgrade_shape_mount_target_details (oci.file_storage.models.UpgradeShapeMountTargetDetails) – (required) Details for changing the shape of mount target.
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 upgrade_shape_mount_target()
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