com.oracle.bmc.objectstorage.requests

Class ListObjectsRequest

java.lang.Object

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

com.oracle.bmc.objectstorage.requests.ListObjectsRequest

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

Example: Click here to see how to use ListObjectsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListObjectsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListObjectsRequest.Builder	builder()
String	getBucketName() The name of the bucket.
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.
String	getEnd() Object names returned by a list query must be strictly less than this parameter.
String	getFields() Object summary by default includes only the ‘name’ field.
Integer	getLimit() For list pagination.
String	getNamespaceName() The Object Storage namespace used for the request.
String	getOpcClientRequestId() The client request ID for tracing.
String	getPrefix() The string to use for matching against the start of object names in a list query.
String	getStart() Object names returned by a list query must be greater or equal to this parameter.
String	getStartAfter() Object names returned by a list query must be greater than this parameter.

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListObjectsRequest.Builder builder()

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()

Object names returned by a list query must be greater or equal to this parameter.

getEnd

public String getEnd()

Object names returned by a list query must be 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()

Object names returned by a list query must be greater than this parameter.