Cloud PubSub V1 Client - Class State (2.22.1)

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

Possible states for ingestion from Amazon Kinesis Data Streams.

Protobuf type google.pubsub.v1.IngestionDataSourceSettings.AwsKinesis.State

Namespace

Google \ Cloud \ PubSub \ V1 \ IngestionDataSourceSettings \ AwsKinesis

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

STATE_UNSPECIFIED

Value: 0

Default value. This value is unused.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

ACTIVE

Value: 1

Ingestion is active.

Generated from protobuf enum ACTIVE = 1;

KINESIS_PERMISSION_DENIED

Value: 2

Permission denied encountered while consuming data from Kinesis.

This can happen if:

  • The provided aws_role_arn does not exist or does not have the appropriate permissions attached.
  • The provided aws_role_arn is not set up properly for Identity Federation using gcp_service_account.
  • The Pub/Sub SA is not granted the iam.serviceAccounts.getOpenIdToken permission on gcp_service_account.

Generated from protobuf enum KINESIS_PERMISSION_DENIED = 2;

PUBLISH_PERMISSION_DENIED

Value: 3

Permission denied encountered while publishing to the topic. This can happen if the Pub/Sub SA has not been granted the appropriate publish permissions

Generated from protobuf enum PUBLISH_PERMISSION_DENIED = 3;

STREAM_NOT_FOUND

Value: 4

The Kinesis stream does not exist.

Generated from protobuf enum STREAM_NOT_FOUND = 4;

CONSUMER_NOT_FOUND

Value: 5

The Kinesis consumer does not exist.

Generated from protobuf enum CONSUMER_NOT_FOUND = 5;

CONFLICTING_REGION_CONSTRAINTS

Value: 6

Indicates an error state where the ingestion source cannot be processed because the selected ingestion region is not permitted by the Regional Access Boundary (RAB) restrictions on the project's service account.

Generated from protobuf enum CONFLICTING_REGION_CONSTRAINTS = 6;