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 \ V1Methods
__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 |
IngestionFailureEvent\CloudStorageFailure
Optional. Failure when ingesting from Cloud Storage. |
↳ aws_msk_failure |
IngestionFailureEvent\AwsMskFailureReason
Optional. Failure when ingesting from Amazon MSK. |
↳ azure_event_hubs_failure |
IngestionFailureEvent\AzureEventHubsFailureReason
Optional. Failure when ingesting from Azure Event Hubs. |
↳ confluent_cloud_failure |
IngestionFailureEvent\ConfluentCloudFailureReason
Optional. Failure when ingesting from Confluent Cloud. |
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 |
IngestionFailureEvent\CloudStorageFailure|null |
|
hasCloudStorageFailure
setCloudStorageFailure
Optional. Failure when ingesting from Cloud Storage.
| Parameter | |
|---|---|
| Name | Description |
var |
IngestionFailureEvent\CloudStorageFailure
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAwsMskFailure
Optional. Failure when ingesting from Amazon MSK.
| Returns | |
|---|---|
| Type | Description |
IngestionFailureEvent\AwsMskFailureReason|null |
|
hasAwsMskFailure
setAwsMskFailure
Optional. Failure when ingesting from Amazon MSK.
| Parameter | |
|---|---|
| Name | Description |
var |
IngestionFailureEvent\AwsMskFailureReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAzureEventHubsFailure
Optional. Failure when ingesting from Azure Event Hubs.
| Returns | |
|---|---|
| Type | Description |
IngestionFailureEvent\AzureEventHubsFailureReason|null |
|
hasAzureEventHubsFailure
setAzureEventHubsFailure
Optional. Failure when ingesting from Azure Event Hubs.
| Parameter | |
|---|---|
| Name | Description |
var |
IngestionFailureEvent\AzureEventHubsFailureReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfluentCloudFailure
Optional. Failure when ingesting from Confluent Cloud.
| Returns | |
|---|---|
| Type | Description |
IngestionFailureEvent\ConfluentCloudFailureReason|null |
|
hasConfluentCloudFailure
setConfluentCloudFailure
Optional. Failure when ingesting from Confluent Cloud.
| Parameter | |
|---|---|
| Name | Description |
var |
IngestionFailureEvent\ConfluentCloudFailureReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFailure
| Returns | |
|---|---|
| Type | Description |
string |
|