Cloud PubSub V1 Client - Class AwsMsk (2.15.1)

Version latest

• 2.15.1 (latest)
• 2.15.0
• 2.14.0
• 2.13.2
• 2.12.0
• 2.11.3
• 2.10.1
• 2.9.1
• 2.8.2
• 2.7.0
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.2
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.5
• 1.45.2
• 1.44.0
• 1.43.2
• 1.42.1
• 1.41.3
• 1.40.1
• 1.39.3

Reference documentation and code samples for the Cloud PubSub V1 Client class AwsMsk.

Ingestion settings for Amazon MSK.

Generated from protobuf message google.pubsub.v1.IngestionDataSourceSettings.AwsMsk

Namespace

Google \ Cloud \ PubSub \ V1 \ IngestionDataSourceSettings

Methods

__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 Amazon MSK ingestion source.
↳ cluster_arn	string Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.
↳ topic	string Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.
↳ aws_role_arn	string Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.
↳ gcp_service_account	string Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

getState

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

Returns
Type	Description
int	Enum of type State.

setState

Output only. An output-only field that indicates the state of the Amazon MSK ingestion source.

Parameter
Name	Description
var	int Enum of type State.

Returns
Type	Description
$this

getClusterArn

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Returns
Type	Description
string

setClusterArn

Required. The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTopic

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

Returns
Type	Description
string

setTopic

Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will import from.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAwsRoleArn

Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

Returns
Type	Description
string

setAwsRoleArn

Required. AWS role ARN to be used for Federated Identity authentication with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the required permissions that need to be attached to it.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGcpServiceAccount

Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

Returns
Type	Description
string

setGcpServiceAccount

Required. The GCP service account to be used for Federated Identity authentication with Amazon MSK (via a AssumeRoleWithWebIdentity call for the provided role). The aws_role_arn must be set up with accounts.google.com:sub equals to this service account number.

Parameter
Name	Description
var	string

Returns
Type	Description
$this