Class GetBucketRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.objectstorage.requests.GetBucketRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<GetBucketRequest,Void>
- Enclosing class:
- GetBucketRequest
public static class GetBucketRequest.Builder extends Object implements BmcRequest.Builder<GetBucketRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetBucketRequest.Builder
bucketName(String bucketName)
The name of the bucket.GetBucketRequest
build()
Build the instance of GetBucketRequest as configured by this builderGetBucketRequest
buildWithoutInvocationCallback()
Build the instance of GetBucketRequest as configured by this builderGetBucketRequest.Builder
copy(GetBucketRequest o)
Copy method to populate the builder with values from the given instance.GetBucketRequest.Builder
fields(GetBucketRequest.Fields singularValue)
Singular setter.GetBucketRequest.Builder
fields(List<GetBucketRequest.Fields> fields)
Bucket summary includes the ‘namespace’, ‘name’, ‘compartmentId’, ‘createdBy’, ‘timeCreated’, and ‘etag’ fields.GetBucketRequest.Builder
ifMatch(String ifMatch)
The entity tag (ETag) to match with the ETag of an existing resource.GetBucketRequest.Builder
ifNoneMatch(String ifNoneMatch)
The entity tag (ETag) to avoid matching.GetBucketRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.GetBucketRequest.Builder
namespaceName(String namespaceName)
The Object Storage namespace used for the request.GetBucketRequest.Builder
opcClientRequestId(String opcClientRequestId)
The client request ID for tracing.GetBucketRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.-
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$
-
-
-
-
Method Detail
-
namespaceName
public GetBucketRequest.Builder namespaceName(String namespaceName)
The Object Storage namespace used for the request.- Parameters:
namespaceName
- the value to set- Returns:
- this builder instance
-
bucketName
public GetBucketRequest.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
-
ifMatch
public GetBucketRequest.Builder ifMatch(String ifMatch)
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.
- Parameters:
ifMatch
- the value to set- Returns:
- this builder instance
-
ifNoneMatch
public GetBucketRequest.Builder ifNoneMatch(String ifNoneMatch)
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.
- Parameters:
ifNoneMatch
- the value to set- Returns:
- this builder instance
-
opcClientRequestId
public GetBucketRequest.Builder opcClientRequestId(String opcClientRequestId)
The client request ID for tracing.- Parameters:
opcClientRequestId
- the value to set- Returns:
- this builder instance
-
fields
public GetBucketRequest.Builder fields(List<GetBucketRequest.Fields> fields)
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’.
- Parameters:
fields
- the value to set- Returns:
- this builder instance
-
fields
public GetBucketRequest.Builder fields(GetBucketRequest.Fields singularValue)
Singular setter.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’.
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
invocationCallback
public GetBucketRequest.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 GetBucketRequest.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 GetBucketRequest.Builder copy(GetBucketRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<GetBucketRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public GetBucketRequest build()
Build the instance of GetBucketRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<GetBucketRequest,Void>
- Returns:
- instance of GetBucketRequest
-
buildWithoutInvocationCallback
public GetBucketRequest buildWithoutInvocationCallback()
Build the instance of GetBucketRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of GetBucketRequest
-
-