com.oracle.bmc.filestorage.requests

Class ListFileSystemsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.filestorage.requests.ListFileSystemsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public class ListFileSystemsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListFileSystemsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListFileSystemsRequest.Builder
static class	ListFileSystemsRequest.LifecycleState Filter results by the specified lifecycle state.
static class	ListFileSystemsRequest.SortBy The field to sort by.
static class	ListFileSystemsRequest.SortOrder The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.

Constructor Summary

Constructors

Constructor and Description
ListFileSystemsRequest()

Method Summary

Modifier and Type	Method and Description
static ListFileSystemsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getAvailabilityDomain() The name of the availability domain.
String	getCompartmentId() The OCID of the compartment.
String	getDisplayName() A user-friendly name.
String	getFilesystemSnapshotPolicyId() The OCID of the file system snapshot policy that is associated with the file systems.
String	getId() Filter results by OCID.
ListFileSystemsRequest.LifecycleState	getLifecycleState() Filter results by the specified lifecycle state.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() For list pagination.
String	getParentFileSystemId() The OCID of the file system that contains the source snapshot of a cloned file system.
ListFileSystemsRequest.SortBy	getSortBy() The field to sort by.
ListFileSystemsRequest.SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.
String	getSourceSnapshotId() The OCID of the snapshot used to create a cloned file system.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListFileSystemsRequest.Builder	toBuilder() Return an instance of ListFileSystemsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListFileSystemsRequest

public ListFileSystemsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getAvailabilityDomain

public String getAvailabilityDomain()

The name of the availability domain.

Example: Uocm:PHX-AD-1

getLimit

public Integer getLimit()

For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. 1 is the minimum, 4096 is the maximum.

For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Example: 500

getPage

public String getPage()

For list pagination. The value of the opc-next-page response header from the previous “List” call.

For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

getDisplayName

public String getDisplayName()

A user-friendly name. It does not have to be unique, and it is changeable.

Example: My resource

getLifecycleState

public ListFileSystemsRequest.LifecycleState getLifecycleState()

Filter results by the specified lifecycle state. Must be a valid state for the resource type.

getId

public String getId()

Filter results by OCID. Must be an OCID of the correct type for the resouce type.

getSourceSnapshotId

public String getSourceSnapshotId()

The OCID of the snapshot used to create a cloned file system. See Cloning a File System.

getParentFileSystemId

public String getParentFileSystemId()

The OCID of the file system that contains the source snapshot of a cloned file system. See Cloning a File System.

getFilesystemSnapshotPolicyId

public String getFilesystemSnapshotPolicyId()

The OCID of the file system snapshot policy that is associated with the file systems.

getSortBy

public ListFileSystemsRequest.SortBy getSortBy()

The field to sort by. You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order.

getSortOrder

public ListFileSystemsRequest.SortOrder getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending. The default order is ‘desc’ except for numeric values.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

toBuilder

public ListFileSystemsRequest.Builder toBuilder()

Return an instance of ListFileSystemsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListFileSystemsRequest.Builder that allows you to modify request properties.

builder

public static ListFileSystemsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>