Google Cloud Oracle Database V1 Client - Class GoldengateConnectionProperties (0.9.0)

Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class GoldengateConnectionProperties.

The properties of a GoldengateConnection.

Generated from protobuf message google.cloud.oracledatabase.v1.GoldengateConnectionProperties

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ oracle_connection_properties GoldengateOracleConnectionProperties

Properties for an Oracle Database Connection.
↳ goldengate_connection_properties GoldengateGoldengateConnectionProperties

Properties for a Goldengate Connection.
↳ generic_connection_properties GoldengateGenericConnectionProperties

Properties for a Generic Connection.
↳ google_cloud_storage_connection_properties GoldengateGoogleCloudStorageConnectionProperties

Properties for a Google Cloud Storage Connection.
↳ google_big_query_connection_properties GoldengateGoogleBigQueryConnectionProperties

Properties for a Google BigQuery Connection.
↳ mysql_connection_properties GoldengateMysqlConnectionProperties

Properties for a Mysql Connection.
↳ kafka_connection_properties GoldengateKafkaConnectionProperties

Properties for a Kafka Connection.
↳ kafka_schema_registry_connection_properties GoldengateKafkaSchemaRegistryConnectionProperties

Properties for a Kafka Schema Registry Connection.
↳ oci_object_storage_connection_properties GoldengateOciObjectStorageConnectionProperties

Properties for an OCI Object Storage Connection.
↳ azure_data_lake_storage_connection_properties GoldengateAzureDataLakeStorageConnectionProperties

Properties for an Azure Data Lake Storage Connection.
↳ azure_synapse_analytics_connection_properties GoldengateAzureSynapseAnalyticsConnectionProperties

Properties for an Azure Synapse Analytics connection.
↳ postgresql_connection_properties GoldengatePostgresqlConnectionProperties

Properties for a PostgreSQL connection.
↳ microsoft_sqlserver_connection_properties GoldengateMicrosoftSqlserverConnectionProperties

Properties for a Microsoft SQL Server connection.
↳ amazon_s3_connection_properties GoldengateAmazonS3ConnectionProperties

Properties for an Amazon S3 connection.
↳ hdfs_connection_properties GoldengateHdfsConnectionProperties

Properties for an HDFS connection.
↳ java_message_service_connection_properties GoldengateJavaMessageServiceConnectionProperties

Properties for a Java Message Service connection.
↳ mongodb_connection_properties GoldengateMongodbConnectionProperties

Properties for a MongoDB connection.
↳ oracle_nosql_connection_properties GoldengateOracleNosqlConnectionProperties

Properties for an Oracle NoSQL connection.
↳ snowflake_connection_properties GoldengateSnowflakeConnectionProperties

Properties for a Snowflake connection.
↳ amazon_redshift_connection_properties GoldengateAmazonRedshiftConnectionProperties

Properties for an Amazon Redshift connection.
↳ elasticsearch_connection_properties GoldengateElasticsearchConnectionProperties

Properties for an Elasticsearch connection.
↳ amazon_kinesis_connection_properties GoldengateAmazonKinesisConnectionProperties

Properties for an Amazon Kinesis connection.
↳ db2_connection_properties GoldengateDb2ConnectionProperties

Properties for a DB2 connection.
↳ redis_connection_properties GoldengateRedisConnectionProperties

Properties for a Redis connection.
↳ databricks_connection_properties GoldengateDatabricksConnectionProperties

Properties for a Databricks connection.
↳ google_pubsub_connection_properties GoldengateGooglePubsubConnectionProperties

Properties for a Google Pub/Sub connection.
↳ microsoft_fabric_connection_properties GoldengateMicrosoftFabricConnectionProperties

Properties for a Microsoft Fabric connection.
↳ oracle_ai_data_platform_connection_properties GoldengateOracleAIDataPlatformConnectionProperties

Properties for an Oracle AI Data Platform connection.
↳ iceberg_connection_properties GoldengateIcebergConnectionProperties

Properties for an Iceberg connection.
↳ connection_type int

Required. The connection type.
↳ ocid string

Output only. The [OCID] of the connection being referenced.
↳ display_name string

Required. An object's Display Name.
↳ description string

Optional. Metadata about this specific object.
↳ lifecycle_state int

Output only. The lifecycle state of the connection.
↳ lifecycle_details string

Output only. Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
↳ update_time Google\Protobuf\Timestamp

Output only. The time the resource was last updated.
↳ routing_method int

