Package com.oracle.bmc.objectstorage.requests

Class GetBucketRequest

java.lang.Object

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

com.oracle.bmc.objectstorage.requests.GetBucketRequest

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

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
GetBucketRequest()

Method Summary

Modifier and Type	Method	Description
static GetBucketRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getBucketName()	The name of the bucket.
List<GetBucketRequest.Fields>	getFields()	Bucket summary includes the ‘namespace’, ‘name’, ‘compartmentId’, ‘createdBy’, ‘timeCreated’, and ‘etag’ fields.
String	getIfMatch()	The entity tag (ETag) to match with the ETag of an existing resource.
String	getIfNoneMatch()	The entity tag (ETag) to avoid matching.
String	getNamespaceName()	The Object Storage namespace used for the request.
String	getOpcClientRequestId()	The client request ID for tracing.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
GetBucketRequest.Builder	toBuilder()	Return an instance of GetBucketRequest.Builder that allows you to modify request properties.
String	toString()

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetBucketRequest

public GetBucketRequest()

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

getIfMatch

public String getIfMatch()

The entity tag (ETag) to match with the ETag of an existing resource.

If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource.

getIfNoneMatch

public String getIfNoneMatch()

The entity tag (ETag) to avoid matching.

Wildcards (‘*’) are not allowed. If the specified ETag does not match the ETag of the existing resource, the request returns the expected response. If the ETag matches the ETag of the existing resource, the request returns an HTTP 304 status without a response body.

getOpcClientRequestId

public String getOpcClientRequestId()

The client request ID for tracing.

getFields

public List<GetBucketRequest.Fields> getFields()

Bucket summary includes the ‘namespace’, ‘name’, ‘compartmentId’, ‘createdBy’, ‘timeCreated’, and ‘etag’ fields.

This parameter can also include ‘approximateCount’ (approximate number of objects), ‘approximateSize’ (total approximate size in bytes of all objects) and ‘autoTiering’ (state of auto tiering on the bucket). For example ‘approximateCount,approximateSize,autoTiering’.

toBuilder

public GetBucketRequest.Builder toBuilder()

Return an instance of GetBucketRequest.Builder that allows you to modify request properties.

Returns:

instance of GetBucketRequest.Builder that allows you to modify request properties.

builder

public static GetBucketRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class 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>