Reference documentation and code samples for the Cloud PubSub V1 Client class CloudStorageFailure.
Failure when ingesting from a Cloud Storage source.
Generated from protobuf message google.pubsub.v1.IngestionFailureEvent.CloudStorageFailure
Namespace
Google \ Cloud \ PubSub \ V1 \ IngestionFailureEventMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ bucket |
string
Optional. Name of the Cloud Storage bucket used for ingestion. |
↳ object_name |
string
Optional. Name of the Cloud Storage object which contained the section that couldn't be ingested. |
↳ object_generation |
int|string
Optional. Generation of the Cloud Storage object which contained the section that couldn't be ingested. |
↳ avro_failure_reason |
Google\Cloud\PubSub\V1\IngestionFailureEvent\AvroFailureReason
Optional. Failure encountered when parsing an Avro file. |
↳ api_violation_reason |
Google\Cloud\PubSub\V1\IngestionFailureEvent\ApiViolationReason
Optional. The Pub/Sub API limits prevented the desired message from being published. |
getBucket
Optional. Name of the Cloud Storage bucket used for ingestion.
| Returns | |
|---|---|
| Type | Description |
string |
|
setBucket
Optional. Name of the Cloud Storage bucket used for ingestion.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getObjectName
Optional. Name of the Cloud Storage object which contained the section that couldn't be ingested.
| Returns | |
|---|---|
| Type | Description |
string |
|
setObjectName
Optional. Name of the Cloud Storage object which contained the section that couldn't be ingested.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getObjectGeneration
Optional. Generation of the Cloud Storage object which contained the section that couldn't be ingested.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setObjectGeneration
Optional. Generation of the Cloud Storage object which contained the section that couldn't be ingested.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvroFailureReason
Optional. Failure encountered when parsing an Avro file.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\PubSub\V1\IngestionFailureEvent\AvroFailureReason|null |
|
hasAvroFailureReason
setAvroFailureReason
Optional. Failure encountered when parsing an Avro file.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\PubSub\V1\IngestionFailureEvent\AvroFailureReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApiViolationReason
Optional. The Pub/Sub API limits prevented the desired message from being published.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\PubSub\V1\IngestionFailureEvent\ApiViolationReason|null |
|
hasApiViolationReason
setApiViolationReason
Optional. The Pub/Sub API limits prevented the desired message from being published.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\PubSub\V1\IngestionFailureEvent\ApiViolationReason
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReason
| Returns | |
|---|---|
| Type | Description |
string |
|