Class OciCredential.Builder

java.lang.Object

co.yellowdog.platform.model.builders.ValidatedBuilder<OciCredential>

co.yellowdog.platform.account.credentials.OciCredential.Builder

All Implemented Interfaces:

CredentialBuilder<OciCredential>

Enclosing class:

OciCredential

public static class OciCredential.Builder
extends ValidatedBuilder<OciCredential>
implements CredentialBuilder<OciCredential>

A builder that can be used to build a new OciCredential that is automatically validated on build.

Method Summary

Modifier and Type	Method	Description
OciCredential	buildUnchecked()	Builds the object without enforcing validation constraints.
OciCredential.Builder	description(String description)
OciCredential.Builder	fingerprint(String fingerprint)	The OCI public key fingerprint.
OciCredential.Builder	name(String name)
OciCredential.Builder	passphrase(String passphrase)	The OCI private key passphrase.
OciCredential.Builder	privateKey(String privateKey)	The OCI private key.
OciCredential.Builder	privateKeyFile(@NonNull Path privateKeyFile)	Loads the OCI private key value from the specified file.
OciCredential.Builder	tenantId(String tenantId)	The OCI tenant ID (ocid).
String	toString()
OciCredential.Builder	userId(String userId)	The OCI User ID (ocid).

Methods inherited from class ValidatedBuilder

build, validate

Modifier and Type	Method	Description
OciCredential	build()	Builds and validates the object.
Set<jakarta.validation.ConstraintViolation<OciCredential>>	validate()	Performs validation based on the current builder properties and returns the ConstraintViolations without throwing.

Methods inherited from class Object

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

Method Details

privateKeyFile

public OciCredential.Builder privateKeyFile(@NonNull
 @NonNull Path privateKeyFile)
                                     throws IOException

Loads the OCI private key value from the specified file.

Parameters:

privateKeyFile - the OCI private key file

Returns:

the builder

Throws:

IOException - if an exception is throw whilst reading the file

name

public OciCredential.Builder name(String name)

Specified by:

name in interface CredentialBuilder<OciCredential>

Returns:

this.

description

public OciCredential.Builder description(String description)

Returns:

this.

userId

public OciCredential.Builder userId(String userId)

The OCI User ID (ocid).

Parameters:

userId - the OCI User ID

Returns:

this.

tenantId

public OciCredential.Builder tenantId(String tenantId)

The OCI tenant ID (ocid).

Parameters:

tenantId - the OCI tenant ID

Returns:

this.

fingerprint

public OciCredential.Builder fingerprint(String fingerprint)

The OCI public key fingerprint.

Parameters:

fingerprint - the OCI public key fingerprint

Returns:

this.

privateKey

public OciCredential.Builder privateKey(String privateKey)

The OCI private key.

Parameters:

privateKey - the OCI private key

Returns:

this.

passphrase

public OciCredential.Builder passphrase(String passphrase)

The OCI private key passphrase.

Parameters:

passphrase - the OCI private key passphrase

Returns:

this.

buildUnchecked

public OciCredential buildUnchecked()

Description copied from class: ValidatedBuilder

Builds the object without enforcing validation constraints. This should only be used for testing purposes

Specified by:

buildUnchecked in interface CredentialBuilder<OciCredential>

Overrides:

buildUnchecked in class ValidatedBuilder<OciCredential>

Returns:

the object being built

toString

public String toString()

Overrides:

toString in class Object