# Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::IngestionFailureEvent::CloudStorageFailure (v1.16.0)

1.16.0 (latest) 1.15.0 1.14.2 1.13.0 1.12.0 1.11.1 1.10.0 1.9.0 1.8.2 1.7.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.2 1.0.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.2 0.20.2 0.19.0 0.18.1 0.17.4 0.16.0 0.15.1 0.14.0 0.13.1 0.12.1 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 0.6.2 Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::IngestionFailureEvent::CloudStorageFailure.

Failure when ingesting from a Cloud Storage source.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #api_violation_reason

    def api_violation_reason() -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason

**Returns**

- ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-ApiViolationReason)) --- Optional. The Pub/Sub API limits prevented the desired message from being published.


  Note: The following fields are mutually exclusive: `api_violation_reason`, `avro_failure_reason`, `schema_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #api_violation_reason=

    def api_violation_reason=(value) -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason

**Parameter**

- **value** ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-ApiViolationReason)) --- Optional. The Pub/Sub API limits prevented the desired message from being published.


  Note: The following fields are mutually exclusive: `api_violation_reason`, `avro_failure_reason`, `schema_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-ApiViolationReason)) --- Optional. The Pub/Sub API limits prevented the desired message from being published.


  Note: The following fields are mutually exclusive: `api_violation_reason`, `avro_failure_reason`, `schema_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #avro_failure_reason

    def avro_failure_reason() -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::AvroFailureReason

**Returns**

- ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::AvroFailureReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-AvroFailureReason)) --- Optional. Failure encountered when parsing an Avro file.


  Note: The following fields are mutually exclusive: `avro_failure_reason`, `api_violation_reason`, `schema_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #avro_failure_reason=

    def avro_failure_reason=(value) -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::AvroFailureReason

**Parameter**

- **value** ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::AvroFailureReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-AvroFailureReason)) --- Optional. Failure encountered when parsing an Avro file.


  Note: The following fields are mutually exclusive: `avro_failure_reason`, `api_violation_reason`, `schema_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::AvroFailureReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-AvroFailureReason)) --- Optional. Failure encountered when parsing an Avro file.


  Note: The following fields are mutually exclusive: `avro_failure_reason`, `api_violation_reason`, `schema_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #bucket

    def bucket() -> ::String

**Returns**

- (::String) --- Optional. Name of the Cloud Storage bucket used for ingestion.

### #bucket=

    def bucket=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Name of the Cloud Storage bucket used for ingestion.
**Returns**

- (::String) --- Optional. Name of the Cloud Storage bucket used for ingestion.

### #message_transformation_failure_reason

    def message_transformation_failure_reason() -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::MessageTransformationFailureReason

**Returns**

- ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::MessageTransformationFailureReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-MessageTransformationFailureReason)) --- Optional. Failure encountered when applying a message transformation to the Pub/Sub message.


  Note: The following fields are mutually exclusive: `message_transformation_failure_reason`, `avro_failure_reason`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #message_transformation_failure_reason=

    def message_transformation_failure_reason=(value) -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::MessageTransformationFailureReason

**Parameter**

- **value** ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::MessageTransformationFailureReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-MessageTransformationFailureReason)) --- Optional. Failure encountered when applying a message transformation to the Pub/Sub message.


  Note: The following fields are mutually exclusive: `message_transformation_failure_reason`, `avro_failure_reason`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::MessageTransformationFailureReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-MessageTransformationFailureReason)) --- Optional. Failure encountered when applying a message transformation to the Pub/Sub message.


  Note: The following fields are mutually exclusive: `message_transformation_failure_reason`, `avro_failure_reason`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #object_generation

    def object_generation() -> ::Integer

**Returns**

- (::Integer) --- Optional. Generation of the Cloud Storage object which contained the section that couldn't be ingested.

### #object_generation=

    def object_generation=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Optional. Generation of the Cloud Storage object which contained the section that couldn't be ingested.
**Returns**

- (::Integer) --- Optional. Generation of the Cloud Storage object which contained the section that couldn't be ingested.

### #object_name

    def object_name() -> ::String

**Returns**

- (::String) --- Optional. Name of the Cloud Storage object which contained the section that couldn't be ingested.

### #object_name=

    def object_name=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. Name of the Cloud Storage object which contained the section that couldn't be ingested.
**Returns**

- (::String) --- Optional. Name of the Cloud Storage object which contained the section that couldn't be ingested.

### #schema_violation_reason

    def schema_violation_reason() -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason

**Returns**

- ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-SchemaViolationReason)) --- Optional. The Pub/Sub message failed schema validation.


  Note: The following fields are mutually exclusive: `schema_violation_reason`, `avro_failure_reason`, `api_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #schema_violation_reason=

    def schema_violation_reason=(value) -> ::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason

**Parameter**

- **value** ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-SchemaViolationReason)) --- Optional. The Pub/Sub message failed schema validation.


  Note: The following fields are mutually exclusive: `schema_violation_reason`, `avro_failure_reason`, `api_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-pubsub-v1/latest/Google-Cloud-PubSub-V1-IngestionFailureEvent-SchemaViolationReason)) --- Optional. The Pub/Sub message failed schema validation.


  Note: The following fields are mutually exclusive: `schema_violation_reason`, `avro_failure_reason`, `api_violation_reason`, `message_transformation_failure_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.