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

__init__(client, **kwargs)

Creates a new FileStorageClientCompositeOperations object

Parameters:client (FileStorageClient) -- The service client which will be wrapped by this object
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 (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 (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_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 (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_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 (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_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_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
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 (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 (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 (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_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 (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_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 (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