Optional. The routing method for the GoldengateConnection.
↳ ingress_ip_addresses string[]

Output only. The Ingress IPs of the GoldengateConnection.

getOracleConnectionProperties

Properties for an Oracle Database Connection.

Returns
Type Description
GoldengateOracleConnectionProperties|null

hasOracleConnectionProperties

setOracleConnectionProperties

Properties for an Oracle Database Connection.

Parameter
Name Description
var GoldengateOracleConnectionProperties
Returns
Type Description
$this

getGoldengateConnectionProperties

Properties for a Goldengate Connection.

Returns
Type Description
GoldengateGoldengateConnectionProperties|null

hasGoldengateConnectionProperties

setGoldengateConnectionProperties

Properties for a Goldengate Connection.

Parameter
Name Description
var GoldengateGoldengateConnectionProperties
Returns
Type Description
$this

getGenericConnectionProperties

Properties for a Generic Connection.

Returns
Type Description
GoldengateGenericConnectionProperties|null

hasGenericConnectionProperties

setGenericConnectionProperties

Properties for a Generic Connection.

Parameter
Name Description
var GoldengateGenericConnectionProperties
Returns
Type Description
$this

getGoogleCloudStorageConnectionProperties

Properties for a Google Cloud Storage Connection.

Returns
Type Description
GoldengateGoogleCloudStorageConnectionProperties|null

hasGoogleCloudStorageConnectionProperties

setGoogleCloudStorageConnectionProperties

Properties for a Google Cloud Storage Connection.

Parameter
Name Description
var GoldengateGoogleCloudStorageConnectionProperties
Returns
Type Description
$this

getGoogleBigQueryConnectionProperties

Properties for a Google BigQuery Connection.

Returns
Type Description
GoldengateGoogleBigQueryConnectionProperties|null

hasGoogleBigQueryConnectionProperties

setGoogleBigQueryConnectionProperties

Properties for a Google BigQuery Connection.

Parameter
Name Description
var GoldengateGoogleBigQueryConnectionProperties
Returns
Type Description
$this

getMysqlConnectionProperties

Properties for a Mysql Connection.

Returns
Type Description
GoldengateMysqlConnectionProperties|null

hasMysqlConnectionProperties

setMysqlConnectionProperties

Properties for a Mysql Connection.

Parameter
Name Description
var GoldengateMysqlConnectionProperties
Returns
Type Description
$this

getKafkaConnectionProperties

Properties for a Kafka Connection.

Returns
Type Description
GoldengateKafkaConnectionProperties|null

hasKafkaConnectionProperties

setKafkaConnectionProperties

Properties for a Kafka Connection.

Parameter
Name Description
var GoldengateKafkaConnectionProperties
Returns
Type Description
$this

getKafkaSchemaRegistryConnectionProperties

Properties for a Kafka Schema Registry Connection.

Returns
Type Description
GoldengateKafkaSchemaRegistryConnectionProperties|null

hasKafkaSchemaRegistryConnectionProperties

setKafkaSchemaRegistryConnectionProperties

Properties for a Kafka Schema Registry Connection.

Parameter
Name Description
var GoldengateKafkaSchemaRegistryConnectionProperties
Returns
Type Description
$this

getOciObjectStorageConnectionProperties

Properties for an OCI Object Storage Connection.

Returns
Type Description
GoldengateOciObjectStorageConnectionProperties|null

hasOciObjectStorageConnectionProperties

setOciObjectStorageConnectionProperties

Properties for an OCI Object Storage Connection.

Parameter
Name Description
var GoldengateOciObjectStorageConnectionProperties
Returns
Type Description
$this

getAzureDataLakeStorageConnectionProperties

Properties for an Azure Data Lake Storage Connection.

Returns
Type Description
GoldengateAzureDataLakeStorageConnectionProperties|null

hasAzureDataLakeStorageConnectionProperties

setAzureDataLakeStorageConnectionProperties

Properties for an Azure Data Lake Storage Connection.

Parameter
Name Description
var GoldengateAzureDataLakeStorageConnectionProperties
Returns
Type Description
$this

getAzureSynapseAnalyticsConnectionProperties

Properties for an Azure Synapse Analytics connection.

Returns
Type Description
GoldengateAzureSynapseAnalyticsConnectionProperties|null

hasAzureSynapseAnalyticsConnectionProperties

setAzureSynapseAnalyticsConnectionProperties

Properties for an Azure Synapse Analytics connection.

