@Generated(value="OracleSDKGenerator", comments="API Version: 20171215") public class FileStorageClient extends Object implements FileStorage
Modifier and Type | Class and Description |
---|---|
static class |
FileStorageClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for FileStorage.
|
Modifier | Constructor and Description |
---|---|
|
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
FileStorageClient(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.
|
|
FileStorageClient(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.
|
|
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static FileStorageClient.Builder |
builder()
Create a builder for this client.
|
ChangeFileSystemCompartmentResponse |
changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request)
Moves a file system and its associated snapshots into a different compartment within the same tenancy.
|
ChangeMountTargetCompartmentResponse |
changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request)
Moves a mount target and its associated export set 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.
|
CreateMountTargetResponse |
createMountTarget(CreateMountTargetRequest request)
Creates a new mount target in the specified compartment and
subnet.
|
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.
|
DeleteMountTargetResponse |
deleteMountTarget(DeleteMountTargetRequest request)
Deletes the specified mount target.
|
DeleteSnapshotResponse |
deleteSnapshot(DeleteSnapshotRequest request)
Deletes the specified snapshot.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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.
|
GetMountTargetResponse |
getMountTarget(GetMountTargetRequest request)
Gets the specified mount target’s information.
|
FileStoragePaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
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.
|
ListMountTargetsResponse |
listMountTargets(ListMountTargetsRequest request)
Lists the mount target resources in the specified compartment.
|
ListSnapshotsResponse |
listSnapshots(ListSnapshotsRequest request)
Lists snapshots of the specified file system.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
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’).
|
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.
|
UpdateMountTargetResponse |
updateMountTarget(UpdateMountTargetRequest request)
Updates the specified mount target’s information.
|
UpdateSnapshotResponse |
updateSnapshot(UpdateSnapshotRequest request)
Updates the specified snapshot’s information.
|
public static final Service SERVICE
Service instance for FileStorage.
public FileStorageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public FileStorageClient(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 FileStorageClient(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 FileStorageClient(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 FileStorageClient(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 FileStorageClient(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 FileStorageClient(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 FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
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
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected FileStorageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, 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.
Use the FileStorageClient.Builder
to get access to all these parameters.
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
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static FileStorageClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
FileStorage
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface FileStorage
endpoint
- The endpoint of the service.public String getEndpoint()
FileStorage
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface FileStorage
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 void close()
close
in interface AutoCloseable
public 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 ChangeMountTargetCompartmentResponse changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request)
FileStorage
Moves 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 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 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 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 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 DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest request)
FileStorage
Deletes the specified snapshot.
deleteSnapshot
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 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 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.
listFileSystems
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 ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)
FileStorage
Lists snapshots of the specified file system.
listSnapshots
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 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 UpdateSnapshotResponse updateSnapshot(UpdateSnapshotRequest request)
FileStorage
Updates the specified snapshot’s information.
updateSnapshot
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
Copyright © 2016–2022. All rights reserved.