@Generated(value="OracleSDKGenerator", comments="API Version: 20171215") public class FileStorageAsyncClient extends Object implements FileStorageAsync
Async client implementation for FileStorage service.
There are two ways to use async client:
InputStream, like
getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else,
because the stream will be closed right after the AsyncHandler is invoked. | Modifier and Type | Class and Description |
|---|---|
static class |
FileStorageAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for FileStorage.
|
| Constructor and Description |
|---|
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for FileStorage.
public FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public FileStorageAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public FileStorageAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)restClientFactoryBuilder - the builder for the RestClientFactorypublic static FileStorageAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
FileStorageAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface FileStorageAsyncendpoint - The endpoint of the serice.public String getEndpoint()
FileStorageAsyncGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface FileStorageAsyncpublic void setRegion(Region region)
FileStorageAsyncSets 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 FileStorageAsyncregion - The region of the service.public void setRegion(String regionId)
FileStorageAsyncSets 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 FileStorageAsyncregionId - The public region ID.public void close()
close in interface AutoCloseablepublic Future<ChangeFileSystemCompartmentResponse> changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request, AsyncHandler<ChangeFileSystemCompartmentRequest,ChangeFileSystemCompartmentResponse> handler)
FileStorageAsyncMoves 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 FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ChangeMountTargetCompartmentResponse> changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request, AsyncHandler<ChangeMountTargetCompartmentRequest,ChangeMountTargetCompartmentResponse> handler)
FileStorageAsyncMoves a mount target and its associated export 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 FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateExportResponse> createExport(CreateExportRequest request, AsyncHandler<CreateExportRequest,CreateExportResponse> handler)
FileStorageAsyncCreates a new export in the specified export set, path, and file system.
createExport in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateFileSystemResponse> createFileSystem(CreateFileSystemRequest request, AsyncHandler<CreateFileSystemRequest,CreateFileSystemResponse> handler)
FileStorageAsyncCreates 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 FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateMountTargetResponse> createMountTarget(CreateMountTargetRequest request, AsyncHandler<CreateMountTargetRequest,CreateMountTargetResponse> handler)
FileStorageAsyncCreates 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 FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateSnapshotResponse> createSnapshot(CreateSnapshotRequest request, AsyncHandler<CreateSnapshotRequest,CreateSnapshotResponse> handler)
FileStorageAsyncCreates a new snapshot of the specified file system. You
can access the snapshot at .snapshot/<name>.
createSnapshot in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteExportResponse> deleteExport(DeleteExportRequest request, AsyncHandler<DeleteExportRequest,DeleteExportResponse> handler)
FileStorageAsyncDeletes the specified export.
deleteExport in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteFileSystemResponse> deleteFileSystem(DeleteFileSystemRequest request, AsyncHandler<DeleteFileSystemRequest,DeleteFileSystemResponse> handler)
FileStorageAsyncDeletes 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 FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteMountTargetResponse> deleteMountTarget(DeleteMountTargetRequest request, AsyncHandler<DeleteMountTargetRequest,DeleteMountTargetResponse> handler)
FileStorageAsyncDeletes the specified mount target. This operation also deletes the mount target’s VNICs.
deleteMountTarget in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteSnapshotResponse> deleteSnapshot(DeleteSnapshotRequest request, AsyncHandler<DeleteSnapshotRequest,DeleteSnapshotResponse> handler)
FileStorageAsyncDeletes the specified snapshot.
deleteSnapshot in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetExportResponse> getExport(GetExportRequest request, AsyncHandler<GetExportRequest,GetExportResponse> handler)
FileStorageAsyncGets the specified export’s information.
getExport in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetExportSetResponse> getExportSet(GetExportSetRequest request, AsyncHandler<GetExportSetRequest,GetExportSetResponse> handler)
FileStorageAsyncGets the specified export set’s information.
getExportSet in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetFileSystemResponse> getFileSystem(GetFileSystemRequest request, AsyncHandler<GetFileSystemRequest,GetFileSystemResponse> handler)
FileStorageAsyncGets the specified file system’s information.
getFileSystem in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetMountTargetResponse> getMountTarget(GetMountTargetRequest request, AsyncHandler<GetMountTargetRequest,GetMountTargetResponse> handler)
FileStorageAsyncGets the specified mount target’s information.
getMountTarget in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetSnapshotResponse> getSnapshot(GetSnapshotRequest request, AsyncHandler<GetSnapshotRequest,GetSnapshotResponse> handler)
FileStorageAsyncGets the specified snapshot’s information.
getSnapshot in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListExportSetsResponse> listExportSets(ListExportSetsRequest request, AsyncHandler<ListExportSetsRequest,ListExportSetsResponse> handler)
FileStorageAsyncLists the export set resources in the specified compartment.
listExportSets in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListExportsResponse> listExports(ListExportsRequest request, AsyncHandler<ListExportsRequest,ListExportsResponse> handler)
FileStorageAsyncLists 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 FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListFileSystemsResponse> listFileSystems(ListFileSystemsRequest request, AsyncHandler<ListFileSystemsRequest,ListFileSystemsResponse> handler)
FileStorageAsyncLists the file system resources in the specified compartment.
listFileSystems in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListMountTargetsResponse> listMountTargets(ListMountTargetsRequest request, AsyncHandler<ListMountTargetsRequest,ListMountTargetsResponse> handler)
FileStorageAsyncLists the mount target resources in the specified compartment.
listMountTargets in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListSnapshotsResponse> listSnapshots(ListSnapshotsRequest request, AsyncHandler<ListSnapshotsRequest,ListSnapshotsResponse> handler)
FileStorageAsyncLists snapshots of the specified file system.
listSnapshots in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateExportResponse> updateExport(UpdateExportRequest request, AsyncHandler<UpdateExportRequest,UpdateExportResponse> handler)
FileStorageAsyncUpdates the specified export’s information.
updateExport in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateExportSetResponse> updateExportSet(UpdateExportSetRequest request, AsyncHandler<UpdateExportSetRequest,UpdateExportSetResponse> handler)
FileStorageAsyncUpdates the specified export set’s information.
updateExportSet in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateFileSystemResponse> updateFileSystem(UpdateFileSystemRequest request, AsyncHandler<UpdateFileSystemRequest,UpdateFileSystemResponse> handler)
FileStorageAsyncUpdates the specified file system’s information. You can use this operation to rename a file system.
updateFileSystem in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateMountTargetResponse> updateMountTarget(UpdateMountTargetRequest request, AsyncHandler<UpdateMountTargetRequest,UpdateMountTargetResponse> handler)
FileStorageAsyncUpdates the specified mount target’s information.
updateMountTarget in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateSnapshotResponse> updateSnapshot(UpdateSnapshotRequest request, AsyncHandler<UpdateSnapshotRequest,UpdateSnapshotResponse> handler)
FileStorageAsyncUpdates the specified snapshot’s information.
updateSnapshot in interface FileStorageAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.