Parameter
Name Description
var GoldengateAzureSynapseAnalyticsConnectionProperties
Returns
Type Description
$this

getPostgresqlConnectionProperties

Properties for a PostgreSQL connection.

Returns
Type Description
GoldengatePostgresqlConnectionProperties|null

hasPostgresqlConnectionProperties

setPostgresqlConnectionProperties

Properties for a PostgreSQL connection.

Parameter
Name Description
var GoldengatePostgresqlConnectionProperties
Returns
Type Description
$this

getMicrosoftSqlserverConnectionProperties

Properties for a Microsoft SQL Server connection.

Returns
Type Description
GoldengateMicrosoftSqlserverConnectionProperties|null

hasMicrosoftSqlserverConnectionProperties

setMicrosoftSqlserverConnectionProperties

Properties for a Microsoft SQL Server connection.

Parameter
Name Description
var GoldengateMicrosoftSqlserverConnectionProperties
Returns
Type Description
$this

getAmazonS3ConnectionProperties

Properties for an Amazon S3 connection.

Returns
Type Description
GoldengateAmazonS3ConnectionProperties|null

hasAmazonS3ConnectionProperties

setAmazonS3ConnectionProperties

Properties for an Amazon S3 connection.

Parameter
Name Description
var GoldengateAmazonS3ConnectionProperties
Returns
Type Description
$this

getHdfsConnectionProperties

Properties for an HDFS connection.

Returns
Type Description
GoldengateHdfsConnectionProperties|null

hasHdfsConnectionProperties

setHdfsConnectionProperties

Properties for an HDFS connection.

Parameter
Name Description
var GoldengateHdfsConnectionProperties
Returns
Type Description
$this

getJavaMessageServiceConnectionProperties

Properties for a Java Message Service connection.

Returns
Type Description
GoldengateJavaMessageServiceConnectionProperties|null

hasJavaMessageServiceConnectionProperties

setJavaMessageServiceConnectionProperties

Properties for a Java Message Service connection.

Parameter
Name Description
var GoldengateJavaMessageServiceConnectionProperties
Returns
Type Description
$this

getMongodbConnectionProperties

Properties for a MongoDB connection.

Returns
Type Description
GoldengateMongodbConnectionProperties|null

hasMongodbConnectionProperties

setMongodbConnectionProperties

Properties for a MongoDB connection.

Parameter
Name Description
var GoldengateMongodbConnectionProperties
Returns
Type Description
$this

getOracleNosqlConnectionProperties

Properties for an Oracle NoSQL connection.

Returns
Type Description
GoldengateOracleNosqlConnectionProperties|null

hasOracleNosqlConnectionProperties

setOracleNosqlConnectionProperties

Properties for an Oracle NoSQL connection.

Parameter
Name Description
var GoldengateOracleNosqlConnectionProperties
Returns
Type Description
$this

getSnowflakeConnectionProperties

Properties for a Snowflake connection.

Returns
Type Description
GoldengateSnowflakeConnectionProperties|null

hasSnowflakeConnectionProperties

setSnowflakeConnectionProperties

Properties for a Snowflake connection.

Parameter
Name Description
var GoldengateSnowflakeConnectionProperties
Returns
Type Description
$this

getAmazonRedshiftConnectionProperties

Properties for an Amazon Redshift connection.

Returns
Type Description
GoldengateAmazonRedshiftConnectionProperties|null

hasAmazonRedshiftConnectionProperties

setAmazonRedshiftConnectionProperties

Properties for an Amazon Redshift connection.

Parameter
Name Description
var GoldengateAmazonRedshiftConnectionProperties
Returns
Type Description
$this

getElasticsearchConnectionProperties

Properties for an Elasticsearch connection.

Returns
Type Description
GoldengateElasticsearchConnectionProperties|null

hasElasticsearchConnectionProperties

setElasticsearchConnectionProperties

Properties for an Elasticsearch connection.

Parameter
Name Description
var GoldengateElasticsearchConnectionProperties
Returns
Type Description
$this

getAmazonKinesisConnectionProperties

Properties for an Amazon Kinesis connection.

Returns
Type Description
GoldengateAmazonKinesisConnectionProperties|null

hasAmazonKinesisConnectionProperties

setAmazonKinesisConnectionProperties

Properties for an Amazon Kinesis connection.

Parameter
Name Description
var GoldengateAmazonKinesisConnectionProperties
Returns
Type Description
$this

getDb2ConnectionProperties

Properties for a DB2 connection.

