Reference documentation and code samples for the Cloud PubSub V1 Client class AwsKinesisFailureReason.
Failure when ingesting from an AWS Kinesis source.
Generated from protobuf message google.pubsub.v1.IngestionFailureEvent.AwsKinesisFailureReason
Namespace
Google \ Cloud \ PubSub \ V1 \ IngestionFailureEventMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ stream_arn |
string
Optional. The stream ARN of the Kinesis stream being ingested from. |
↳ partition_key |
string
Optional. The partition key of the message that failed to be ingested. |
↳ sequence_number |
string
Optional. The sequence number of the message that failed to be ingested. |
↳ schema_violation_reason |
SchemaViolationReason
Optional. The Pub/Sub message failed schema validation. |
↳ message_transformation_failure_reason |
MessageTransformationFailureReason
Optional. Failure encountered when applying a message transformation to the Pub/Sub message. |
↳ api_violation_reason |
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. |
getStreamArn
Optional. The stream ARN of the Kinesis stream being ingested from.
| Returns | |
|---|---|
| Type | Description |
string |
|
setStreamArn
Optional. The stream ARN of the Kinesis stream being ingested from.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPartitionKey
Optional. The partition key of the message that failed to be ingested.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPartitionKey
Optional. The partition key of the message that failed to be ingested.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSequenceNumber
Optional. The sequence number of the message that failed to be ingested.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSequenceNumber
Optional. The sequence number of the message that failed to be ingested.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchemaViolationReason
Optional. The Pub/Sub message failed schema validation.
| Returns | |
|---|---|
| Type | Description |
SchemaViolationReason|null |
|
hasSchemaViolationReason
setSchemaViolationReason
Optional. The Pub/Sub message failed schema validation.
| Parameter | |
|---|---|
| Name | Description |
var |
SchemaViolationReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessageTransformationFailureReason
Optional. Failure encountered when applying a message transformation to the Pub/Sub message.
| Returns | |
|---|---|
| Type | Description |
MessageTransformationFailureReason|null |
|
hasMessageTransformationFailureReason
setMessageTransformationFailureReason
Optional. Failure encountered when applying a message transformation to the Pub/Sub message.
| Parameter | |
|---|---|
| Name | Description |
var |
MessageTransformationFailureReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApiViolationReason
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.
| Returns | |
|---|---|
| Type | Description |
ApiViolationReason|null |
|
hasApiViolationReason
setApiViolationReason
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.
| Parameter | |
|---|---|
| Name | Description |
var |
ApiViolationReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReason
| Returns | |
|---|---|
| Type | Description |
string |
|