Get the endpoint that is being used to call (ex, https://www.example.com).
Sets the endpoint to call (ex, https://www.example.com).
The endpoint of the service.
Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
The region of the service.
Sets the regionId to call (ex, 'us-phoenix-1').
Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.
The public region ID.
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
flag to enable the use of realm specific endpoint template
Cancel scheduled downgrade shape request for mount target.
This operation does not retry by default if the user has not defined a retry configuration.
CancelDowngradeShapeMountTargetResponse
Moves a file system and its associated snapshots into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment
This operation does not retry by default if the user has not defined a retry configuration.
ChangeFileSystemCompartmentResponse
Moves a file system snapshot policy into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ChangeFilesystemSnapshotPolicyCompartmentResponse
Moves a mount target and its associated export set or share set into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment
This operation does not retry by default if the user has not defined a retry configuration.
ChangeMountTargetCompartmentResponse
Moves an outbound connector into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment
This operation does not retry by default if the user has not defined a retry configuration.
ChangeOutboundConnectorCompartmentResponse
Moves a replication and its replication target into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ChangeReplicationCompartmentResponse
Close the client once it is no longer needed
Creates a new export in the specified export set, path, and file system.
This operation does not retry by default if the user has not defined a retry configuration.
CreateExportResponse
Creates a new file system in the specified compartment and availability domain. Instances can mount file systems in another availability domain, but doing so might increase latency when compared to mounting instances in the same availability domain.
After you create a file system, you can associate it with a mount target. Instances can then mount the file system by connecting to the mount target's IP address. You can associate a file system with more than one mount target at a time.
For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
For information about Network Security Groups access control, see [Network Security Groups](https://docs.cloud.oracle.com/Content/Network/Concepts/networksecuritygroups.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure resources, including file systems, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type or by viewing the resource in the Console.
This operation does not retry by default if the user has not defined a retry configuration.
CreateFileSystemResponse
Creates a new file system snapshot policy in the specified compartment and availability domain.
After you create a file system snapshot policy, you can associate it with file systems.
This operation does not retry by default if the user has not defined a retry configuration.
CreateFilesystemSnapshotPolicyResponse
Creates a new mount target in the specified compartment and subnet. You can associate a file system with a mount target only when they exist in the same availability domain. Instances can connect to mount targets in another availablity domain, but you might see higher latency than with instances in the same availability domain as the mount target.
Mount targets have one or more private IP addresses that you can provide as the host portion of remote target parameters in client mount commands. These private IP addresses are listed in the privateIpIds property of the mount target and are highly available. Mount targets also consume additional IP addresses in their subnet. Do not use /30 or smaller subnets for mount target creation because they do not have sufficient available IP addresses. Allow at least three IP addresses for each mount target.
For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure Services resources, including mount targets, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
This operation does not retry by default if the user has not defined a retry configuration.
CreateMountTargetResponse
Creates a new outbound connector in the specified compartment. You can associate an outbound connector with a mount target only when they exist in the same availability domain.
For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure Services resources, including outbound connectors, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
This operation does not retry by default if the user has not defined a retry configuration.
CreateOutboundConnectorResponse
Creates a new replication in the specified compartment.
Replications are the primary resource that governs the policy of cross-region replication between source
and target file systems. Replications are associated with a secondary resource called a ReplicationTarget
located in another availability domain.
The associated replication target resource is automatically created along with the replication resource.
The replication retrieves the delta of data between two snapshots of a source file system
and sends it to the associated ReplicationTarget
, which retrieves the delta and applies it to the target
file system.
Only unexported file systems can be used as target file systems.
For more information, see Using Replication.
For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/Content/General/Concepts/regions.htm). To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure Services resources, including replications, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
This operation does not retry by default if the user has not defined a retry configuration.
CreateReplicationResponse
Creates a new snapshot of the specified file system. You
can access the snapshot at .snapshot/<name>
.
This operation does not retry by default if the user has not defined a retry configuration.
CreateSnapshotResponse
Creates a new FileStorageWaiter for resources for this service.
The waiter configuration for termination and delay strategy
The service waiters.
Deletes the specified export.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteExportResponse
Deletes the specified file system. Before you delete the file system, verify that no remaining export resources still reference it. Deleting a file system also deletes all of its snapshots.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteFileSystemResponse
Deletes the specified file system snapshot policy.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteFilesystemSnapshotPolicyResponse
Deletes the specified mount target. This operation also deletes the mount target's VNICs.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteMountTargetResponse
Deletes the specified outbound connector.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteOutboundConnectorResponse
Deletes the specified replication and the the associated replication target.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteReplicationResponse
Deletes the specified replication target. This operation causes the immediate release of the target file system if there are currently no delta application operations. If there is any current delta being applied the delete operation is blocked until the current delta has been completely applied.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteReplicationTargetResponse
Deletes the specified snapshot.
This operation does not retry by default if the user has not defined a retry configuration.
DeleteSnapshotResponse
Detaches the file system from its parent file system
This operation does not retry by default if the user has not defined a retry configuration.
DetachCloneResponse
Provides estimates for replication created using specific file system.
This operation does not retry by default if the user has not defined a retry configuration.
EstimateReplicationResponse
Gets the specified export's information. This operation does not retry by default if the user has not defined a retry configuration.
GetExportResponse
Gets the specified export set's information. This operation does not retry by default if the user has not defined a retry configuration.
GetExportSetResponse
Gets the specified file system's information. This operation does not retry by default if the user has not defined a retry configuration.
GetFileSystemResponse
Gets the specified file system snapshot policy's information. This operation does not retry by default if the user has not defined a retry configuration.
GetFilesystemSnapshotPolicyResponse
Gets the specified mount target's information. This operation does not retry by default if the user has not defined a retry configuration.
GetMountTargetResponse
Gets the specified outbound connector's information. This operation does not retry by default if the user has not defined a retry configuration.
GetOutboundConnectorResponse
Gets the specified replication's information. This operation does not retry by default if the user has not defined a retry configuration.
GetReplicationResponse
Gets the specified replication target's information. This operation does not retry by default if the user has not defined a retry configuration.
GetReplicationTargetResponse
Gets the specified snapshot's information. This operation does not retry by default if the user has not defined a retry configuration.
GetSnapshotResponse
Gets the waiters available for resources for this service.
The service waiters.
NOTE: This function is deprecated in favor of listExportSetsRecordIterator function. Creates a new async iterator which will iterate over the models.ExportSetSummary objects contained in responses from the listExportSets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listExportSetsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listExportSets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listExportsRecordIterator function. Creates a new async iterator which will iterate over the models.ExportSummary objects contained in responses from the listExports operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listExportsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listExports operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listFileSystemsRecordIterator function. Creates a new async iterator which will iterate over the models.FileSystemSummary objects contained in responses from the listFileSystems operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listFileSystemsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listFileSystems operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listFilesystemSnapshotPoliciesRecordIterator function. Creates a new async iterator which will iterate over the models.FilesystemSnapshotPolicySummary objects contained in responses from the listFilesystemSnapshotPolicies operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listFilesystemSnapshotPoliciesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listFilesystemSnapshotPolicies operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listMountTargetsRecordIterator function. Creates a new async iterator which will iterate over the models.MountTargetSummary objects contained in responses from the listMountTargets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listMountTargetsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listMountTargets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listOutboundConnectorsRecordIterator function. Creates a new async iterator which will iterate over the models.OutboundConnectorSummary objects contained in responses from the listOutboundConnectors operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listOutboundConnectorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listOutboundConnectors operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listReplicationTargetsRecordIterator function. Creates a new async iterator which will iterate over the models.ReplicationTargetSummary objects contained in responses from the listReplicationTargets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listReplicationTargetsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listReplicationTargets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listReplicationsRecordIterator function. Creates a new async iterator which will iterate over the models.ReplicationSummary objects contained in responses from the listReplications operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listReplicationsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listReplications operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listSnapshotsRecordIterator function. Creates a new async iterator which will iterate over the models.SnapshotSummary objects contained in responses from the listSnapshots operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
NOTE: This function is deprecated in favor of listSnapshotsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSnapshots operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists the export set resources in the specified compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ListExportSetsResponse
Creates a new async iterator which will iterate over the models.ExportSetSummary objects contained in responses from the listExportSets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listExportSets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists export resources by compartment, file system, or export set. You must specify an export set ID, a file system ID, and / or a compartment ID.
This operation does not retry by default if the user has not defined a retry configuration.
ListExportsResponse
Creates a new async iterator which will iterate over the models.ExportSummary objects contained in responses from the listExports operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listExports operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.
This operation does not retry by default if the user has not defined a retry configuration.
ListFileSystemsResponse
Creates a new async iterator which will iterate over the models.FileSystemSummary objects contained in responses from the listFileSystems operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listFileSystems operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists file system snapshot policies in the specified compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ListFilesystemSnapshotPoliciesResponse
Creates a new async iterator which will iterate over the models.FilesystemSnapshotPolicySummary objects contained in responses from the listFilesystemSnapshotPolicies operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listFilesystemSnapshotPolicies operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists the mount target resources in the specified compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ListMountTargetsResponse
Creates a new async iterator which will iterate over the models.MountTargetSummary objects contained in responses from the listMountTargets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listMountTargets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists the outbound connector resources in the specified compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ListOutboundConnectorsResponse
Creates a new async iterator which will iterate over the models.OutboundConnectorSummary objects contained in responses from the listOutboundConnectors operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listOutboundConnectors operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists the replication target resources in the specified compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ListReplicationTargetsResponse
Creates a new async iterator which will iterate over the models.ReplicationTargetSummary objects contained in responses from the listReplicationTargets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listReplicationTargets operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists the replication resources in the specified compartment.
This operation does not retry by default if the user has not defined a retry configuration.
ListReplicationsResponse
Creates a new async iterator which will iterate over the models.ReplicationSummary objects contained in responses from the listReplications operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listReplications operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Lists snapshots of the specified file system, or by file system snapshot policy and compartment, or by file system snapshot policy and file system.
If file system ID is not specified, a file system snapshot policy ID and compartment ID must be specified.
Users can only sort by time created when listing snapshots by file system snapshot policy ID and compartment ID (sort by name is NOT supported for listing snapshots by policy and compartment).
This operation does not retry by default if the user has not defined a retry configuration.
ListSnapshotsResponse
Creates a new async iterator which will iterate over the models.SnapshotSummary objects contained in responses from the listSnapshots operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
Creates a new async iterator which will iterate over the responses received from the listSnapshots operation. This iterator will fetch more data from the server as needed.
a request which can be sent to the service operation
This operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system snapshot policy from ACTIVE to INACTIVE. When a file system snapshot policy is paused, file systems that are associated with the policy will not have scheduled snapshots created or deleted.
If the policy is already paused, or in the INACTIVE state, you cannot pause it again. You can't pause a policy that is in a DELETING, DELETED, FAILED, CREATING or INACTIVE state; attempts to pause a policy in these states result in a 409 conflict error.
This operation does not retry by default if the user has not defined a retry configuration.
PauseFilesystemSnapshotPolicyResponse
Schedule a downgrade shape of the mount target.
This operation does not retry by default if the user has not defined a retry configuration.
ScheduleDowngradeShapeMountTargetResponse
Shutdown the circuit breaker used by the client when it is no longer needed
This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE. By default, file system snapshot policies are in the ACTIVE state. When a file system snapshot policy is not paused, or in the ACTIVE state, file systems that are associated with the policy will have snapshots created and deleted according to the schedules defined in the policy.
If the policy is already in the ACTIVE state, you cannot unpause it. You can't unpause a policy that is in a DELETING, DELETED, FAILED, CREATING, or ACTIVE state; attempts to unpause a policy in these states result in a 409 conflict error.
This operation does not retry by default if the user has not defined a retry configuration.
UnpauseFilesystemSnapshotPolicyResponse
Updates the specified export's information. This operation does not retry by default if the user has not defined a retry configuration.
UpdateExportResponse
Updates the specified export set's information. This operation does not retry by default if the user has not defined a retry configuration.
UpdateExportSetResponse
Updates the specified file system's information. You can use this operation to rename a file system.
This operation does not retry by default if the user has not defined a retry configuration.
UpdateFileSystemResponse
Updates the specified file system snapshot policy's information. This operation does not retry by default if the user has not defined a retry configuration.
UpdateFilesystemSnapshotPolicyResponse
Updates the specified mount target's information. This operation does not retry by default if the user has not defined a retry configuration.
UpdateMountTargetResponse
Updates the specified outbound connector's information. This operation does not retry by default if the user has not defined a retry configuration.
UpdateOutboundConnectorResponse
Updates the information for the specified replication and its associated replication target.
This operation does not retry by default if the user has not defined a retry configuration.
UpdateReplicationResponse
Updates the specified snapshot's information. This operation does not retry by default if the user has not defined a retry configuration.
UpdateSnapshotResponse
Upgrade shape request for mount target.
This operation does not retry by default if the user has not defined a retry configuration.
UpgradeShapeMountTargetResponse
Validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request. The keytabs are deserialized, the contents are validated for compatibility and the principal, key version number and encryption type of each entry is provided as part of the response.
This operation does not retry by default if the user has not defined a retry configuration.
ValidateKeyTabsResponse
This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.