Payload of the Platform Log entry sent when a failure is
encountered while ingesting.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
str
Required. Name of the import topic. Format is:
projects/{project_name}/topics/{topic_name}.
error_message
:noindex:
str
Required. Error details explaining why
ingestion to Pub/Sub has failed.
cloud_storage_failure
:noindex:
google.pubsub_v1.types.IngestionFailureEvent.CloudStorageFailure
Optional. Failure when ingesting from Cloud
Storage.
This field is a member of oneof_ failure.
aws_msk_failure
:noindex:
google.pubsub_v1.types.IngestionFailureEvent.AwsMskFailureReason
Optional. Failure when ingesting from Amazon
MSK.
This field is a member of oneof_ failure.
azure_event_hubs_failure
:noindex:
google.pubsub_v1.types.IngestionFailureEvent.AzureEventHubsFailureReason
Optional. Failure when ingesting from Azure
Event Hubs.
This field is a member of oneof_ failure.
confluent_cloud_failure
:noindex:
google.pubsub_v1.types.IngestionFailureEvent.ConfluentCloudFailureReason
Optional. Failure when ingesting from
Confluent Cloud.
This field is a member of oneof_ failure.
aws_kinesis_failure
:noindex:
google.pubsub_v1.types.IngestionFailureEvent.AwsKinesisFailureReason
Optional. Failure when ingesting from AWS
Kinesis.
This field is a member of oneof_ failure.
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.
Failure when ingesting from an AWS Kinesis source.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
Failure when ingesting from an Azure Event Hubs source.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
Failure when ingesting from a Cloud Storage source.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
Failure when ingesting from a Confluent Cloud source.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class IngestionFailureEvent (2.31.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.31.0 (latest)](/python/docs/reference/pubsub/latest/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.30.0](/python/docs/reference/pubsub/2.30.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.29.1](/python/docs/reference/pubsub/2.29.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.28.0](/python/docs/reference/pubsub/2.28.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.27.3](/python/docs/reference/pubsub/2.27.3/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.26.1](/python/docs/reference/pubsub/2.26.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.25.2](/python/docs/reference/pubsub/2.25.2/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.23.1](/python/docs/reference/pubsub/2.23.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.22.0](/python/docs/reference/pubsub/2.22.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.21.5](/python/docs/reference/pubsub/2.21.5/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.20.3](/python/docs/reference/pubsub/2.20.3/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.19.8](/python/docs/reference/pubsub/2.19.8/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.18.4](/python/docs/reference/pubsub/2.18.4/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.17.1](/python/docs/reference/pubsub/2.17.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.16.1](/python/docs/reference/pubsub/2.16.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.15.2](/python/docs/reference/pubsub/2.15.2/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.14.1](/python/docs/reference/pubsub/2.14.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.13.12](/python/docs/reference/pubsub/2.13.12/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.12.1](/python/docs/reference/pubsub/2.12.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.11.1](/python/docs/reference/pubsub/2.11.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.10.0](/python/docs/reference/pubsub/2.10.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.9.0](/python/docs/reference/pubsub/2.9.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.8.0](/python/docs/reference/pubsub/2.8.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.7.1](/python/docs/reference/pubsub/2.7.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.6.1](/python/docs/reference/pubsub/2.6.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.5.0](/python/docs/reference/pubsub/2.5.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.4.2](/python/docs/reference/pubsub/2.4.2/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.3.0](/python/docs/reference/pubsub/2.3.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.2.0](/python/docs/reference/pubsub/2.2.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.1.0](/python/docs/reference/pubsub/2.1.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [2.0.0](/python/docs/reference/pubsub/2.0.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [1.7.2](/python/docs/reference/pubsub/1.7.2/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [1.6.1](/python/docs/reference/pubsub/1.6.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [1.5.0](/python/docs/reference/pubsub/1.5.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [1.4.3](/python/docs/reference/pubsub/1.4.3/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [1.3.1](/python/docs/reference/pubsub/1.3.1/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [1.2.0](/python/docs/reference/pubsub/1.2.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [1.1.0](/python/docs/reference/pubsub/1.1.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [1.0.2](/python/docs/reference/pubsub/1.0.2/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [0.45.0](/python/docs/reference/pubsub/0.45.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [0.44.0](/python/docs/reference/pubsub/0.44.0/google.cloud.pubsub_v1.types.IngestionFailureEvent)\n- [0.43.0](/python/docs/reference/pubsub/0.43.0/google.cloud.pubsub_v1.types.IngestionFailureEvent) \n\n IngestionFailureEvent(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nPayload of the Platform Log entry sent when a failure is\nencountered while ingesting.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\nClasses\n-------\n\n### ApiViolationReason\n\n ApiViolationReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nSpecifies the reason why some data may have been left out of the\ndesired Pub/Sub message due to the API message limits\n(\u003chttps://cloud.google.com/pubsub/quotas#resource_limits\u003e). For\nexample, when the number of attributes is larger than 100, the\nnumber of attributes is truncated to 100 to respect the limit on the\nattribute count. Other attribute limits are treated similarly. When\nthe size of the desired message would've been larger than 10MB, the\nmessage won't be published at all, and ingestion of the subsequent\nmessages will proceed as normal.\n\n### AvroFailureReason\n\n AvroFailureReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nSet when an Avro file is unsupported or its format is not\nvalid. When this occurs, one or more Avro objects won't be\ningested.\n\n### AwsKinesisFailureReason\n\n AwsKinesisFailureReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nFailure when ingesting from an AWS Kinesis source.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\n### AwsMskFailureReason\n\n AwsMskFailureReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nFailure when ingesting from an Amazon MSK source.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\n### AzureEventHubsFailureReason\n\n AzureEventHubsFailureReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nFailure when ingesting from an Azure Event Hubs source.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\n### CloudStorageFailure\n\n CloudStorageFailure(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nFailure when ingesting from a Cloud Storage source.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\n### ConfluentCloudFailureReason\n\n ConfluentCloudFailureReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nFailure when ingesting from a Confluent Cloud source.\n\nThis message has `oneof`_ fields (mutually exclusive fields).\nFor each oneof, at most one member field can be set at the same time.\nSetting any member of the oneof automatically clears all other\nmembers.\n\n.. _oneof: \u003chttps://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields\u003e\n\n### MessageTransformationFailureReason\n\n MessageTransformationFailureReason(\n mapping=None, *, ignore_unknown_fields=False, **kwargs\n )\n\nSet when a Pub/Sub message fails to get published due to a\nmessage transformation error.\n\n### SchemaViolationReason\n\n SchemaViolationReason(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nSet when a Pub/Sub message fails to get published due to a\nschema validation violation."]]
