Reference documentation and code samples for the Cloud PubSub V1 Client class ConfluentCloud.
Ingestion settings for Confluent Cloud.
Generated from protobuf message google.pubsub.v1.IngestionDataSourceSettings.ConfluentCloud
Namespace
Google \ Cloud \ PubSub \ V1 \ IngestionDataSourceSettingsMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ state |
int
Output only. An output-only field that indicates the state of the Confluent Cloud ingestion source. |
↳ bootstrap_server |
string
Required. The address of the bootstrap server. The format is url:port. |
↳ cluster_id |
string
Required. The id of the cluster. |
↳ topic |
string
Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub will import from. |
↳ identity_pool_id |
string
Required. The id of the identity pool to be used for Federated Identity authentication with Confluent Cloud. See https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools. |
↳ gcp_service_account |
string
Required. The GCP service account to be used for Federated Identity authentication with |
getState
Output only. An output-only field that indicates the state of the Confluent Cloud ingestion source.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. An output-only field that indicates the state of the Confluent Cloud ingestion source.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBootstrapServer
Required. The address of the bootstrap server. The format is url:port.
| Returns | |
|---|---|
| Type | Description |
string |
|
setBootstrapServer
Required. The address of the bootstrap server. The format is url:port.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getClusterId
Required. The id of the cluster.
| Returns | |
|---|---|
| Type | Description |
string |
|
setClusterId
Required. The id of the cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTopic
Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub will import from.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTopic
Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub will import from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIdentityPoolId
Required. The id of the identity pool to be used for Federated Identity authentication with Confluent Cloud. See https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
| Returns | |
|---|---|
| Type | Description |
string |
|
setIdentityPoolId
Required. The id of the identity pool to be used for Federated Identity authentication with Confluent Cloud. See https://docs.confluent.io/cloud/current/security/authenticate/workload-identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-pools.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGcpServiceAccount
Required. The GCP service account to be used for Federated Identity
authentication with identity_pool_id.
| Returns | |
|---|---|
| Type | Description |
string |
|
setGcpServiceAccount
Required. The GCP service account to be used for Federated Identity
authentication with identity_pool_id.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|