# Cloud PubSub V1 Client - Class AwsKinesisFailureReason (2.19.3)

2.19.3 (latest) 2.19.2 2.18.0 2.17.0 2.16.2 2.15.1 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 AwsKinesisFailureReason.

Failure when ingesting from an AWS Kinesis source.

Generated from protobuf message `google.pubsub.v1.IngestionFailureEvent.AwsKinesisFailureReason`

## Namespace

Google \\ Cloud \\ PubSub \\ V1 \\ IngestionFailureEvent

## Methods

### __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` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.SchemaViolationReason` Optional. The Pub/Sub message failed schema validation. |
| `↳ message_transformation_failure_reason` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.MessageTransformationFailureReason` Optional. Failure encountered when applying a message transformation to the Pub/Sub message. |
| `↳ api_violation_reason` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/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. |

### 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** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.SchemaViolationReason|null` |   |

### hasSchemaViolationReason

### setSchemaViolationReason

Optional. The Pub/Sub message failed schema validation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.SchemaViolationReason` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getMessageTransformationFailureReason

Optional. Failure encountered when applying a message transformation to
the Pub/Sub message.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.MessageTransformationFailureReason|null` |   |

### hasMessageTransformationFailureReason

### setMessageTransformationFailureReason

Optional. Failure encountered when applying a message transformation to
the Pub/Sub message.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.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** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.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` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.ApiViolationReason` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getReason

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |