Package com.oracle.bmc.core.requests

Class ListVolumesRequest

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

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

    • Constructor Detail

      • ListVolumesRequest

        public ListVolumesRequest()

    • Method Detail

      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The name of the availability domain.

        Example: Uocm:PHX-AD-1

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.

      • getLimit

        public Integer getLimit()
        For list pagination.

        The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

        Example: 50

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

      • getDisplayName

        public String getDisplayName()
        A filter to return only resources that match the given display name exactly.

      • getSortBy

        public ListVolumesRequest.SortBy getSortBy()
        The field to sort by.

        You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

        *Note:** In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

      • getSortOrder

        public ListVolumesRequest.SortOrder getSortOrder()
        The sort order to use, either ascending (ASC) or descending (DESC).

        The DISPLAYNAME sort order is case sensitive.

      • getVolumeGroupId

        public String getVolumeGroupId()
        The OCID of the volume group.

      • getClusterPlacementGroupId

        public String getClusterPlacementGroupId()
        A filter to return only resources that match the given cluster placement group Id exactly.

      • getLifecycleState

        public Volume.LifecycleState getLifecycleState()
        A filter to only return resources that match the given lifecycle state.

        The state value is case-insensitive.

      • builder

        public static ListVolumesRequest.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>