Module io.helidon.integrations.oci.objectstorage

Package io.helidon.integrations.oci.objectstorage

Interface OciObjectStorageRx

public interface OciObjectStorageRx

Reactive API for OCI Object Storage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OciObjectStorageRx.Builder	Fluent API Builder for OciObjectStorageRx.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	API_HOST_FORMAT	Host format of API server.
static final String	API_HOST_PREFIX	Host name prefix.
static final String	API_VERSION	Version of Secret API supported by this client.

Method Summary

Modifier and Type	Method	Description
static OciObjectStorageRx.Builder	builder()	Create a new fluent API builder for OCI object storage.
static OciObjectStorageRx	create()	Create OCI Object Storage using the default OciRestApi.
static OciObjectStorageRx	create(Config config)	Create OCI Object Storage based on configuration.
Single<DeleteObject.Response>	deleteObject(DeleteObject.Request request)	Deletes an object.
Single<ApiOptionalResponse<GetBucket.Response>>	getBucket(GetBucket.Request request)	Gets the metadata of a bucket.
Single<ApiOptionalResponse<GetObjectRx.Response>>	getObject(GetObject.Request request)	Gets the metadata and body of an object.
Single<PutObject.Response>	putObject(PutObject.Request request, Flow.Publisher<DataChunk> publisher)	Creates a new object or overwrites an existing object with the same name.
Single<RenameObject.Response>	renameObject(RenameObject.Request request)	Rename an object in the given Object Storage namespace.

Field Details

API_VERSION

static final String API_VERSION

Version of Secret API supported by this client.

See Also:

• Constant Field Values

API_HOST_PREFIX

static final String API_HOST_PREFIX

Host name prefix.

See Also:

• Constant Field Values

API_HOST_FORMAT

static final String API_HOST_FORMAT

Host format of API server.

See Also:

• Constant Field Values

Method Details

builder

static OciObjectStorageRx.Builder builder()

Create a new fluent API builder for OCI object storage.

Returns:

a new builder

create

static OciObjectStorageRx create()

Create OCI Object Storage using the default OciRestApi.

Returns:

OCI object storage instance connecting based on DEFAULT profile

create

static OciObjectStorageRx create(Config config)

Create OCI Object Storage based on configuration.

Parameters:

config - configuration on the node of OCI configuration

Returns:

OCI object storage instance configured from the configuration

See Also:

• OciObjectStorageRx.Builder.config(io.helidon.config.Config)

getObject

Single<ApiOptionalResponse<GetObjectRx.Response>> getObject(GetObject.Request request)

Gets the metadata and body of an object.

Parameters:

request - get object request

Returns:

future with response or error

putObject

Single<PutObject.Response> putObject(PutObject.Request request,
 Flow.Publisher<DataChunk> publisher)

Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by PutObject is 50 GiB.

Parameters:

request - put object request

publisher - publisher of object's data

Returns:

future with response or error

deleteObject

Single<DeleteObject.Response> deleteObject(DeleteObject.Request request)

Deletes an object.

Parameters:

request - delete object request

Returns:

future with response or error

renameObject

Single<RenameObject.Response> renameObject(RenameObject.Request request)

Rename an object in the given Object Storage namespace. See Object Names.

Parameters:

request - rename object request

Returns:

future with response or error

getBucket

Single<ApiOptionalResponse<GetBucket.Response>> getBucket(GetBucket.Request request)

Gets the metadata of a bucket.

Parameters:

request - get bucket request

Returns:

future with response or error