Google Cloud Datastream V1 Client - Class ConnectionProfile (2.7.0)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class ConnectionProfile.

A set of reusable connection configurations to be used as a source or destination for a stream.

Generated from protobuf message google.cloud.datastream.v1.ConnectionProfile

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Identifier. The resource's name.

↳ create_time Google\Protobuf\Timestamp

Output only. The create time of the resource.

↳ update_time Google\Protobuf\Timestamp

Output only. The update time of the resource.

↳ labels array|Google\Protobuf\Internal\MapField

Labels.

↳ display_name string

Required. Display name.

↳ satisfies_pzs bool

Output only. Reserved for future use.

↳ satisfies_pzi bool

Output only. Reserved for future use.

↳ oracle_profile OracleProfile

Profile for connecting to an Oracle source.

↳ gcs_profile GcsProfile

Profile for connecting to a Cloud Storage destination.

↳ mysql_profile MysqlProfile

Profile for connecting to a MySQL source.

↳ bigquery_profile BigQueryProfile

Profile for connecting to a BigQuery destination.

↳ postgresql_profile PostgresqlProfile

Profile for connecting to a PostgreSQL source.

↳ sql_server_profile SqlServerProfile

Profile for connecting to a SQLServer source.

↳ salesforce_profile SalesforceProfile

Profile for connecting to a Salesforce source.

↳ mongodb_profile MongodbProfile

Profile for connecting to a MongoDB source.

↳ spanner_profile SpannerProfile

Profile for connecting to a Spanner source.

↳ dataverse_profile DataverseProfile

Profile for connecting to a Dataverse source.

↳ salesforce_marketing_cloud_profile SalesforceMarketingCloudProfile

Profile for connecting to a Salesforce Marketing Cloud source.

↳ service_now_profile ServiceNowProfile

Profile for connecting to a ServiceNow source.

↳ workday_profile WorkdayProfile

Optional. Profile for connecting to a Workday source.

↳ static_service_ip_connectivity StaticServiceIpConnectivity

Static Service IP connectivity.

↳ forward_ssh_connectivity ForwardSshTunnelConnectivity

Forward SSH tunnel connectivity.

↳ private_connectivity PrivateConnectivity

Private connectivity.

getName

Output only. Identifier. The resource's name.

Returns
Type Description
string

setName

Output only. Identifier. The resource's name.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The create time of the resource.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The create time of the resource.

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

getUpdateTime

Output only. The update time of the resource.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update time of the resource.

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

getLabels

Labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDisplayName

Required. Display name.

Returns
Type Description
string

setDisplayName

Required. Display name.

Parameter
Name Description
var string
Returns
Type Description
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type Description
bool

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSatisfiesPzi

Output only. Reserved for future use.

Returns
Type Description
bool

hasSatisfiesPzi

clearSatisfiesPzi

setSatisfiesPzi

Output only. Reserved for future use.

Parameter
Name Description
var bool
Returns
Type Description
$this

getOracleProfile

Profile for connecting to an Oracle source.

Returns
Type Description
OracleProfile|null

hasOracleProfile

setOracleProfile

Profile for connecting to an Oracle source.

Parameter
Name Description
var OracleProfile
Returns
Type Description
$this

getGcsProfile

Profile for connecting to a Cloud Storage destination.

Returns
Type Description
GcsProfile|null

hasGcsProfile

setGcsProfile

Profile for connecting to a Cloud Storage destination.

Parameter
Name Description
var GcsProfile
Returns
Type Description
$this

getMysqlProfile

Profile for connecting to a MySQL source.

Returns
Type Description
MysqlProfile|null

hasMysqlProfile

setMysqlProfile

Profile for connecting to a MySQL source.

Parameter
Name Description
var MysqlProfile
Returns
Type Description
$this

getBigqueryProfile

Profile for connecting to a BigQuery destination.

Returns
Type Description
BigQueryProfile|null

hasBigqueryProfile

setBigqueryProfile

