com.oracle.bmc.objectstorage.requests

Class ListObjectsRequest.Builder

java.lang.Object

com.oracle.bmc.objectstorage.requests.ListObjectsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListObjectsRequest,Void>

Enclosing class:

ListObjectsRequest

public static class ListObjectsRequest.Builder
extends Object
implements BmcRequest.Builder<ListObjectsRequest,Void>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListObjectsRequest.Builder	bucketName(String bucketName) The name of the bucket.
ListObjectsRequest	build() Build the instance of ListObjectsRequest as configured by this builder
ListObjectsRequest	buildWithoutInvocationCallback() Build the instance of ListObjectsRequest as configured by this builder
ListObjectsRequest.Builder	copy(ListObjectsRequest o) Copy method to populate the builder with values from the given instance.
ListObjectsRequest.Builder	delimiter(String delimiter) 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.
ListObjectsRequest.Builder	end(String end) Returns object names which are lexicographically strictly less than this parameter.
ListObjectsRequest.Builder	fields(String fields) Object summary by default includes only the ‘name’ field.
ListObjectsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListObjectsRequest.Builder	limit(Integer limit) For list pagination.
ListObjectsRequest.Builder	namespaceName(String namespaceName) The Object Storage namespace used for the request.
ListObjectsRequest.Builder	opcClientRequestId(String opcClientRequestId) The client request ID for tracing.
ListObjectsRequest.Builder	prefix(String prefix) The string to use for matching against the start of object names in a list query.
ListObjectsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListObjectsRequest.Builder	start(String start) Returns object names which are lexicographically greater than or equal to this parameter.
ListObjectsRequest.Builder	startAfter(String startAfter) Returns object names which are lexicographically strictly greater than this parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

namespaceName

public ListObjectsRequest.Builder namespaceName(String namespaceName)

The Object Storage namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

bucketName

public ListObjectsRequest.Builder bucketName(String bucketName)

The name of the bucket. Avoid entering confidential information. Example: my-new-bucket1

Parameters:

bucketName - the value to set

Returns:

this builder instance

prefix

public ListObjectsRequest.Builder prefix(String prefix)

The string to use for matching against the start of object names in a list query.

Parameters:

prefix - the value to set

Returns:

this builder instance

start

public ListObjectsRequest.Builder start(String start)

Returns object names which are lexicographically greater than or equal to this parameter.

Parameters:

start - the value to set

Returns:

this builder instance

end

public ListObjectsRequest.Builder end(String end)

Returns object names which are lexicographically strictly less than this parameter.

Parameters:

end - the value to set

Returns:

this builder instance

limit

public ListObjectsRequest.Builder limit(Integer limit)

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.

Parameters:

limit - the value to set

Returns:

this builder instance

delimiter

public ListObjectsRequest.Builder delimiter(String delimiter)

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.

Parameters:

delimiter - the value to set

Returns:

this builder instance

fields

public ListObjectsRequest.Builder fields(String fields)

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

Parameters:

fields - the value to set

Returns:

this builder instance

opcClientRequestId

public ListObjectsRequest.Builder opcClientRequestId(String opcClientRequestId)

The client request ID for tracing.

Parameters:

opcClientRequestId - the value to set

Returns:

this builder instance

startAfter

public ListObjectsRequest.Builder startAfter(String startAfter)

Returns object names which are lexicographically strictly greater than this parameter.

Parameters:

startAfter - the value to set

Returns:

this builder instance

invocationCallback

public ListObjectsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListObjectsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListObjectsRequest.Builder copy(ListObjectsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListObjectsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListObjectsRequest build()

Build the instance of ListObjectsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListObjectsRequest,Void>

Returns:

instance of ListObjectsRequest

buildWithoutInvocationCallback

public ListObjectsRequest buildWithoutInvocationCallback()

Build the instance of ListObjectsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListObjectsRequest