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 \ 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 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 |
getState
Output only. An output-only field that indicates the state of the Kinesis ingestion source.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. An output-only field that indicates the state of the Kinesis ingestion source.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 |
|