Class: Google::Cloud::PubSub::V1::IngestionFailureEvent

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/pubsub/v1/pubsub.rb

Overview

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

Defined Under Namespace

Classes: ApiViolationReason, AvroFailureReason, AwsKinesisFailureReason, AwsMskFailureReason, AzureEventHubsFailureReason, CloudStorageFailure, ConfluentCloudFailureReason, MessageTransformationFailureReason, SchemaViolationReason

Instance Attribute Summary collapse

Instance Attribute Details

#aws_kinesis_failure ⇒ ::Google::Cloud::PubSub::V1::IngestionFailureEvent::AwsKinesisFailureReason

Returns Optional. Failure when ingesting from AWS Kinesis.

Note: The following fields are mutually exclusive: aws_kinesis_failure, cloud_storage_failure, aws_msk_failure, azure_event_hubs_failure, confluent_cloud_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::AwsKinesisFailureReason) —

    Optional. Failure when ingesting from AWS Kinesis.

    Note: The following fields are mutually exclusive: aws_kinesis_failure, cloud_storage_failure, aws_msk_failure, azure_event_hubs_failure, confluent_cloud_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 494

class IngestionFailureEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the reason why some data may have been left out of
  # the desired Pub/Sub message due to the API message limits
  # (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
  # when the number of attributes is larger than 100, the number of
  # attributes is truncated to 100 to respect the limit on the attribute count.
  # Other attribute limits are treated similarly. When the size of the desired
  # message would've been larger than 10MB, the message won't be published at
  # all, and ingestion of the subsequent messages will proceed as normal.
  class ApiViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when an Avro file is unsupported or its format is not valid. When this
  # occurs, one or more Avro objects won't be ingested.
  class AvroFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a schema
  # validation violation.
  class SchemaViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a message
  # transformation error.
  class MessageTransformationFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Cloud Storage source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Name of the Cloud Storage bucket used for ingestion.
  # @!attribute [rw] object_name
  #   @return [::String]
  #     Optional. Name of the Cloud Storage object which contained the section
  #     that couldn't be ingested.
  # @!attribute [rw] object_generation
  #   @return [::Integer]
  #     Optional. Generation of the Cloud Storage object which contained the
  #     section that couldn't be ingested.
  # @!attribute [rw] avro_failure_reason
  #   @return [::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.
  # @!attribute [rw] api_violation_reason
  #   @return [::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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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.
  class CloudStorageFailure
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Amazon MSK source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Optional. The ARN of the cluster of the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AwsMskFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Azure Event Hubs source.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The namespace containing the event hub being ingested from.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the event hub being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AzureEventHubsFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Confluent Cloud source.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Optional. The cluster ID containing the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class ConfluentCloudFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an AWS Kinesis source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Optional. The stream ARN of the Kinesis stream being ingested from.
  # @!attribute [rw] partition_key
  #   @return [::String]
  #     Optional. The partition key of the message that failed to be ingested.
  # @!attribute [rw] sequence_number
  #   @return [::String]
  #     Optional. The sequence number of the message that failed to be ingested.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_reason`, `message_transformation_failure_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `schema_violation_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] api_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason]
  #     Optional. The message failed to be published due to an API violation.
  #     This is only set when the size of the data field of the Kinesis record
  #     is zero.
  #
  #     Note: The following fields are mutually exclusive: `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.
  class AwsKinesisFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#aws_msk_failure ⇒ ::Google::Cloud::PubSub::V1::IngestionFailureEvent::AwsMskFailureReason

Returns Optional. Failure when ingesting from Amazon MSK.

Note: The following fields are mutually exclusive: aws_msk_failure, cloud_storage_failure, azure_event_hubs_failure, confluent_cloud_failure, aws_kinesis_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::AwsMskFailureReason) —

    Optional. Failure when ingesting from Amazon MSK.

    Note: The following fields are mutually exclusive: aws_msk_failure, cloud_storage_failure, azure_event_hubs_failure, confluent_cloud_failure, aws_kinesis_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 494

class IngestionFailureEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the reason why some data may have been left out of
  # the desired Pub/Sub message due to the API message limits
  # (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
  # when the number of attributes is larger than 100, the number of
  # attributes is truncated to 100 to respect the limit on the attribute count.
  # Other attribute limits are treated similarly. When the size of the desired
  # message would've been larger than 10MB, the message won't be published at
  # all, and ingestion of the subsequent messages will proceed as normal.
  class ApiViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when an Avro file is unsupported or its format is not valid. When this
  # occurs, one or more Avro objects won't be ingested.
  class AvroFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a schema
  # validation violation.
  class SchemaViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a message
  # transformation error.
  class MessageTransformationFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Cloud Storage source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Name of the Cloud Storage bucket used for ingestion.
  # @!attribute [rw] object_name
  #   @return [::String]
  #     Optional. Name of the Cloud Storage object which contained the section
  #     that couldn't be ingested.
  # @!attribute [rw] object_generation
  #   @return [::Integer]
  #     Optional. Generation of the Cloud Storage object which contained the
  #     section that couldn't be ingested.
  # @!attribute [rw] avro_failure_reason
  #   @return [::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.
  # @!attribute [rw] api_violation_reason
  #   @return [::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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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.
  class CloudStorageFailure
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Amazon MSK source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Optional. The ARN of the cluster of the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AwsMskFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Azure Event Hubs source.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The namespace containing the event hub being ingested from.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the event hub being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AzureEventHubsFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Confluent Cloud source.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Optional. The cluster ID containing the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class ConfluentCloudFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an AWS Kinesis source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Optional. The stream ARN of the Kinesis stream being ingested from.
  # @!attribute [rw] partition_key
  #   @return [::String]
  #     Optional. The partition key of the message that failed to be ingested.
  # @!attribute [rw] sequence_number
  #   @return [::String]
  #     Optional. The sequence number of the message that failed to be ingested.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_reason`, `message_transformation_failure_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `schema_violation_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] api_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason]
  #     Optional. The message failed to be published due to an API violation.
  #     This is only set when the size of the data field of the Kinesis record
  #     is zero.
  #
  #     Note: The following fields are mutually exclusive: `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.
  class AwsKinesisFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#azure_event_hubs_failure ⇒ ::Google::Cloud::PubSub::V1::IngestionFailureEvent::AzureEventHubsFailureReason

Returns Optional. Failure when ingesting from Azure Event Hubs.

Note: The following fields are mutually exclusive: azure_event_hubs_failure, cloud_storage_failure, aws_msk_failure, confluent_cloud_failure, aws_kinesis_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::AzureEventHubsFailureReason) —

    Optional. Failure when ingesting from Azure Event Hubs.

    Note: The following fields are mutually exclusive: azure_event_hubs_failure, cloud_storage_failure, aws_msk_failure, confluent_cloud_failure, aws_kinesis_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 494

class IngestionFailureEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the reason why some data may have been left out of
  # the desired Pub/Sub message due to the API message limits
  # (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
  # when the number of attributes is larger than 100, the number of
  # attributes is truncated to 100 to respect the limit on the attribute count.
  # Other attribute limits are treated similarly. When the size of the desired
  # message would've been larger than 10MB, the message won't be published at
  # all, and ingestion of the subsequent messages will proceed as normal.
  class ApiViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when an Avro file is unsupported or its format is not valid. When this
  # occurs, one or more Avro objects won't be ingested.
  class AvroFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a schema
  # validation violation.
  class SchemaViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a message
  # transformation error.
  class MessageTransformationFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Cloud Storage source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Name of the Cloud Storage bucket used for ingestion.
  # @!attribute [rw] object_name
  #   @return [::String]
  #     Optional. Name of the Cloud Storage object which contained the section
  #     that couldn't be ingested.
  # @!attribute [rw] object_generation
  #   @return [::Integer]
  #     Optional. Generation of the Cloud Storage object which contained the
  #     section that couldn't be ingested.
  # @!attribute [rw] avro_failure_reason
  #   @return [::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.
  # @!attribute [rw] api_violation_reason
  #   @return [::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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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.
  class CloudStorageFailure
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Amazon MSK source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Optional. The ARN of the cluster of the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AwsMskFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Azure Event Hubs source.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The namespace containing the event hub being ingested from.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the event hub being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AzureEventHubsFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Confluent Cloud source.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Optional. The cluster ID containing the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class ConfluentCloudFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an AWS Kinesis source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Optional. The stream ARN of the Kinesis stream being ingested from.
  # @!attribute [rw] partition_key
  #   @return [::String]
  #     Optional. The partition key of the message that failed to be ingested.
  # @!attribute [rw] sequence_number
  #   @return [::String]
  #     Optional. The sequence number of the message that failed to be ingested.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_reason`, `message_transformation_failure_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `schema_violation_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] api_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason]
  #     Optional. The message failed to be published due to an API violation.
  #     This is only set when the size of the data field of the Kinesis record
  #     is zero.
  #
  #     Note: The following fields are mutually exclusive: `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.
  class AwsKinesisFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#cloud_storage_failure ⇒ ::Google::Cloud::PubSub::V1::IngestionFailureEvent::CloudStorageFailure

