# Cloud PubSub V1 Client - Class IngestionFailureEvent (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 IngestionFailureEvent.

Payload of the Platform Log entry sent when a failure is encountered while
ingesting.

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

## Namespace

Google \\ Cloud \\ PubSub \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ topic` | `string` Required. Name of the import topic. Format is: projects/{project_name}/topics/{topic_name}. |
| `↳ error_message` | `string` Required. Error details explaining why ingestion to Pub/Sub has failed. |
| `↳ cloud_storage_failure` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.CloudStorageFailure` Optional. Failure when ingesting from Cloud Storage. |
| `↳ aws_msk_failure` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.AwsMskFailureReason` Optional. Failure when ingesting from Amazon MSK. |
| `↳ azure_event_hubs_failure` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.AzureEventHubsFailureReason` Optional. Failure when ingesting from Azure Event Hubs. |
| `↳ confluent_cloud_failure` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.ConfluentCloudFailureReason` Optional. Failure when ingesting from Confluent Cloud. |
| `↳ aws_kinesis_failure` | `https://docs.cloud.google.com/php/docs/reference/cloud-pubsub/latest/V1.IngestionFailureEvent.AwsKinesisFailureReason` Optional. Failure when ingesting from AWS Kinesis. |

### getTopic

Required. Name of the import topic. Format is:
projects/{project_name}/topics/{topic_name}.

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

### setTopic

Required. Name of the import topic. Format is:
projects/{project_name}/topics/{topic_name}.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getErrorMessage

Required. Error details explaining why ingestion to Pub/Sub has failed.

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

### setErrorMessage

Required. Error details explaining why ingestion to Pub/Sub has failed.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getCloudStorageFailure

Optional. Failure when ingesting from Cloud Storage.

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

### hasCloudStorageFailure

### setCloudStorageFailure

Optional. Failure when ingesting from Cloud Storage.

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

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

### getAwsMskFailure

Optional. Failure when ingesting from Amazon MSK.

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

### hasAwsMskFailure

### setAwsMskFailure

Optional. Failure when ingesting from Amazon MSK.

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

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

### getAzureEventHubsFailure

Optional. Failure when ingesting from Azure Event Hubs.

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

### hasAzureEventHubsFailure

### setAzureEventHubsFailure

Optional. Failure when ingesting from Azure Event Hubs.

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

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

### getConfluentCloudFailure

Optional. Failure when ingesting from Confluent Cloud.

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

### hasConfluentCloudFailure

### setConfluentCloudFailure

Optional. Failure when ingesting from Confluent Cloud.

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

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

### getAwsKinesisFailure

Optional. Failure when ingesting from AWS Kinesis.

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

### hasAwsKinesisFailure

### setAwsKinesisFailure

Optional. Failure when ingesting from AWS Kinesis.

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

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

### getFailure

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