@Generated(value="OracleSDKGenerator", comments="API Version: 20171215") public interface FileStorage extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
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.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.void setRegion(Region region)
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.
region
- The region of the service.void setRegion(String regionId)
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
.
regionId
- The public region ID.ChangeFileSystemCompartmentResponse changeFileSystemCompartment(ChangeFileSystemCompartmentRequest request)
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
request
- The request object containing the details to sendBmcException
- when an error occurs.ChangeMountTargetCompartmentResponse changeMountTargetCompartment(ChangeMountTargetCompartmentRequest request)
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
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateExportResponse createExport(CreateExportRequest request)
Creates a new export in the specified export set, path, and file system.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateFileSystemResponse createFileSystem(CreateFileSystemRequest request)
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.
For information about availability domains, see Regions and Availability Domains. 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). 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.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateMountTargetResponse createMountTarget(CreateMountTargetRequest request)
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.
For information about availability domains, see Regions and Availability Domains. 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). 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.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateSnapshotResponse createSnapshot(CreateSnapshotRequest request)
Creates a new snapshot of the specified file system. You can access the snapshot at .snapshot/<name>
.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteExportResponse deleteExport(DeleteExportRequest request)
Deletes the specified export.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteFileSystemResponse deleteFileSystem(DeleteFileSystemRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteMountTargetResponse deleteMountTarget(DeleteMountTargetRequest request)
Deletes the specified mount target. This operation also deletes the mount target’s VNICs.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest request)
Deletes the specified snapshot.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetExportResponse getExport(GetExportRequest request)
Gets the specified export’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetExportSetResponse getExportSet(GetExportSetRequest request)
Gets the specified export set’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetFileSystemResponse getFileSystem(GetFileSystemRequest request)
Gets the specified file system’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetMountTargetResponse getMountTarget(GetMountTargetRequest request)
Gets the specified mount target’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetSnapshotResponse getSnapshot(GetSnapshotRequest request)
Gets the specified snapshot’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListExportSetsResponse listExportSets(ListExportSetsRequest request)
Lists the export set resources in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListExportsResponse listExports(ListExportsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListFileSystemsResponse listFileSystems(ListFileSystemsRequest request)
Lists the file system resources in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListMountTargetsResponse listMountTargets(ListMountTargetsRequest request)
Lists the mount target resources in the specified compartment.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)
Lists snapshots of the specified file system.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateExportResponse updateExport(UpdateExportRequest request)
Updates the specified export’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateExportSetResponse updateExportSet(UpdateExportSetRequest request)
Updates the specified export set’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateFileSystemResponse updateFileSystem(UpdateFileSystemRequest request)
Updates the specified file system’s information. You can use this operation to rename a file system.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateMountTargetResponse updateMountTarget(UpdateMountTargetRequest request)
Updates the specified mount target’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateSnapshotResponse updateSnapshot(UpdateSnapshotRequest request)
Updates the specified snapshot’s information.
request
- The request object containing the details to sendBmcException
- when an error occurs.FileStorageWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
FileStoragePaginators getPaginators()
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.
Copyright © 2016–2019. All rights reserved.