Returns Optional. Failure when ingesting from Cloud Storage.

Note: The following fields are mutually exclusive: cloud_storage_failure, aws_msk_failure, azure_event_hubs_failure, confluent_cloud_failure, aws_kinesis_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::CloudStorageFailure) —

    Optional. Failure when ingesting from Cloud Storage.

    Note: The following fields are mutually exclusive: cloud_storage_failure, aws_msk_failure, azure_event_hubs_failure, confluent_cloud_failure, aws_kinesis_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 494

class IngestionFailureEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the reason why some data may have been left out of
  # the desired Pub/Sub message due to the API message limits
  # (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
  # when the number of attributes is larger than 100, the number of
  # attributes is truncated to 100 to respect the limit on the attribute count.
  # Other attribute limits are treated similarly. When the size of the desired
  # message would've been larger than 10MB, the message won't be published at
  # all, and ingestion of the subsequent messages will proceed as normal.
  class ApiViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when an Avro file is unsupported or its format is not valid. When this
  # occurs, one or more Avro objects won't be ingested.
  class AvroFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a schema
  # validation violation.
  class SchemaViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a message
  # transformation error.
  class MessageTransformationFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Cloud Storage source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Name of the Cloud Storage bucket used for ingestion.
  # @!attribute [rw] object_name
  #   @return [::String]
  #     Optional. Name of the Cloud Storage object which contained the section
  #     that couldn't be ingested.
  # @!attribute [rw] object_generation
  #   @return [::Integer]
  #     Optional. Generation of the Cloud Storage object which contained the
  #     section that couldn't be ingested.
  # @!attribute [rw] avro_failure_reason
  #   @return [::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.
  # @!attribute [rw] api_violation_reason
  #   @return [::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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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.
  class CloudStorageFailure
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Amazon MSK source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Optional. The ARN of the cluster of the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AwsMskFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Azure Event Hubs source.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The namespace containing the event hub being ingested from.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the event hub being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AzureEventHubsFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Confluent Cloud source.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Optional. The cluster ID containing the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class ConfluentCloudFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an AWS Kinesis source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Optional. The stream ARN of the Kinesis stream being ingested from.
  # @!attribute [rw] partition_key
  #   @return [::String]
  #     Optional. The partition key of the message that failed to be ingested.
  # @!attribute [rw] sequence_number
  #   @return [::String]
  #     Optional. The sequence number of the message that failed to be ingested.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_reason`, `message_transformation_failure_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `schema_violation_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] api_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason]
  #     Optional. The message failed to be published due to an API violation.
  #     This is only set when the size of the data field of the Kinesis record
  #     is zero.
  #
  #     Note: The following fields are mutually exclusive: `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.
  class AwsKinesisFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#confluent_cloud_failure ⇒ ::Google::Cloud::PubSub::V1::IngestionFailureEvent::ConfluentCloudFailureReason

Returns Optional. Failure when ingesting from Confluent Cloud.

Note: The following fields are mutually exclusive: confluent_cloud_failure, cloud_storage_failure, aws_msk_failure, azure_event_hubs_failure, aws_kinesis_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::PubSub::V1::IngestionFailureEvent::ConfluentCloudFailureReason) —

    Optional. Failure when ingesting from Confluent Cloud.

    Note: The following fields are mutually exclusive: confluent_cloud_failure, cloud_storage_failure, aws_msk_failure, azure_event_hubs_failure, aws_kinesis_failure. If a field in that set is populated, all other fields in the set will automatically be cleared.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 494

class IngestionFailureEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the reason why some data may have been left out of
  # the desired Pub/Sub message due to the API message limits
  # (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
  # when the number of attributes is larger than 100, the number of
  # attributes is truncated to 100 to respect the limit on the attribute count.
  # Other attribute limits are treated similarly. When the size of the desired
  # message would've been larger than 10MB, the message won't be published at
  # all, and ingestion of the subsequent messages will proceed as normal.
  class ApiViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when an Avro file is unsupported or its format is not valid. When this
  # occurs, one or more Avro objects won't be ingested.
  class AvroFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a schema
  # validation violation.
  class SchemaViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a message
  # transformation error.
  class MessageTransformationFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Cloud Storage source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Name of the Cloud Storage bucket used for ingestion.
  # @!attribute [rw] object_name
  #   @return [::String]
  #     Optional. Name of the Cloud Storage object which contained the section
  #     that couldn't be ingested.
  # @!attribute [rw] object_generation
  #   @return [::Integer]
  #     Optional. Generation of the Cloud Storage object which contained the
  #     section that couldn't be ingested.
  # @!attribute [rw] avro_failure_reason
  #   @return [::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.
  # @!attribute [rw] api_violation_reason
  #   @return [::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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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.
  class CloudStorageFailure
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Amazon MSK source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Optional. The ARN of the cluster of the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AwsMskFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Azure Event Hubs source.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The namespace containing the event hub being ingested from.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the event hub being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AzureEventHubsFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Confluent Cloud source.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Optional. The cluster ID containing the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class ConfluentCloudFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an AWS Kinesis source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Optional. The stream ARN of the Kinesis stream being ingested from.
  # @!attribute [rw] partition_key
  #   @return [::String]
  #     Optional. The partition key of the message that failed to be ingested.
  # @!attribute [rw] sequence_number
  #   @return [::String]
  #     Optional. The sequence number of the message that failed to be ingested.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_reason`, `message_transformation_failure_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `schema_violation_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] api_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason]
  #     Optional. The message failed to be published due to an API violation.
  #     This is only set when the size of the data field of the Kinesis record
  #     is zero.
  #
  #     Note: The following fields are mutually exclusive: `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.
  class AwsKinesisFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#error_message ⇒ ::String

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

Returns:

  • (::String) —

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



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 494

class IngestionFailureEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the reason why some data may have been left out of
  # the desired Pub/Sub message due to the API message limits
  # (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
  # when the number of attributes is larger than 100, the number of
  # attributes is truncated to 100 to respect the limit on the attribute count.
  # Other attribute limits are treated similarly. When the size of the desired
  # message would've been larger than 10MB, the message won't be published at
  # all, and ingestion of the subsequent messages will proceed as normal.
  class ApiViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when an Avro file is unsupported or its format is not valid. When this
  # occurs, one or more Avro objects won't be ingested.
  class AvroFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a schema
  # validation violation.
  class SchemaViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a message
  # transformation error.
  class MessageTransformationFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Cloud Storage source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Name of the Cloud Storage bucket used for ingestion.
  # @!attribute [rw] object_name
  #   @return [::String]
  #     Optional. Name of the Cloud Storage object which contained the section
  #     that couldn't be ingested.
  # @!attribute [rw] object_generation
  #   @return [::Integer]
  #     Optional. Generation of the Cloud Storage object which contained the
  #     section that couldn't be ingested.
  # @!attribute [rw] avro_failure_reason
  #   @return [::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.
  # @!attribute [rw] api_violation_reason
  #   @return [::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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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.
  class CloudStorageFailure
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Amazon MSK source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Optional. The ARN of the cluster of the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AwsMskFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Azure Event Hubs source.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The namespace containing the event hub being ingested from.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the event hub being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AzureEventHubsFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Confluent Cloud source.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Optional. The cluster ID containing the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class ConfluentCloudFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an AWS Kinesis source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Optional. The stream ARN of the Kinesis stream being ingested from.
  # @!attribute [rw] partition_key
  #   @return [::String]
  #     Optional. The partition key of the message that failed to be ingested.
  # @!attribute [rw] sequence_number
  #   @return [::String]
  #     Optional. The sequence number of the message that failed to be ingested.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_reason`, `message_transformation_failure_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `schema_violation_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] api_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason]
  #     Optional. The message failed to be published due to an API violation.
  #     This is only set when the size of the data field of the Kinesis record
  #     is zero.
  #
  #     Note: The following fields are mutually exclusive: `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.
  class AwsKinesisFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#topic ⇒ ::String

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

Returns:

  • (::String) —

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



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'proto_docs/google/pubsub/v1/pubsub.rb', line 494

class IngestionFailureEvent
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the reason why some data may have been left out of
  # the desired Pub/Sub message due to the API message limits
  # (https://cloud.google.com/pubsub/quotas#resource_limits). For example,
  # when the number of attributes is larger than 100, the number of
  # attributes is truncated to 100 to respect the limit on the attribute count.
  # Other attribute limits are treated similarly. When the size of the desired
  # message would've been larger than 10MB, the message won't be published at
  # all, and ingestion of the subsequent messages will proceed as normal.
  class ApiViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when an Avro file is unsupported or its format is not valid. When this
  # occurs, one or more Avro objects won't be ingested.
  class AvroFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a schema
  # validation violation.
  class SchemaViolationReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set when a Pub/Sub message fails to get published due to a message
  # transformation error.
  class MessageTransformationFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Cloud Storage source.
  # @!attribute [rw] bucket
  #   @return [::String]
  #     Optional. Name of the Cloud Storage bucket used for ingestion.
  # @!attribute [rw] object_name
  #   @return [::String]
  #     Optional. Name of the Cloud Storage object which contained the section
  #     that couldn't be ingested.
  # @!attribute [rw] object_generation
  #   @return [::Integer]
  #     Optional. Generation of the Cloud Storage object which contained the
  #     section that couldn't be ingested.
  # @!attribute [rw] avro_failure_reason
  #   @return [::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.
  # @!attribute [rw] api_violation_reason
  #   @return [::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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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.
  class CloudStorageFailure
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Amazon MSK source.
  # @!attribute [rw] cluster_arn
  #   @return [::String]
  #     Optional. The ARN of the cluster of the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AwsMskFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an Azure Event Hubs source.
  # @!attribute [rw] namespace
  #   @return [::String]
  #     Optional. The namespace containing the event hub being ingested from.
  # @!attribute [rw] event_hub
  #   @return [::String]
  #     Optional. The name of the event hub being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class AzureEventHubsFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from a Confluent Cloud source.
  # @!attribute [rw] cluster_id
  #   @return [::String]
  #     Optional. The cluster ID containing the topic being ingested from.
  # @!attribute [rw] kafka_topic
  #   @return [::String]
  #     Optional. The name of the Kafka topic being ingested from.
  # @!attribute [rw] partition_id
  #   @return [::Integer]
  #     Optional. The partition ID of the message that failed to be ingested.
  # @!attribute [rw] offset
  #   @return [::Integer]
  #     Optional. The offset within the partition of the message that failed to
  #     be ingested.
  # @!attribute [rw] api_violation_reason
  #   @return [::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`, `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.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_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.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `api_violation_reason`, `schema_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class ConfluentCloudFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Failure when ingesting from an AWS Kinesis source.
  # @!attribute [rw] stream_arn
  #   @return [::String]
  #     Optional. The stream ARN of the Kinesis stream being ingested from.
  # @!attribute [rw] partition_key
  #   @return [::String]
  #     Optional. The partition key of the message that failed to be ingested.
  # @!attribute [rw] sequence_number
  #   @return [::String]
  #     Optional. The sequence number of the message that failed to be ingested.
  # @!attribute [rw] schema_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::SchemaViolationReason]
  #     Optional. The Pub/Sub message failed schema validation.
  #
  #     Note: The following fields are mutually exclusive: `schema_violation_reason`, `message_transformation_failure_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] message_transformation_failure_reason
  #   @return [::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`, `schema_violation_reason`, `api_violation_reason`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] api_violation_reason
  #   @return [::Google::Cloud::PubSub::V1::IngestionFailureEvent::ApiViolationReason]
  #     Optional. The message failed to be published due to an API violation.
  #     This is only set when the size of the data field of the Kinesis record
  #     is zero.
  #
  #     Note: The following fields are mutually exclusive: `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.
  class AwsKinesisFailureReason
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end