Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::IngestionFailureEvent::AwsKinesisFailureReason (v1.14.1)

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::IngestionFailureEvent::AwsKinesisFailureReason.

Failure when ingesting from an AWS Kinesis source.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#api_violation_reason

def api_violation_reason() -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason
Returns
  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason) — Optional. The message failed to be published due to an API violation. This is only set when the size of the data field of the Kinesis record is zero.

    Note: The following fields are mutually exclusive: api_violation_reason, schema_violation_reason, message_transformation_failure_reason. If a field in that set is populated, all other fields in the set will automatically be cleared.

#api_violation_reason=

def api_violation_reason=(value) -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason
Parameter
  • value (::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason) — Optional. The message failed to be published due to an API violation. This is only set when the size of the data field of the Kinesis record is zero.

    Note: The following fields are mutually exclusive: api_violation_reason, schema_violation_reason, message_transformation_failure_reason. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason) — Optional. The message failed to be published due to an API violation. This is only set when the size of the data field of the Kinesis record is zero.

    Note: The following fields are mutually exclusive: api_violation_reason, schema_violation_reason, message_transformation_failure_reason. If a field in that set is populated, all other fields in the set will automatically be cleared.

#message_transformation_failure_reason

def message_transformation_failure_reason() -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::MessageTransformationFailureReason
Returns

#message_transformation_failure_reason=

def message_transformation_failure_reason=(value) -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::MessageTransformationFailureReason
Parameter
Returns

#partition_key

def partition_key() -> ::String
Returns
  • (::String) — Optional. The partition key of the message that failed to be ingested.

#partition_key=

def partition_key=(value) -> ::String
Parameter
  • value (::String) — Optional. The partition key of the message that failed to be ingested.
Returns
  • (::String) — Optional. The partition key of the message that failed to be ingested.

#schema_violation_reason

def schema_violation_reason() -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason
Returns
  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason) — Optional. The Pub/Sub message failed schema validation.

    Note: The following fields are mutually exclusive: schema_violation_reason, message_transformation_failure_reason, api_violation_reason. If a field in that set is populated, all other fields in the set will automatically be cleared.

#schema_violation_reason=

def schema_violation_reason=(value) -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason
Parameter
  • value (::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason) — Optional. The Pub/Sub message failed schema validation.

    Note: The following fields are mutually exclusive: schema_violation_reason, message_transformation_failure_reason, api_violation_reason. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason) — Optional. The Pub/Sub message failed schema validation.

    Note: The following fields are mutually exclusive: schema_violation_reason, message_transformation_failure_reason, api_violation_reason. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sequence_number

def sequence_number() -> ::String
Returns
  • (::String) — Optional. The sequence number of the message that failed to be ingested.

#sequence_number=

def sequence_number=(value) -> ::String
Parameter
  • value (::String) — Optional. The sequence number of the message that failed to be ingested.
Returns
  • (::String) — Optional. The sequence number of the message that failed to be ingested.

#stream_arn

def stream_arn() -> ::String
Returns
  • (::String) — Optional. The stream ARN of the Kinesis stream being ingested from.

#stream_arn=

def stream_arn=(value) -> ::String
Parameter
  • value (::String) — Optional. The stream ARN of the Kinesis stream being ingested from.
Returns
  • (::String) — Optional. The stream ARN of the Kinesis stream being ingested from.