Class CreateConnectionDetails
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.goldengate.model.CreateConnectionDetails
-
- Direct Known Subclasses:
CreateAiModelConnectionDetails,CreateAmazonKinesisConnectionDetails,CreateAmazonRedshiftConnectionDetails,CreateAmazonS3ConnectionDetails,CreateAzureDataLakeStorageConnectionDetails,CreateAzureSynapseConnectionDetails,CreateDatabricksConnectionDetails,CreateDb2ConnectionDetails,CreateElasticsearchConnectionDetails,CreateGenericConnectionDetails,CreateGoldenGateConnectionDetails,CreateGoogleBigQueryConnectionDetails,CreateGoogleCloudStorageConnectionDetails,CreateGooglePubSubConnectionDetails,CreateHdfsConnectionDetails,CreateIcebergConnectionDetails,CreateJavaMessageServiceConnectionDetails,CreateKafkaConnectionDetails,CreateKafkaSchemaRegistryConnectionDetails,CreateMicrosoftFabricConnectionDetails,CreateMicrosoftSqlserverConnectionDetails,CreateMongoDbConnectionDetails,CreateMysqlConnectionDetails,CreateOciObjectStorageConnectionDetails,CreateOracleAiDataPlatformConnectionDetails,CreateOracleConnectionDetails,CreateOracleNosqlConnectionDetails,CreatePostgresqlConnectionDetails,CreateRedisConnectionDetails,CreateSnowflakeConnectionDetails
@Generated(value="OracleSDKGenerator", comments="API Version: 20200407") public class CreateConnectionDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelThe information about a new Connection.
Note: Objects should always be created or deserialized using theBuilder. 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 theBuilder, which maintain a set of all explicitly set fields calledBuilder#__explicitlySet__. ThehashCode()andequals(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).
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedCreateConnectionDetails(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)Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)StringgetClusterPlacementGroupId()The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.StringgetCompartmentId()The OCID of the compartment being referenced.Map<String,Map<String,Object>>getDefinedTags()Tags defined for this resource.StringgetDescription()Metadata about this specific object.StringgetDisplayName()An object’s Display Name.BooleangetDoesUseSecretIds()Indicates that sensitive attributes are provided via Secrets.Map<String,String>getFreeformTags()A simple key-value pair that is applied without any predefined name, type, or scope.StringgetKeyId()References the OCI Vault key in the OCI Vault identified by vaultId.List<AddResourceLockDetails>getLocks()Locks associated with this resource.List<String>getNsgIds()An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.RoutingMethodgetRoutingMethod()Controls the network traffic direction to the target: SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet.Map<String,Map<String,Object>>getSecurityAttributes()Security attributes for this resource.StringgetSubnetId()The OCID of the target subnet of the dedicated connection.StringgetSubscriptionId()The OCID of the subscription with which resource needs to be associated with.StringgetVaultId()References the OCI Vault that contains the customer-managed encryption key identified by keyId.inthashCode()StringtoString()StringtoString(boolean includeByteArrayContents)Return a string representation of the object.
-
-
-
Constructor Detail
-
CreateConnectionDetails
@Deprecated @ConstructorProperties({"displayName","description","compartmentId","freeformTags","definedTags","locks","vaultId","keyId","nsgIds","subnetId","routingMethod","doesUseSecretIds","subscriptionId","clusterPlacementGroupId","securityAttributes"}) protected CreateConnectionDetails(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)
Deprecated.
-
-
Method Detail
-
getDisplayName
public String getDisplayName()
An object’s Display Name.- Returns:
- the value
-
getDescription
public String getDescription()
Metadata about this specific object.- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment being referenced.- Returns:
- the value
-
getFreeformTags
public Map<String,String> getFreeformTags()
A simple key-value pair that is applied without any predefined name, type, or scope.Exists for cross-compatibility only.
Example: {"bar-key": "value"}
- Returns:
- the value
-
getDefinedTags
public Map<String,Map<String,Object>> getDefinedTags()
Tags defined for this resource.Each key is predefined and scoped to a namespace.
Example: {"foo-namespace": {"bar-key": "value"}}
- Returns:
- the value
-
getLocks
public List<AddResourceLockDetails> getLocks()
Locks associated with this resource.- Returns:
- the value
-
getVaultId
public String getVaultId()
References the OCI Vault that contains the customer-managed encryption key identified by keyId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
This field is applicable only when doesUseSecretIds is set to false. If vaultId is provided, keyId must also be provided.
- Returns:
- the value
-
getKeyId
public String getKeyId()
References the OCI Vault key in the OCI Vault identified by vaultId.Deprecated: This field is deprecated for GoldenGate connections. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes encrypted with vaultId and keyId. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
The GoldenGate service uses this key to encrypt sensitive information (for example, password) that is provided in plain-text connection attributes through the API. This field is applicable only when doesUseSecretIds is set to false. If both vaultId and keyId are provided, the GoldenGate service uses the specified customer-managed key to encrypt the sensitive data. If neither vaultId nor keyId is provided, the GoldenGate service uses Oracle-managed encryption keys.
- Returns:
- the value
-
getNsgIds
public List<String> getNsgIds()
An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.- Returns:
- the value
-
getSubnetId
public String getSubnetId()
The OCID of the target subnet of the dedicated connection.- Returns:
- the value
-
getRoutingMethod
public RoutingMethod getRoutingMethod()
Controls the network traffic direction to the target: SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet.DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected. SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets.
Deprecated: SHARED_SERVICE_ENDPOINT is deprecated. Use another supported routingMethod value, or update existing connections to use a supported routing method. 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
-
getDoesUseSecretIds
public Boolean getDoesUseSecretIds()
Indicates that sensitive attributes are provided via Secrets.Deprecated: This field is deprecated. Sensitive attributes should be provided using the corresponding Secret OCID attributes of the connection (for example, passwordSecretId) instead of plain-text attributes. This change follows the GoldenGate "Plain Text Fields in Connections" deprecation: https://docs.oracle.com/en-us/iaas/Content/servicechanges.htm#servicechanges_topic-GoldenGate
When set to true, all sensitive information must be provided as OCI Vault secrets using the corresponding *SecretId attributes of the connection (for example, passwordSecretId). Plain-text sensitive attributes (for example, password) must not be used. This ensures that sensitive information remains stored and managed in the customer's OCI Vault rather than by the GoldenGate service.
When set to false, sensitive information must be provided in the corresponding plain-text attributes (for example, password) rather than in secret OCID attributes. In this mode, the sensitive information is stored by the GoldenGate service. If vaultId and keyId are not specified, the GoldenGate service uses Oracle-managed encryption keys to encrypt the stored data.
If vaultId and keyId are provided, the specified customer-managed key is used.
- Returns:
- the value
-
getSubscriptionId
public String getSubscriptionId()
The OCID of the subscription with which resource needs to be associated with.- Returns:
- the value
-
getClusterPlacementGroupId
public String getClusterPlacementGroupId()
The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.
- Returns:
- the value
-
getSecurityAttributes
public Map<String,Map<String,Object>> getSecurityAttributes()
Security attributes for this resource.Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toStringin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
toString
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.- Parameters:
includeByteArrayContents- true to include the full contents of byte arrays- Returns:
- string representation
-
equals
public boolean equals(Object o)
- Overrides:
equalsin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCodein classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-