Returns
Type Description
GoldengateDb2ConnectionProperties|null

hasDb2ConnectionProperties

setDb2ConnectionProperties

Properties for a DB2 connection.

Parameter
Name Description
var GoldengateDb2ConnectionProperties
Returns
Type Description
$this

getRedisConnectionProperties

Properties for a Redis connection.

Returns
Type Description
GoldengateRedisConnectionProperties|null

hasRedisConnectionProperties

setRedisConnectionProperties

Properties for a Redis connection.

Parameter
Name Description
var GoldengateRedisConnectionProperties
Returns
Type Description
$this

getDatabricksConnectionProperties

Properties for a Databricks connection.

Returns
Type Description
GoldengateDatabricksConnectionProperties|null

hasDatabricksConnectionProperties

setDatabricksConnectionProperties

Properties for a Databricks connection.

Parameter
Name Description
var GoldengateDatabricksConnectionProperties
Returns
Type Description
$this

getGooglePubsubConnectionProperties

Properties for a Google Pub/Sub connection.

Returns
Type Description
GoldengateGooglePubsubConnectionProperties|null

hasGooglePubsubConnectionProperties

setGooglePubsubConnectionProperties

Properties for a Google Pub/Sub connection.

Parameter
Name Description
var GoldengateGooglePubsubConnectionProperties
Returns
Type Description
$this

getMicrosoftFabricConnectionProperties

Properties for a Microsoft Fabric connection.

Returns
Type Description
GoldengateMicrosoftFabricConnectionProperties|null

hasMicrosoftFabricConnectionProperties

setMicrosoftFabricConnectionProperties

Properties for a Microsoft Fabric connection.

Parameter
Name Description
var GoldengateMicrosoftFabricConnectionProperties
Returns
Type Description
$this

getOracleAiDataPlatformConnectionProperties

Properties for an Oracle AI Data Platform connection.

Returns
Type Description
GoldengateOracleAIDataPlatformConnectionProperties|null

hasOracleAiDataPlatformConnectionProperties

setOracleAiDataPlatformConnectionProperties

Properties for an Oracle AI Data Platform connection.

Parameter
Name Description
var GoldengateOracleAIDataPlatformConnectionProperties
Returns
Type Description
$this

getIcebergConnectionProperties

Properties for an Iceberg connection.

Returns
Type Description
GoldengateIcebergConnectionProperties|null

hasIcebergConnectionProperties

setIcebergConnectionProperties

Properties for an Iceberg connection.

Parameter
Name Description
var GoldengateIcebergConnectionProperties
Returns
Type Description
$this

getConnectionType

Required. The connection type.

Returns
Type Description
int Enum of type GoldengateConnectionType.

setConnectionType

Required. The connection type.

Parameter
Name Description
var int

Enum of type GoldengateConnectionType.

Returns
Type Description
$this

getOcid

Output only. The [OCID] of the connection being referenced.

Returns
Type Description
string

setOcid

Output only. The [OCID] of the connection being referenced.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. An object's Display Name.

Returns
Type Description
string

setDisplayName

Required. An object's Display Name.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. Metadata about this specific object.

Returns
Type Description
string

setDescription

Optional. Metadata about this specific object.

Parameter
Name Description
var string
Returns
Type Description
$this

getLifecycleState

Output only. The lifecycle state of the connection.

Returns
Type Description
int Enum of type GoldengateConnectionLifecycleState.

setLifecycleState

Output only. The lifecycle state of the connection.

Parameter
Name Description
var int

Enum of type GoldengateConnectionLifecycleState.

Returns
Type Description
$this

getLifecycleDetails

Output only. Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns
Type Description
string

setLifecycleDetails

Output only. Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Parameter
Name Description
var string
Returns
Type Description
$this

getUpdateTime

Output only. The time the resource was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the resource was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRoutingMethod

Optional. The routing method for the GoldengateConnection.

Returns
Type Description
int Enum of type GoldengateConnectionRoutingMethod.

setRoutingMethod

Optional. The routing method for the GoldengateConnection.

Parameter
Name Description
var int

Enum of type GoldengateConnectionRoutingMethod.

Returns
Type Description
$this

getIngressIpAddresses

Output only. The Ingress IPs of the GoldengateConnection.

Returns
Type Description
Google\Protobuf\RepeatedField<string>

setIngressIpAddresses

Output only. The Ingress IPs of the GoldengateConnection.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getConnectionDetails

Returns
Type Description
string