Profile for connecting to a BigQuery destination.

Parameter
Name Description
var BigQueryProfile
Returns
Type Description
$this

getPostgresqlProfile

Profile for connecting to a PostgreSQL source.

Returns
Type Description
PostgresqlProfile|null

hasPostgresqlProfile

setPostgresqlProfile

Profile for connecting to a PostgreSQL source.

Parameter
Name Description
var PostgresqlProfile
Returns
Type Description
$this

getSqlServerProfile

Profile for connecting to a SQLServer source.

Returns
Type Description
SqlServerProfile|null

hasSqlServerProfile

setSqlServerProfile

Profile for connecting to a SQLServer source.

Parameter
Name Description
var SqlServerProfile
Returns
Type Description
$this

getSalesforceProfile

Profile for connecting to a Salesforce source.

Returns
Type Description
SalesforceProfile|null

hasSalesforceProfile

setSalesforceProfile

Profile for connecting to a Salesforce source.

Parameter
Name Description
var SalesforceProfile
Returns
Type Description
$this

getMongodbProfile

Profile for connecting to a MongoDB source.

Returns
Type Description
MongodbProfile|null

hasMongodbProfile

setMongodbProfile

Profile for connecting to a MongoDB source.

Parameter
Name Description
var MongodbProfile
Returns
Type Description
$this

getSpannerProfile

Profile for connecting to a Spanner source.

Returns
Type Description
SpannerProfile|null

hasSpannerProfile

setSpannerProfile

Profile for connecting to a Spanner source.

Parameter
Name Description
var SpannerProfile
Returns
Type Description
$this

getDataverseProfile

Profile for connecting to a Dataverse source.

Returns
Type Description
DataverseProfile|null

hasDataverseProfile

setDataverseProfile

Profile for connecting to a Dataverse source.

Parameter
Name Description
var DataverseProfile
Returns
Type Description
$this

getSalesforceMarketingCloudProfile

Profile for connecting to a Salesforce Marketing Cloud source.

Returns
Type Description
SalesforceMarketingCloudProfile|null

hasSalesforceMarketingCloudProfile

setSalesforceMarketingCloudProfile

Profile for connecting to a Salesforce Marketing Cloud source.

Parameter
Name Description
var SalesforceMarketingCloudProfile
Returns
Type Description
$this

getServiceNowProfile

Profile for connecting to a ServiceNow source.

Returns
Type Description
ServiceNowProfile|null

hasServiceNowProfile

setServiceNowProfile

Profile for connecting to a ServiceNow source.

Parameter
Name Description
var ServiceNowProfile
Returns
Type Description
$this

getWorkdayProfile

Optional. Profile for connecting to a Workday source.

Returns
Type Description
WorkdayProfile|null

hasWorkdayProfile

setWorkdayProfile

Optional. Profile for connecting to a Workday source.

Parameter
Name Description
var WorkdayProfile
Returns
Type Description
$this

getStaticServiceIpConnectivity

Static Service IP connectivity.

Returns
Type Description
StaticServiceIpConnectivity|null

hasStaticServiceIpConnectivity

setStaticServiceIpConnectivity

Static Service IP connectivity.

Parameter
Name Description
var StaticServiceIpConnectivity
Returns
Type Description
$this

getForwardSshConnectivity

Forward SSH tunnel connectivity.

Returns
Type Description
ForwardSshTunnelConnectivity|null

hasForwardSshConnectivity

setForwardSshConnectivity

Forward SSH tunnel connectivity.

Parameter
Name Description
var ForwardSshTunnelConnectivity
Returns
Type Description
$this

getPrivateConnectivity

Private connectivity.

Returns
Type Description
PrivateConnectivity|null

hasPrivateConnectivity

setPrivateConnectivity

Private connectivity.

Parameter
Name Description
var PrivateConnectivity
Returns
Type Description
$this

getProfile

Returns
Type Description
string

getConnectivity

Returns
Type Description
string