@Generated(value="OracleSDKGenerator", comments="API Version: 20171215") public class FileStorageClient extends BaseSyncClient implements FileStorage
Modifier and Type | Class and Description |
---|---|
static class |
FileStorageClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for FileStorage.
|
Constructor and Description |
---|
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
Modifier and Type | Method and Description |
---|---|
static FileStorageClient.Builder |
builder()
Create a builder for this client.
|
CancelDowngradeShapeMountTargetResponse |
cancelDowngradeShapeMountTarget(CancelDowngradeShapeMountTargetRequest request)
Cancel scheduled downgrade shape request for mount target.
|
ChangeFileSystemCompartmentResponse |
changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request)
Moves a file system and its associated snapshots into a different compartment within the same
tenancy.
|
ChangeFilesystemSnapshotPolicyCompartmentResponse |
changeFilesystemSnapshotPolicyCompartment(ChangeFilesystemSnapshotPolicyCompartmentRequest request)
Moves a file system snapshot policy into a different compartment within the same tenancy.
|
ChangeMountTargetCompartmentResponse |
changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request)
Moves a mount target and its associated export set or share set into a different compartment
within the same tenancy.
|
ChangeOutboundConnectorCompartmentResponse |
changeOutboundConnectorCompartment(ChangeOutboundConnectorCompartmentRequest request)
Moves an outbound connector into a different compartment within the same tenancy.
|
ChangeReplicationCompartmentResponse |
changeReplicationCompartment(ChangeReplicationCompartmentRequest request)
Moves a replication and its replication target into a different compartment within the same
tenancy.
|
void |
close() |
CreateExportResponse |
createExport(CreateExportRequest request)
Creates a new export in the specified export set, path, and file system.
|
CreateFileSystemResponse |
createFileSystem(CreateFileSystemRequest request)
Creates a new file system in the specified compartment and availability domain.
|
CreateFilesystemSnapshotPolicyResponse |
createFilesystemSnapshotPolicy(CreateFilesystemSnapshotPolicyRequest request)
Creates a new file system snapshot policy in the specified compartment and availability
domain.
|
CreateMountTargetResponse |
createMountTarget(CreateMountTargetRequest request)
Creates a new mount target in the specified compartment and subnet.
|
CreateOutboundConnectorResponse |
createOutboundConnector(CreateOutboundConnectorRequest request)
Creates a new outbound connector in the specified compartment.
|
CreateReplicationResponse |
createReplication(CreateReplicationRequest request)
Creates a new replication in the specified compartment.
|
CreateSnapshotResponse |
createSnapshot(CreateSnapshotRequest request)
Creates a new snapshot of the specified file system.
|
DeleteExportResponse |
deleteExport(DeleteExportRequest request)
Deletes the specified export.
|
DeleteFileSystemResponse |
deleteFileSystem(DeleteFileSystemRequest request)
Deletes the specified file system.
|
DeleteFilesystemSnapshotPolicyResponse |
deleteFilesystemSnapshotPolicy(DeleteFilesystemSnapshotPolicyRequest request)
Deletes the specified file system snapshot policy.
|
DeleteMountTargetResponse |
deleteMountTarget(DeleteMountTargetRequest request)
Deletes the specified mount target.
|
DeleteOutboundConnectorResponse |
deleteOutboundConnector(DeleteOutboundConnectorRequest request)
Deletes the specified outbound connector.
|
DeleteReplicationResponse |
deleteReplication(DeleteReplicationRequest request)
Deletes the specified replication and the the associated replication target.
|
DeleteReplicationTargetResponse |
deleteReplicationTarget(DeleteReplicationTargetRequest request)
Deletes the specified replication target.
|
DeleteSnapshotResponse |
deleteSnapshot(DeleteSnapshotRequest request)
Deletes the specified snapshot.
|
DetachCloneResponse |
detachClone(DetachCloneRequest request)
Detaches the file system from its parent file system
|
EstimateReplicationResponse |
estimateReplication(EstimateReplicationRequest request)
Provides estimates for replication created using specific file system.
|
String |
getClientCommonLibraryVersion() |
protected ClientConfigurator |
getDefaultConfigurator() |
String |
getEndpoint() |
GetExportResponse |
getExport(GetExportRequest request)
Gets the specified export’s information.
|
GetExportSetResponse |
getExportSet(GetExportSetRequest request)
Gets the specified export set’s information.
|
GetFileSystemResponse |
getFileSystem(GetFileSystemRequest request)
Gets the specified file system’s information.
|
GetFilesystemSnapshotPolicyResponse |
getFilesystemSnapshotPolicy(GetFilesystemSnapshotPolicyRequest request)
Gets the specified file system snapshot policy’s information.
|
Optional<String> |
getMinimumClientCommonLibraryVersionFromClient() |
GetMountTargetResponse |
getMountTarget(GetMountTargetRequest request)
Gets the specified mount target’s information.
|
GetOutboundConnectorResponse |
getOutboundConnector(GetOutboundConnectorRequest request)
Gets the specified outbound connector’s information.
|
FileStoragePaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetReplicationResponse |
getReplication(GetReplicationRequest request)
Gets the specified replication’s information.
|
GetReplicationTargetResponse |
getReplicationTarget(GetReplicationTargetRequest request)
Gets the specified replication target’s information.
|
GetSnapshotResponse |
getSnapshot(GetSnapshotRequest request)
Gets the specified snapshot’s information.
|
FileStorageWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListExportsResponse |
listExports(ListExportsRequest request)
Lists export resources by compartment, file system, or export set.
|
ListExportSetsResponse |
listExportSets(ListExportSetsRequest request)
Lists the export set resources in the specified compartment.
|
ListFileSystemsResponse |
listFileSystems(ListFileSystemsRequest request)
Lists the file system resources in the specified compartment, or by the specified compartment
and file system snapshot policy.
|
ListFilesystemSnapshotPoliciesResponse |
listFilesystemSnapshotPolicies(ListFilesystemSnapshotPoliciesRequest request)
Lists file system snapshot policies in the specified compartment.
|
ListMountTargetsResponse |
listMountTargets(ListMountTargetsRequest request)
Lists the mount target resources in the specified compartment.
|
ListOutboundConnectorsResponse |
listOutboundConnectors(ListOutboundConnectorsRequest request)
Lists the outbound connector resources in the specified compartment.
|
ListReplicationsResponse |
listReplications(ListReplicationsRequest request)
Lists the replication resources in the specified compartment.
|
ListReplicationTargetsResponse |
listReplicationTargets(ListReplicationTargetsRequest request)
Lists the replication target resources in the specified compartment.
|
ListSnapshotsResponse |
listSnapshots(ListSnapshotsRequest request)
Lists snapshots of the specified file system, or by file system snapshot policy and
compartment, or by file system snapshot policy and file system.
|
PauseFilesystemSnapshotPolicyResponse |
pauseFilesystemSnapshotPolicy(PauseFilesystemSnapshotPolicyRequest request)
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.
|
void |
populateServiceParametersInEndpoint(String endpoint,
Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base
endpoint.
|
void |
refreshClient()
Rebuild the backing
HttpClient . |
ScheduleDowngradeShapeMountTargetResponse |
scheduleDowngradeShapeMountTarget(ScheduleDowngradeShapeMountTargetRequest request)
Schedule a downgrade shape of the mount target.
|
void |
setEndpoint(String endpoint) |
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UnpauseFilesystemSnapshotPolicyResponse |
unpauseFilesystemSnapshotPolicy(UnpauseFilesystemSnapshotPolicyRequest request)
This operation unpauses a paused file system snapshot policy and updates the lifecycle state
of the file system snapshot policy from INACTIVE to ACTIVE.
|
void |
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.
|
UpdateExportResponse |
updateExport(UpdateExportRequest request)
Updates the specified export’s information.
|
UpdateExportSetResponse |
updateExportSet(UpdateExportSetRequest request)
Updates the specified export set’s information.
|
UpdateFileSystemResponse |
updateFileSystem(UpdateFileSystemRequest request)
Updates the specified file system’s information.
|
UpdateFilesystemSnapshotPolicyResponse |
updateFilesystemSnapshotPolicy(UpdateFilesystemSnapshotPolicyRequest request)
Updates the specified file system snapshot policy’s information.
|
UpdateMountTargetResponse |
updateMountTarget(UpdateMountTargetRequest request)
Updates the specified mount target’s information.
|
UpdateOutboundConnectorResponse |
updateOutboundConnector(UpdateOutboundConnectorRequest request)
Updates the specified outbound connector’s information.
|
UpdateReplicationResponse |
updateReplication(UpdateReplicationRequest request)
Updates the information for the specified replication and its associated replication target.
|
UpdateSnapshotResponse |
updateSnapshot(UpdateSnapshotRequest request)
Updates the specified snapshot’s information.
|
UpgradeShapeMountTargetResponse |
upgradeShapeMountTarget(UpgradeShapeMountTargetRequest request)
Upgrade shape request for mount target.
|
void |
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.
|
ValidateKeyTabsResponse |
validateKeyTabs(ValidateKeyTabsRequest request)
Validates keytab contents for the secret details passed on the request or validte keytab
contents associated with the mount target passed in the request.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for FileStorage.
public final String clientCommonLibraryVersion
@Deprecated public FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see FileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see FileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see FileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see FileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see FileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see FileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see FileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
@Deprecated public FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see FileStorageClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
- FileStorageClient.Builder.executorService
public static FileStorageClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
FileStorage
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this Region, however, an
IllegalArgumentException will be raised.
setRegion
in interface FileStorage
region
- The region of the service.public void setRegion(String regionId)
FileStorage
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
setRegion
in interface FileStorage
regionId
- The public region ID.public CancelDowngradeShapeMountTargetResponse cancelDowngradeShapeMountTarget(CancelDowngradeShapeMountTargetRequest request)
FileStorage
Cancel scheduled downgrade shape request for mount target.
cancelDowngradeShapeMountTarget
in interface FileStorage
request
- The request object containing the details to sendpublic ChangeFileSystemCompartmentResponse changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request)
FileStorage
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
changeFileSystemCompartment
in interface FileStorage
request
- The request object containing the details to sendpublic ChangeFilesystemSnapshotPolicyCompartmentResponse changeFilesystemSnapshotPolicyCompartment(ChangeFilesystemSnapshotPolicyCompartmentRequest request)
FileStorage
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.
changeFilesystemSnapshotPolicyCompartment
in interface FileStorage
request
- The request object containing the details to sendpublic ChangeMountTargetCompartmentResponse changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request)
FileStorage
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
changeMountTargetCompartment
in interface FileStorage
request
- The request object containing the details to sendpublic ChangeOutboundConnectorCompartmentResponse changeOutboundConnectorCompartment(ChangeOutboundConnectorCompartmentRequest request)
FileStorage
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
changeOutboundConnectorCompartment
in interface FileStorage
request
- The request object containing the details to sendpublic ChangeReplicationCompartmentResponse changeReplicationCompartment(ChangeReplicationCompartmentRequest request)
FileStorage
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.
changeReplicationCompartment
in interface FileStorage
request
- The request object containing the details to sendpublic CreateExportResponse createExport(CreateExportRequest request)
FileStorage
Creates a new export in the specified export set, path, and file system.
createExport
in interface FileStorage
request
- The request object containing the details to sendpublic CreateFileSystemResponse createFileSystem(CreateFileSystemRequest request)
FileStorage
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.
createFileSystem
in interface FileStorage
request
- The request object containing the details to sendpublic CreateFilesystemSnapshotPolicyResponse createFilesystemSnapshotPolicy(CreateFilesystemSnapshotPolicyRequest request)
FileStorage
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.
createFilesystemSnapshotPolicy
in interface FileStorage
request
- The request object containing the details to sendpublic CreateMountTargetResponse createMountTarget(CreateMountTargetRequest request)
FileStorage
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.
createMountTarget
in interface FileStorage
request
- The request object containing the details to sendpublic CreateOutboundConnectorResponse createOutboundConnector(CreateOutboundConnectorRequest request)
FileStorage
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.
createOutboundConnector
in interface FileStorage
request
- The request object containing the details to sendpublic CreateReplicationResponse createReplication(CreateReplicationRequest request)
FileStorage
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.
createReplication
in interface FileStorage
request
- The request object containing the details to sendpublic CreateSnapshotResponse createSnapshot(CreateSnapshotRequest request)
FileStorage
Creates a new snapshot of the specified file system. You can access the snapshot at
.snapshot/<name>
.
createSnapshot
in interface FileStorage
request
- The request object containing the details to sendpublic DeleteExportResponse deleteExport(DeleteExportRequest request)
FileStorage
Deletes the specified export.
deleteExport
in interface FileStorage
request
- The request object containing the details to sendpublic DeleteFileSystemResponse deleteFileSystem(DeleteFileSystemRequest request)
FileStorage
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.
deleteFileSystem
in interface FileStorage
request
- The request object containing the details to sendpublic DeleteFilesystemSnapshotPolicyResponse deleteFilesystemSnapshotPolicy(DeleteFilesystemSnapshotPolicyRequest request)
FileStorage
Deletes the specified file system snapshot policy.
deleteFilesystemSnapshotPolicy
in interface FileStorage
request
- The request object containing the details to sendpublic DeleteMountTargetResponse deleteMountTarget(DeleteMountTargetRequest request)
FileStorage
Deletes the specified mount target. This operation also deletes the mount target’s VNICs.
deleteMountTarget
in interface FileStorage
request
- The request object containing the details to sendpublic DeleteOutboundConnectorResponse deleteOutboundConnector(DeleteOutboundConnectorRequest request)
FileStorage
Deletes the specified outbound connector.
deleteOutboundConnector
in interface FileStorage
request
- The request object containing the details to sendpublic DeleteReplicationResponse deleteReplication(DeleteReplicationRequest request)
FileStorage
Deletes the specified replication and the the associated replication target.
deleteReplication
in interface FileStorage
request
- The request object containing the details to sendpublic DeleteReplicationTargetResponse deleteReplicationTarget(DeleteReplicationTargetRequest request)
FileStorage
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.
deleteReplicationTarget
in interface FileStorage
request
- The request object containing the details to sendpublic DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest request)
FileStorage
Deletes the specified snapshot.
deleteSnapshot
in interface FileStorage
request
- The request object containing the details to sendpublic DetachCloneResponse detachClone(DetachCloneRequest request)
FileStorage
Detaches the file system from its parent file system
detachClone
in interface FileStorage
request
- The request object containing the details to sendpublic EstimateReplicationResponse estimateReplication(EstimateReplicationRequest request)
FileStorage
Provides estimates for replication created using specific file system.
estimateReplication
in interface FileStorage
request
- The request object containing the details to sendpublic GetExportResponse getExport(GetExportRequest request)
FileStorage
Gets the specified export’s information.
getExport
in interface FileStorage
request
- The request object containing the details to sendpublic GetExportSetResponse getExportSet(GetExportSetRequest request)
FileStorage
Gets the specified export set’s information.
getExportSet
in interface FileStorage
request
- The request object containing the details to sendpublic GetFileSystemResponse getFileSystem(GetFileSystemRequest request)
FileStorage
Gets the specified file system’s information.
getFileSystem
in interface FileStorage
request
- The request object containing the details to sendpublic GetFilesystemSnapshotPolicyResponse getFilesystemSnapshotPolicy(GetFilesystemSnapshotPolicyRequest request)
FileStorage
Gets the specified file system snapshot policy’s information.
getFilesystemSnapshotPolicy
in interface FileStorage
request
- The request object containing the details to sendpublic GetMountTargetResponse getMountTarget(GetMountTargetRequest request)
FileStorage
Gets the specified mount target’s information.
getMountTarget
in interface FileStorage
request
- The request object containing the details to sendpublic GetOutboundConnectorResponse getOutboundConnector(GetOutboundConnectorRequest request)
FileStorage
Gets the specified outbound connector’s information.
getOutboundConnector
in interface FileStorage
request
- The request object containing the details to sendpublic GetReplicationResponse getReplication(GetReplicationRequest request)
FileStorage
Gets the specified replication’s information.
getReplication
in interface FileStorage
request
- The request object containing the details to sendpublic GetReplicationTargetResponse getReplicationTarget(GetReplicationTargetRequest request)
FileStorage
Gets the specified replication target’s information.
getReplicationTarget
in interface FileStorage
request
- The request object containing the details to sendpublic GetSnapshotResponse getSnapshot(GetSnapshotRequest request)
FileStorage
Gets the specified snapshot’s information.
getSnapshot
in interface FileStorage
request
- The request object containing the details to sendpublic ListExportSetsResponse listExportSets(ListExportSetsRequest request)
FileStorage
Lists the export set resources in the specified compartment.
listExportSets
in interface FileStorage
request
- The request object containing the details to sendpublic ListExportsResponse listExports(ListExportsRequest request)
FileStorage
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.
listExports
in interface FileStorage
request
- The request object containing the details to sendpublic ListFileSystemsResponse listFileSystems(ListFileSystemsRequest request)
FileStorage
Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.
listFileSystems
in interface FileStorage
request
- The request object containing the details to sendpublic ListFilesystemSnapshotPoliciesResponse listFilesystemSnapshotPolicies(ListFilesystemSnapshotPoliciesRequest request)
FileStorage
Lists file system snapshot policies in the specified compartment.
listFilesystemSnapshotPolicies
in interface FileStorage
request
- The request object containing the details to sendpublic ListMountTargetsResponse listMountTargets(ListMountTargetsRequest request)
FileStorage
Lists the mount target resources in the specified compartment.
listMountTargets
in interface FileStorage
request
- The request object containing the details to sendpublic ListOutboundConnectorsResponse listOutboundConnectors(ListOutboundConnectorsRequest request)
FileStorage
Lists the outbound connector resources in the specified compartment.
listOutboundConnectors
in interface FileStorage
request
- The request object containing the details to sendpublic ListReplicationTargetsResponse listReplicationTargets(ListReplicationTargetsRequest request)
FileStorage
Lists the replication target resources in the specified compartment.
listReplicationTargets
in interface FileStorage
request
- The request object containing the details to sendpublic ListReplicationsResponse listReplications(ListReplicationsRequest request)
FileStorage
Lists the replication resources in the specified compartment.
listReplications
in interface FileStorage
request
- The request object containing the details to sendpublic ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)
FileStorage
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).
listSnapshots
in interface FileStorage
request
- The request object containing the details to sendpublic PauseFilesystemSnapshotPolicyResponse pauseFilesystemSnapshotPolicy(PauseFilesystemSnapshotPolicyRequest request)
FileStorage
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.
pauseFilesystemSnapshotPolicy
in interface FileStorage
request
- The request object containing the details to sendpublic ScheduleDowngradeShapeMountTargetResponse scheduleDowngradeShapeMountTarget(ScheduleDowngradeShapeMountTargetRequest request)
FileStorage
Schedule a downgrade shape of the mount target.
scheduleDowngradeShapeMountTarget
in interface FileStorage
request
- The request object containing the details to sendpublic UnpauseFilesystemSnapshotPolicyResponse unpauseFilesystemSnapshotPolicy(UnpauseFilesystemSnapshotPolicyRequest request)
FileStorage
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.
unpauseFilesystemSnapshotPolicy
in interface FileStorage
request
- The request object containing the details to sendpublic UpdateExportResponse updateExport(UpdateExportRequest request)
FileStorage
Updates the specified export’s information.
updateExport
in interface FileStorage
request
- The request object containing the details to sendpublic UpdateExportSetResponse updateExportSet(UpdateExportSetRequest request)
FileStorage
Updates the specified export set’s information.
updateExportSet
in interface FileStorage
request
- The request object containing the details to sendpublic UpdateFileSystemResponse updateFileSystem(UpdateFileSystemRequest request)
FileStorage
Updates the specified file system’s information. You can use this operation to rename a file system.
updateFileSystem
in interface FileStorage
request
- The request object containing the details to sendpublic UpdateFilesystemSnapshotPolicyResponse updateFilesystemSnapshotPolicy(UpdateFilesystemSnapshotPolicyRequest request)
FileStorage
Updates the specified file system snapshot policy’s information.
updateFilesystemSnapshotPolicy
in interface FileStorage
request
- The request object containing the details to sendpublic UpdateMountTargetResponse updateMountTarget(UpdateMountTargetRequest request)
FileStorage
Updates the specified mount target’s information.
updateMountTarget
in interface FileStorage
request
- The request object containing the details to sendpublic UpdateOutboundConnectorResponse updateOutboundConnector(UpdateOutboundConnectorRequest request)
FileStorage
Updates the specified outbound connector’s information.
updateOutboundConnector
in interface FileStorage
request
- The request object containing the details to sendpublic UpdateReplicationResponse updateReplication(UpdateReplicationRequest request)
FileStorage
Updates the information for the specified replication and its associated replication target.
updateReplication
in interface FileStorage
request
- The request object containing the details to sendpublic UpdateSnapshotResponse updateSnapshot(UpdateSnapshotRequest request)
FileStorage
Updates the specified snapshot’s information.
updateSnapshot
in interface FileStorage
request
- The request object containing the details to sendpublic UpgradeShapeMountTargetResponse upgradeShapeMountTarget(UpgradeShapeMountTargetRequest request)
FileStorage
Upgrade shape request for mount target.
upgradeShapeMountTarget
in interface FileStorage
request
- The request object containing the details to sendpublic ValidateKeyTabsResponse validateKeyTabs(ValidateKeyTabsRequest request)
FileStorage
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.
validateKeyTabs
in interface FileStorage
request
- The request object containing the details to sendpublic FileStorageWaiters getWaiters()
FileStorage
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface FileStorage
public FileStoragePaginators getPaginators()
FileStorage
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
getPaginators
in interface FileStorage
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.