com.oracle.bmc.objectstorage.requests

Class ListBucketsRequest

java.lang.Object

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

com.oracle.bmc.objectstorage.requests.ListBucketsRequest

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

Example: Click here to see how to use ListBucketsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListBucketsRequest.Builder
static class	ListBucketsRequest.Fields Bucket summary in list of buckets includes the ‘namespace’, ‘name’, ‘compartmentId’, ‘createdBy’, ‘timeCreated’, and ‘etag’ fields.

Method Summary

Modifier and Type	Method and Description
static ListBucketsRequest.Builder	builder()
String	getCompartmentId() The ID of the compartment in which to list buckets.
List<ListBucketsRequest.Fields>	getFields() Bucket summary in list of buckets includes the ‘namespace’, ‘name’, ‘compartmentId’, ‘createdBy’, ‘timeCreated’, and ‘etag’ fields.
Integer	getLimit() For list pagination.
String	getNamespaceName() The Object Storage namespace used for the request.
String	getOpcClientRequestId() The client request ID for tracing.
String	getPage() For list pagination.

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 ListBucketsRequest.Builder builder()

getNamespaceName

public String getNamespaceName()

The Object Storage namespace used for the request.

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to list buckets.

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.

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.

getFields

public List<ListBucketsRequest.Fields> getFields()

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

getOpcClientRequestId

public String getOpcClientRequestId()

The client request ID for tracing.