Cloud PubSub V1 Client - Class AwsKinesis (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 AwsKinesis.

Ingestion settings for Amazon Kinesis Data Streams.

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

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 Kinesis ingestion source.
↳ stream_arn	string Required. The Kinesis stream ARN to ingest data from.
↳ consumer_arn	string Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.
↳ aws_role_arn	string Required. AWS role ARN to be used for Federated Identity authentication with Kinesis. 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 Kinesis (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 Kinesis ingestion source.

Returns
Type	Description
int	Enum of type State.

setState

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

Parameter
Name	Description
var	int Enum of type State.

Returns
Type	Description
$this

getStreamArn

Required. The Kinesis stream ARN to ingest data from.

Returns
Type	Description
string

setStreamArn

Required. The Kinesis stream ARN to ingest data from.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getConsumerArn

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.

Returns
Type	Description
string

setConsumerArn

Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-Out mode. The consumer must be already created and ready to be used.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getAwsRoleArn

Required. AWS role ARN to be used for Federated Identity authentication with Kinesis. 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 Kinesis. 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 Kinesis (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 Kinesis (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