Module io.helidon.integrations.oci.objectstorage

Package io.helidon.integrations.oci.objectstorage

Class GetBucket.Request

java.lang.Object

io.helidon.integrations.common.rest.ApiJsonBuilder<T>

io.helidon.integrations.common.rest.ApiJsonRequest<T>

io.helidon.integrations.oci.connect.OciRequestBase<GetBucket.Request>

io.helidon.integrations.oci.objectstorage.GetBucket.Request

All Implemented Interfaces:

ApiRequest<GetBucket.Request>

Enclosing class:

GetBucket

public static class GetBucket.Request
extends OciRequestBase<GetBucket.Request>

Request object. Can be configured with additional headers, query parameters etc.

Method Summary

Modifier and Type	Method	Description
String	bucket()	Name of the bucket, required.
GetBucket.Request	bucket(String bucket)	The name of the bucket.
static GetBucket.Request	builder()	Fluent API builder for configuring a request.
Optional<String>	namespace()	Namespace if configured on this request.
GetBucket.Request	namespace(String namespace)	The Object Storage namespace used for the request.
Optional<JsonObject>	toJson(JsonBuilderFactory factory)	Create a JSON object from this builder.

Methods inherited from class io.helidon.integrations.oci.connect.OciRequestBase

add, endpoint, endpoint, hostFormat, hostPrefix, retryToken

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonRequest

addHeader, addQueryParam, headers, queryParams, requestId, requestId, requestMediaType, requestMediaType, responseMediaType, responseMediaType

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonBuilder

add, add, add, add, add, add, addBase64, addToArray, addToArray, addToArray, addToArray, addToArray, addToArray, addToObject, addToObject, addToObject, addToObject, addToObject, emptyArray, me, postBuild, preBuild

Methods inherited from class java.lang.Object

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

Method Details

builder

public static GetBucket.Request builder()

Fluent API builder for configuring a request. The request builder is passed as is, without a build method. The equivalent of a build method is toJson(JsonBuilderFactory) used by the RestApi.

Returns:

new request builder

toJson

public Optional<JsonObject> toJson(JsonBuilderFactory factory)

Description copied from class: ApiJsonBuilder

Create a JSON object from this builder.

Specified by:

toJson in interface ApiRequest<GetBucket.Request>

Overrides:

toJson in class ApiJsonBuilder<GetBucket.Request>

Parameters:

factory - builder factory to create objects

Returns:

JSON object or empty

namespace

public GetBucket.Request namespace(String namespace)

The Object Storage namespace used for the request. Override the default namespace (if one is configured).

Parameters:

namespace - namespace

Returns:

updated request

bucket

public GetBucket.Request bucket(String bucket)

The name of the bucket. Avoid entering confidential information. Required.

Parameters:

bucket - bucket name

Returns:

updated requst

namespace

public Optional<String> namespace()

Namespace if configured on this request.

Returns:

namespace or empty if not configured per request

bucket

public String bucket()

Name of the bucket, required.

Returns:

bucket name