Module io.helidon.integrations.oci.connect

Package io.helidon.integrations.oci.connect

Class OciRequestBase<T extends OciRequestBase<T>>

java.lang.Object

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

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

io.helidon.integrations.oci.connect.OciRequestBase<T>

Type Parameters:

T - type of the request

All Implemented Interfaces:

ApiRequest<T>

Direct Known Subclasses:

CreateSecret.Request, Decrypt.Request, DeleteSecret.Request, Encrypt.Request, GenerateAutonomousDatabaseWallet.Request, GetBucket.Request, GetKey.Request, GetSecret.Request, GetSecretBundle.Request, GetVault.Request, ObjectRequest, PostMetricData.Request, Sign.Request, Verify.Request

@Deprecated(since="2.5.0",
            forRemoval=true)
public abstract class OciRequestBase<T extends OciRequestBase<T>>
extends ApiJsonRequest<T>

Deprecated, for removal: This API element is subject to removal in a future version.

OCI SDK instead

A base for OCI requests that acts as a builder. Adds support for retryToken.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OciRequestBase()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected T	add(String name, Instant instant)	Deprecated, for removal: This API element is subject to removal in a future version. Add a timestamp to the JSON.
Optional<String>	endpoint()	Deprecated, for removal: This API element is subject to removal in a future version. Endpoint (if configured).
T	endpoint(String endpoint)	Deprecated, for removal: This API element is subject to removal in a future version. Override the endpoint to use for this request.
T	hostFormat(String hostFormat)	Deprecated, for removal: This API element is subject to removal in a future version. Host format to use.
T	hostPrefix(String hostPrefix)	Deprecated, for removal: This API element is subject to removal in a future version. Host prefix to use.
T	retryToken(String retryToken)	Deprecated, for removal: This API element is subject to removal in a future version. Retry token to support idempotent request when updating data.

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, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.integrations.common.rest.ApiRequest

toJson

Constructor Detail

OciRequestBase

protected OciRequestBase()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Detail

retryToken

public T retryToken(String retryToken)

Deprecated, for removal: This API element is subject to removal in a future version.

Retry token to support idempotent request when updating data.

Parameters:

retryToken - retry token

Returns:

updated request

hostPrefix

public T hostPrefix(String hostPrefix)

Deprecated, for removal: This API element is subject to removal in a future version.

Host prefix to use. This is intended for API implementation and allows override of the default host prefix (for example in Vault API, we may use two different prefixes).

Parameters:

hostPrefix - host prefix

Returns:

updated request

hostFormat

public T hostFormat(String hostFormat)

Deprecated, for removal: This API element is subject to removal in a future version.

Host format to use. Domain specific APIs must define a host format for each request.

Parameters:

hostFormat - host format

Returns:

updated request

endpoint

public T endpoint(String endpoint)

Deprecated, for removal: This API element is subject to removal in a future version.

Override the endpoint to use for this request.

Parameters:

endpoint - full endpoint to override the default

Returns:

updated builder

endpoint

public Optional<String> endpoint()

Deprecated, for removal: This API element is subject to removal in a future version.

Endpoint (if configured).

Returns:

configured endpoint or empty

add

protected T add(String name,
                Instant instant)

Deprecated, for removal: This API element is subject to removal in a future version.

Add a timestamp to the JSON. Uses the timestamp as defined in OCI API.

Parameters:

name - name of the property

instant - instant value

Returns:

updated request