Cloud PubSub V1 Client - Class IngestionFailureEvent (2.8.0)

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 Google\Cloud\PubSub\V1\IngestionFailureEvent\CloudStorageFailure

Optional. Failure when ingesting from Cloud Storage.

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
Google\Cloud\PubSub\V1\IngestionFailureEvent\CloudStorageFailure|null

hasCloudStorageFailure

setCloudStorageFailure

Optional. Failure when ingesting from Cloud Storage.

Parameter
Name Description
var Google\Cloud\PubSub\V1\IngestionFailureEvent\CloudStorageFailure
Returns
Type Description
$this

getFailure

Returns
Type Description
string