Package com.oracle.bmc.goldengate.model

Class OciGenAiModelAuthDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.goldengate.model.AiModelAuthDetails

com.oracle.bmc.goldengate.model.OciGenAiModelAuthDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class OciGenAiModelAuthDetails
extends AiModelAuthDetails

OCI Generative AI authentication details for an AI Model connection.
Note: Objects should always be created or deserialized using the OciGenAiModelAuthDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the OciGenAiModelAuthDetails.Builder, which maintain a set of all explicitly set fields called OciGenAiModelAuthDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OciGenAiModelAuthDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
OciGenAiModelAuthDetails(char[] apiKey, String apiKeySecretId, String keyFingerprint, String region, String tenancyId, String userId)	Deprecated.
OciGenAiModelAuthDetails(String apiKey, String apiKeySecretId, String keyFingerprint, String region, String tenancyId, String userId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static OciGenAiModelAuthDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getApiKey()	Deprecated. Use getApiKey__AsCharArray() instead.
char[]	getApiKey__AsCharArray()	API key for the AI model connection.
String	getApiKeySecretId()	API key secret OCID for the AI model connection.
String	getKeyFingerprint()	OCI Generative AI key fingerprint.
String	getRegion()	The name of the region.
String	getTenancyId()	OCI Generative AI tenancy OCID.
String	getUserId()	OCI Generative AI user OCID.
int	hashCode()
OciGenAiModelAuthDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OciGenAiModelAuthDetails

@Deprecated
public OciGenAiModelAuthDetails(String apiKey,
                                String apiKeySecretId,
                                String keyFingerprint,
                                String region,
                                String tenancyId,
                                String userId)

Deprecated.

OciGenAiModelAuthDetails

@Deprecated
public OciGenAiModelAuthDetails(char[] apiKey,
                                String apiKeySecretId,
                                String keyFingerprint,
                                String region,
                                String tenancyId,
                                String userId)

Deprecated.

Method Detail

builder

public static OciGenAiModelAuthDetails.Builder builder()

Create a new builder.

toBuilder

public OciGenAiModelAuthDetails.Builder toBuilder()

getApiKey

@Deprecated
public String getApiKey()

Deprecated.

Use getApiKey__AsCharArray() instead.

API key for the AI model connection.

Deprecated: This field is deprecated and replaced by "apiKeySecretId". This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:

the value

getApiKey__AsCharArray

public char[] getApiKey__AsCharArray()

API key for the AI model connection.

Deprecated: This field is deprecated and replaced by “apiKeySecretId”. This change follows the GoldenGate “Plain Text Fields in Connections” deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate

Returns:

the value

getApiKeySecretId

public String getApiKeySecretId()

API key secret OCID for the AI model connection.

Returns:

the value

getKeyFingerprint

public String getKeyFingerprint()

OCI Generative AI key fingerprint.

Returns:

the value

getRegion

public String getRegion()

The name of the region.

e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

Returns:

the value

getTenancyId

public String getTenancyId()

OCI Generative AI tenancy OCID.

If this value is not provided, or is updated to an empty value, it defaults to the tenancy OCID of the user who is executing the operation.

Returns:

the value

getUserId

public String getUserId()

OCI Generative AI user OCID.

If this value is not provided, or is updated to an empty value, it defaults to the OCID of the user who is executing the operation.

Returns:

the value

toString

public String toString()

Overrides:

toString in class AiModelAuthDetails

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class AiModelAuthDetails

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class AiModelAuthDetails

hashCode

public int hashCode()

Overrides:

hashCode in class AiModelAuthDetails