Package com.oracle.bmc.filestorage.requests

Class ListFileSystemsRequest

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

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.65.0/filestorage/ListFileSystemsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListFileSystemsRequest.

    • 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.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.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

      • getId

        public String getId()
        Filter results by OCID.

        Must be an OCID of the correct type for the resouce type.

      • 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.

      • builder

        public static ListFileSystemsRequest.Builder builder()
        Return a new builder for this request object.
        Returns:
        builder for the request 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>