Package com.oracle.bmc.objectstorage.requests

Class ListObjectsRequest

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

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

    • Constructor Detail

      • ListObjectsRequest

        public ListObjectsRequest()

    • Method Detail

      • getNamespaceName

        public String getNamespaceName()
        The Object Storage namespace used for the request.

      • getBucketName

        public String getBucketName()
        The name of the bucket.

        Avoid entering confidential information. Example: my-new-bucket1

      • getPrefix

        public String getPrefix()
        The string to use for matching against the start of object names in a list query.

      • getStart

        public String getStart()
        Returns object names which are lexicographically greater than or equal to this parameter.

      • getEnd

        public String getEnd()
        Returns object names which are lexicographically strictly less than this parameter.

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

      • getDelimiter

        public String getDelimiter()
        When this parameter is set, only objects whose names do not contain the delimiter character (after an optionally specified prefix) are returned in the objects key of the response body.

        Scanned objects whose names contain the delimiter have the part of their name up to the first occurrence of the delimiter (including the optional prefix) returned as a set of prefixes. Note that only ‘/’ is a supported delimiter character at this time.

      • getFields

        public String getFields()
        Object summary by default includes only the ‘name’ field.

        Use this parameter to also include ‘size’ (object size in bytes), ‘etag’, ‘md5’, ‘timeCreated’ (object creation date and time), ‘timeModified’ (object modification date and time), ‘storageTier’ and ‘archivalState’ fields. Specify the value of this parameter as a comma-separated, case-insensitive list of those field names. For example ‘name,etag,timeCreated,md5,timeModified,storageTier,archivalState’.

      • getOpcClientRequestId

        public String getOpcClientRequestId()
        The client request ID for tracing.

      • getStartAfter

        public String getStartAfter()
        Returns object names which are lexicographically strictly greater than this parameter.

      • builder

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