Package com.oracle.bmc.goldengate.model

Class CreateOciObjectStorageConnectionDetails

java.lang.Object

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

com.oracle.bmc.goldengate.model.CreateConnectionDetails

com.oracle.bmc.goldengate.model.CreateOciObjectStorageConnectionDetails

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

The information about a new OCI Object Storage Connection.
Note: Objects should always be created or deserialized using the CreateOciObjectStorageConnectionDetails.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 CreateOciObjectStorageConnectionDetails.Builder, which maintain a set of all explicitly set fields called CreateOciObjectStorageConnectionDetails.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	CreateOciObjectStorageConnectionDetails.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

CreateOciObjectStorageConnectionDetails(String displayName, String description, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, List<AddResourceLockDetails> locks, String vaultId, String keyId, List<String> nsgIds, String subnetId, RoutingMethod routingMethod, Boolean doesUseSecretIds, String subscriptionId, String clusterPlacementGroupId, Map<String,Map<String,Object>> securityAttributes, OciObjectStorageConnection.TechnologyType technologyType, String tenancyId, String region, String userId, String privateKeyFile, String privateKeyFileSecretId, String privateKeyPassphrase, String privateKeyPassphraseSecretId, String publicKeyFingerprint, Boolean shouldUseResourcePrincipal)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateOciObjectStorageConnectionDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getPrivateKeyFile()	The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint.
String	getPrivateKeyFileSecretId()	The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.
String	getPrivateKeyPassphrase()	The passphrase of the private key.
String	getPrivateKeyPassphraseSecretId()	The OCID of the Secret that stores the passphrase of the private key.
String	getPublicKeyFingerprint()	The fingerprint of the API Key of the user specified by the userId.
String	getRegion()	The name of the region.
Boolean	getShouldUseResourcePrincipal()	Specifies that the user intends to authenticate to the instance using a resource principal.
OciObjectStorageConnection.TechnologyType	getTechnologyType()	The OCI Object Storage technology type.
String	getTenancyId()	The OCID of the related OCI tenancy.
String	getUserId()	The OCID of the OCI user who will access the Object Storage.
int	hashCode()
CreateOciObjectStorageConnectionDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.goldengate.model.CreateConnectionDetails

getClusterPlacementGroupId, getCompartmentId, getDefinedTags, getDescription, getDisplayName, getDoesUseSecretIds, getFreeformTags, getKeyId, getLocks, getNsgIds, getRoutingMethod, getSecurityAttributes, getSubnetId, getSubscriptionId, getVaultId

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

CreateOciObjectStorageConnectionDetails

@Deprecated
public CreateOciObjectStorageConnectionDetails(String displayName,
                                               String description,
                                               String compartmentId,
                                               Map<String,String> freeformTags,
                                               Map<String,Map<String,Object>> definedTags,
                                               List<AddResourceLockDetails> locks,
                                               String vaultId,
                                               String keyId,
                                               List<String> nsgIds,
                                               String subnetId,
                                               RoutingMethod routingMethod,
                                               Boolean doesUseSecretIds,
                                               String subscriptionId,
                                               String clusterPlacementGroupId,
                                               Map<String,Map<String,Object>> securityAttributes,
                                               OciObjectStorageConnection.TechnologyType technologyType,
                                               String tenancyId,
                                               String region,
                                               String userId,
                                               String privateKeyFile,
                                               String privateKeyFileSecretId,
                                               String privateKeyPassphrase,
                                               String privateKeyPassphraseSecretId,
                                               String publicKeyFingerprint,
                                               Boolean shouldUseResourcePrincipal)

Deprecated.

Method Detail

builder

public static CreateOciObjectStorageConnectionDetails.Builder builder()

Create a new builder.

toBuilder

public CreateOciObjectStorageConnectionDetails.Builder toBuilder()

getTechnologyType

public OciObjectStorageConnection.TechnologyType getTechnologyType()

The OCI Object Storage technology type.

Returns:

the value

getTenancyId

public String getTenancyId()

The OCID of the related OCI tenancy.

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

getUserId

public String getUserId()

The OCID of the OCI user who will access the Object Storage.

The user must have write access to the bucket they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.

Returns:

the value

getPrivateKeyFile

public String getPrivateKeyFile()

The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint.

See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by “privateKeyFileSecretId”. This field will be removed after February 15 2026.

Returns:

the value

getPrivateKeyFileSecretId

public String getPrivateKeyFileSecretId()

The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint.

See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, ‘privateKeyFile’ field must not be provided.

Returns:

the value

getPrivateKeyPassphrase

public String getPrivateKeyPassphrase()

The passphrase of the private key.

Deprecated: This field is deprecated and replaced by “privateKeyPassphraseSecretId”. This field will be removed after February 15 2026.

Returns:

the value

getPrivateKeyPassphraseSecretId

public String getPrivateKeyPassphraseSecretId()

The OCID of the Secret that stores the passphrase of the private key.

Note: When provided, ‘privateKeyPassphrase’ field must not be provided.

Returns:

the value

getPublicKeyFingerprint

public String getPublicKeyFingerprint()

The fingerprint of the API Key of the user specified by the userId.

See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

Returns:

the value

getShouldUseResourcePrincipal

public Boolean getShouldUseResourcePrincipal()

Specifies that the user intends to authenticate to the instance using a resource principal.

Default: false

Returns:

the value

toString

public String toString()

Overrides:

toString in class CreateConnectionDetails

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class CreateConnectionDetails

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class CreateConnectionDetails

hashCode

public int hashCode()

Overrides:

hashCode in class CreateConnectionDetails