com.oracle.bmc.objectstorage.requests

Class ListBucketsRequest.Builder

java.lang.Object

com.oracle.bmc.objectstorage.requests.ListBucketsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListBucketsRequest,Void>

Enclosing class:

ListBucketsRequest

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

Method Summary

Modifier and Type	Method and Description
ListBucketsRequest	build() Build the instance of ListBucketsRequest as configured by this builder
ListBucketsRequest	buildWithoutInvocationCallback()
ListBucketsRequest.Builder	compartmentId(String compartmentId) The ID of the compartment in which to list buckets.
ListBucketsRequest.Builder	copy(ListBucketsRequest o) Copy method to populate the builder with values from the given instance.
ListBucketsRequest.Builder	fields(List<ListBucketsRequest.Fields> fields) Bucket summary in list of buckets includes the ‘namespace’, ‘name’, ‘compartmentId’, ‘createdBy’, ‘timeCreated’, and ‘etag’ fields.
ListBucketsRequest.Builder	fields(ListBucketsRequest.Fields singularValue) Singular setter.
ListBucketsRequest.Builder	invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback) Set the invocation callback for the request to be built.
ListBucketsRequest.Builder	limit(Integer limit) For list pagination.
ListBucketsRequest.Builder	namespaceName(String namespaceName) The Object Storage namespace used for the request.
ListBucketsRequest.Builder	opcClientRequestId(String opcClientRequestId) The client request ID for tracing.
ListBucketsRequest.Builder	page(String page) For list pagination.
ListBucketsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
String	toString()

Methods inherited from class java.lang.Object

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

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

body$

Method Detail

fields

public ListBucketsRequest.Builder fields(List<ListBucketsRequest.Fields> fields)

Bucket summary in list of buckets includes the ‘namespace’, ‘name’, ‘compartmentId’, ‘createdBy’, ‘timeCreated’, and ‘etag’ fields. This parameter can also include ‘tags’ (freeformTags and definedTags). The only supported value of this parameter is ‘tags’ for now. Example ‘tags’.

Returns:

this builder instance

fields

public ListBucketsRequest.Builder fields(ListBucketsRequest.Fields singularValue)

Singular setter. Bucket summary in list of buckets includes the ‘namespace’, ‘name’, ‘compartmentId’, ‘createdBy’, ‘timeCreated’, and ‘etag’ fields. This parameter can also include ‘tags’ (freeformTags and definedTags). The only supported value of this parameter is ‘tags’ for now. Example ‘tags’.

Returns:

this builder instance

invocationCallback

public ListBucketsRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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 ListBucketsRequest.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 ListBucketsRequest.Builder copy(ListBucketsRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListBucketsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListBucketsRequest build()

Build the instance of ListBucketsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.util.internal.Consumer) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListBucketsRequest,Void>

Returns:

instance of ListBucketsRequest

namespaceName

public ListBucketsRequest.Builder namespaceName(String namespaceName)

The Object Storage namespace used for the request.

Returns:

this.

compartmentId

public ListBucketsRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list buckets.

Returns:

this.

limit

public ListBucketsRequest.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.

Returns:

this.

page

public ListBucketsRequest.Builder page(String page)

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.

Returns:

this.

opcClientRequestId

public ListBucketsRequest.Builder opcClientRequestId(String opcClientRequestId)

The client request ID for tracing.

Returns:

this.

buildWithoutInvocationCallback

public ListBucketsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object