Types for Google Cloud Eventarc v1 API¶
- class google.cloud.eventarc_v1.types.Channel(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of the Channel resource. A Channel is a resource on which event providers publish their events. The published events are delivered through the transport associated with the channel. Note that a channel is associated with exactly one event provider.
- name¶
Required. The resource name of the channel. Must be unique within the location on the project and must be in
projects/{project}/locations/{location}/channels/{channel_id}format.- Type
- uid¶
Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- Type
- create_time¶
Output only. The creation time.
- update_time¶
Output only. The last-modified time.
- provider¶
The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format:
projects/{project}/locations/{location}/providers/{provider_id}.- Type
- pubsub_topic¶
Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format:
projects/{project}/topics/{topic_id}.This field is a member of oneof
transport.- Type
- state¶
Output only. The state of a Channel.
- activation_token¶
Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing.
- Type
- crypto_key_name¶
Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.- Type
- satisfies_pzs¶
Output only. Whether or not this Channel satisfies the requirements of physical zone separation
- Type
- class State(value)[source]¶
Bases:
proto.enums.EnumState lists all the possible states of a Channel
- Values:
- STATE_UNSPECIFIED (0):
Default value. This value is unused.
- PENDING (1):
The PENDING state indicates that a Channel has been created successfully and there is a new activation token available for the subscriber to use to convey the Channel to the provider in order to create a Connection.
- ACTIVE (2):
The ACTIVE state indicates that a Channel has been successfully connected with the event provider. An ACTIVE Channel is ready to receive and route events from the event provider.
- INACTIVE (3):
The INACTIVE state indicates that the Channel cannot receive events permanently. There are two possible cases this state can happen:
- The SaaS provider disconnected from this
Channel.
- The Channel activation token has expired but
the SaaS provider wasn’t connected.
To re-establish a Connection with a provider, the subscriber should create a new Channel and give it to the provider.
- class google.cloud.eventarc_v1.types.ChannelConnection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of the ChannelConnection resource. A ChannelConnection is a resource which event providers create during the activation process to establish a connection between the provider and the subscriber channel.
- uid¶
Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until deleted.
- Type
- channel¶
Required. The name of the connected subscriber Channel. This is a weak reference to avoid cross project and cross accounts references. This must be in
projects/{project}/location/{location}/channels/{channel_id}format.- Type
- create_time¶
Output only. The creation time.
- update_time¶
Output only. The last-modified time.
- class google.cloud.eventarc_v1.types.CloudRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a Cloud Run destination.
- service¶
Required. The name of the Cloud Run service being addressed. See https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services.
Only services located in the same project as the trigger object can be addressed.
- Type
- path¶
Optional. The relative path on the Cloud Run service the events should be sent to.
The value must conform to the definition of a URI path segment (section 3.3 of RFC2396). Examples: “/route”, “route”, “route/subroute”.
- Type
- class google.cloud.eventarc_v1.types.CreateChannelConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the CreateChannelConnection method.
- channel_connection¶
Required. Channel connection to create.
- class google.cloud.eventarc_v1.types.CreateChannelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the CreateChannel method.
- channel¶
Required. The channel to create.
- class google.cloud.eventarc_v1.types.CreateEnrollmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the CreateEnrollment method.
- enrollment¶
Required. The enrollment to create.
- enrollment_id¶
Required. The user-provided ID to be assigned to the Enrollment. It should match the format (^`a-z <[a-z0-9-]{0,61}[a-z0-9]>`__?$).
- Type
- class google.cloud.eventarc_v1.types.CreateGoogleApiSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the CreateGoogleApiSource method.
- google_api_source¶
Required. The google api source to create.
- google_api_source_id¶
Required. The user-provided ID to be assigned to the GoogleApiSource. It should match the format (^`a-z <[a-z0-9-]{0,61}[a-z0-9]>`__?$).
- Type
- class google.cloud.eventarc_v1.types.CreateMessageBusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the CreateMessageBus method.
- message_bus¶
Required. The message bus to create.
- message_bus_id¶
Required. The user-provided ID to be assigned to the MessageBus. It should match the format (^`a-z <[a-z0-9-]{0,61}[a-z0-9]>`__?$)
- Type
- class google.cloud.eventarc_v1.types.CreatePipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the CreatePipeline method.
- pipeline¶
Required. The pipeline to create.
- class google.cloud.eventarc_v1.types.CreateTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the CreateTrigger method.
- trigger¶
Required. The trigger to create.
- class google.cloud.eventarc_v1.types.DeleteChannelConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the DeleteChannelConnection method.
- class google.cloud.eventarc_v1.types.DeleteChannelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the DeleteChannel method.
- class google.cloud.eventarc_v1.types.DeleteEnrollmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the DeleteEnrollment method.
- etag¶
Optional. If provided, the Enrollment will only be deleted if the etag matches the current etag on the resource.
- Type
- allow_missing¶
Optional. If set to true, and the Enrollment is not found, the request will succeed but no action will be taken on the server.
- Type
- class google.cloud.eventarc_v1.types.DeleteGoogleApiSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the DeleteGoogleApiSource method.
- etag¶
Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.
- Type
- allow_missing¶
Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.
- Type
- class google.cloud.eventarc_v1.types.DeleteMessageBusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the DeleteMessageBus method.
- etag¶
Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource.
- Type
- allow_missing¶
Optional. If set to true, and the MessageBus is not found, the request will succeed but no action will be taken on the server.
- Type
- class google.cloud.eventarc_v1.types.DeletePipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the DeletePipeline method.
- etag¶
Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource.
- Type
- allow_missing¶
Optional. If set to true, and the Pipeline is not found, the request will succeed but no action will be taken on the server.
- Type
- class google.cloud.eventarc_v1.types.DeleteTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the DeleteTrigger method.
- etag¶
If provided, the trigger will only be deleted if the etag matches the current etag on the resource.
- Type
- allow_missing¶
If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server.
- Type
- class google.cloud.eventarc_v1.types.Destination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a target of an invocation over HTTP.
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.
- cloud_run¶
Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger.
This field is a member of oneof
descriptor.
- cloud_function¶
The Cloud Function resource name. Cloud Functions V1 and V2 are supported. Format:
projects/{project}/locations/{location}/functions/{function}This is a read-only field. Creating Cloud Functions V1/V2 triggers is only supported via the Cloud Functions product. An error will be returned if the user sets this value.
This field is a member of oneof
descriptor.- Type
- gke¶
A GKE service capable of receiving events. The service should be running in the same project as the trigger.
This field is a member of oneof
descriptor.
- workflow¶
The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the trigger. Format:
projects/{project}/locations/{location}/workflows/{workflow}This field is a member of oneof
descriptor.- Type
- http_endpoint¶
An HTTP endpoint destination described by an URI.
This field is a member of oneof
descriptor.
- network_config¶
Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type.
- class google.cloud.eventarc_v1.types.Enrollment(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageAn enrollment represents a subscription for messages on a particular message bus. It defines a matching criteria for messages on the bus and the subscriber endpoint where matched messages should be delivered.
- name¶
Identifier. Resource name of the form projects/{project}/locations/{location}/enrollments/{enrollment}
- Type
- uid¶
Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- Type
- etag¶
Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- Type
- create_time¶
Output only. The creation time.
- update_time¶
Output only. The last-modified time.
- cel_match¶
Required. A CEL expression identifying which messages this enrollment applies to.
- Type
- message_bus¶
Required. Resource name of the message bus identifying the source of the messages. It matches the form projects/{project}/locations/{location}/messageBuses/{messageBus}.
- Type
- destination¶
Required. Destination is the Pipeline that the Enrollment is delivering to. It must point to the full resource name of a Pipeline. Format: “projects/{PROJECT_ID}/locations/{region}/pipelines/{PIPELINE_ID)”.
- Type
- class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.eventarc_v1.types.EventFilter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageFilters events based on exact matches on the CloudEvents attributes.
- attribute¶
Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. You can retrieve a specific provider’s supported event types.
All triggers MUST provide a filter for the ‘type’ attribute.
- Type
- operator¶
Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The allowed values are
path_patternandmatch-path-pattern.path_patternis only allowed for GCFv1 triggers.- Type
- class google.cloud.eventarc_v1.types.EventType(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of the event type resource.
- type_¶
Output only. The full name of the event type (for example, “google.cloud.storage.object.v1.finalized”). In the form of {provider-specific-prefix}.{resource}.{version}.{verb}. Types MUST be versioned and event schemas are guaranteed to remain backward compatible within one version. Note that event type versions and API versions do not need to match.
- Type
- description¶
Output only. Human friendly description of what the event type is about. For example “Bucket created in Cloud Storage”.
- Type
- filtering_attributes¶
Output only. Filtering attributes for the event type.
- Type
MutableSequence[google.cloud.eventarc_v1.types.FilteringAttribute]
- event_schema_uri¶
Output only. URI for the event schema. For example “https://github.com/googleapis/google-cloudevents/blob/master/proto/google/events/cloud/storage/v1/events.proto”.
- Type
- class google.cloud.eventarc_v1.types.FilteringAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of the FilteringAttribute resource. Filtering attributes are per event type.
- required¶
Output only. If true, the triggers for this provider should always specify a filter on these attributes. Trigger creation will fail otherwise.
- Type
- class google.cloud.eventarc_v1.types.GKE(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a GKE destination.
- cluster¶
Required. The name of the cluster the GKE service is running in. The cluster must be running in the same project as the trigger being created.
- Type
- location¶
Required. The name of the Google Compute Engine in which the cluster resides, which can either be compute zone (for example, us-central1-a) for the zonal clusters or region (for example, us-central1) for regional clusters.
- Type
- class google.cloud.eventarc_v1.types.GetChannelConnectionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetChannelConnection method.
- class google.cloud.eventarc_v1.types.GetChannelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetChannel method.
- class google.cloud.eventarc_v1.types.GetEnrollmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetEnrollment method.
- class google.cloud.eventarc_v1.types.GetGoogleApiSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetGoogleApiSource method.
- class google.cloud.eventarc_v1.types.GetGoogleChannelConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetGoogleChannelConfig method.
- class google.cloud.eventarc_v1.types.GetMessageBusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetMessageBus method.
- class google.cloud.eventarc_v1.types.GetPipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetPipeline method.
- class google.cloud.eventarc_v1.types.GetProviderRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetProvider method.
- class google.cloud.eventarc_v1.types.GetTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the GetTrigger method.
- class google.cloud.eventarc_v1.types.GoogleApiSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA GoogleApiSource represents a subscription of 1P events from a MessageBus.
- name¶
Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
- Type
- uid¶
Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- Type
- etag¶
Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- Type
- create_time¶
Output only. The creation time.
- update_time¶
Output only. The last-modified time.
- destination¶
Required. Destination is the message bus that the GoogleApiSource is delivering to. It must be point to the full resource name of a MessageBus. Format: “projects/{PROJECT_ID}/locations/{region}/messagesBuses/{MESSAGE_BUS_ID)
- Type
- crypto_key_name¶
Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.- Type
- logging_config¶
Optional. Config to control Platform logging for the GoogleApiSource.
- class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.eventarc_v1.types.GoogleChannelConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA GoogleChannelConfig is a resource that stores the custom settings respected by Eventarc first-party triggers in the matching region. Once configured, first-party event data will be protected using the specified custom managed encryption key instead of Google-managed encryption keys.
- name¶
Required. The resource name of the config. Must be in the format of,
projects/{project}/locations/{location}/googleChannelConfig.- Type
- update_time¶
Output only. The last-modified time.
- class google.cloud.eventarc_v1.types.HttpEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a HTTP endpoint destination.
- uri¶
Required. The URI of the HTTP enpdoint.
The value must be a RFC2396 URI string. Examples:
http://10.10.10.8:80/route,http://svc.us-central1.p.local:8080/. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.- Type
- class google.cloud.eventarc_v1.types.ListChannelConnectionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the ListChannelConnections method.
- page_size¶
The maximum number of channel connections to return on each page. Note: The service may send fewer responses.
- Type
- class google.cloud.eventarc_v1.types.ListChannelConnectionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the
ListChannelConnectionsmethod.- channel_connections¶
The requested channel connections, up to the number specified in
page_size.- Type
MutableSequence[google.cloud.eventarc_v1.types.ChannelConnection]
- next_page_token¶
A page token that can be sent to
ListChannelConnectionsto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.ListChannelsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the ListChannels method.
- page_size¶
The maximum number of channels to return on each page. Note: The service may send fewer.
- Type
- page_token¶
The page token; provide the value from the
next_page_tokenfield in a previousListChannelscall to retrieve the subsequent page.When paginating, all other parameters provided to
ListChannelsmust match the call that provided the page token.- Type
- class google.cloud.eventarc_v1.types.ListChannelsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the
ListChannelsmethod.- channels¶
The requested channels, up to the number specified in
page_size.- Type
MutableSequence[google.cloud.eventarc_v1.types.Channel]
- next_page_token¶
A page token that can be sent to
ListChannelsto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.ListEnrollmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the ListEnrollments method.
- page_size¶
Optional. The maximum number of results to return on each page. Note: The service may send fewer.
- Type
- page_token¶
Optional. The page token; provide the value from the
next_page_tokenfield in a previous call to retrieve the subsequent page.When paginating, all other parameters provided must match the previous call that provided the page token.
- Type
- order_by¶
Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a
descsuffix; for example:name desc, update_time.- Type
- filter¶
Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
- Type
- class google.cloud.eventarc_v1.types.ListEnrollmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the
ListEnrollmentsmethod.- enrollments¶
The requested Enrollments, up to the number specified in
page_size.- Type
MutableSequence[google.cloud.eventarc_v1.types.Enrollment]
- next_page_token¶
A page token that can be sent to
ListEnrollmentsto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.ListGoogleApiSourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the ListGoogleApiSources method.
- page_size¶
Optional. The maximum number of results to return on each page. Note: The service may send fewer.
- Type
- page_token¶
Optional. The page token; provide the value from the
next_page_tokenfield in a previous call to retrieve the subsequent page.When paginating, all other parameters provided must match the previous call that provided the page token.
- Type
- order_by¶
Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a
descsuffix; for example:name desc, update_time.- Type
- filter¶
Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
- Type
- class google.cloud.eventarc_v1.types.ListGoogleApiSourcesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the
ListGoogleApiSourcesmethod.- google_api_sources¶
The requested GoogleApiSources, up to the number specified in
page_size.- Type
MutableSequence[google.cloud.eventarc_v1.types.GoogleApiSource]
- next_page_token¶
A page token that can be sent to
ListMessageBusEnrollmentsto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.ListMessageBusEnrollmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the
ListMessageBusEnrollmentsmethod.- page_size¶
Optional. The maximum number of results to return on each page. Note: The service may send fewer.
- Type
- class google.cloud.eventarc_v1.types.ListMessageBusEnrollmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the
ListMessageBusEnrollmentsmethod.`- enrollments¶
The requested enrollments, up to the number specified in
page_size.- Type
MutableSequence[str]
- next_page_token¶
A page token that can be sent to
ListMessageBusEnrollmentsto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.ListMessageBusesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the ListMessageBuses method.
- page_size¶
Optional. The maximum number of results to return on each page. Note: The service may send fewer.
- Type
- page_token¶
Optional. The page token; provide the value from the
next_page_tokenfield in a previous call to retrieve the subsequent page.When paginating, all other parameters provided must match the previous call that provided the page token.
- Type
- order_by¶
Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a
descsuffix; for example:name desc, update_time.- Type
- filter¶
Optional. The filter field that the list request will filter on. Possible filtersare described in https://google.aip.dev/160.
- Type
- class google.cloud.eventarc_v1.types.ListMessageBusesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the
ListMessageBusesmethod.- message_buses¶
The requested message buses, up to the number specified in
page_size.- Type
MutableSequence[google.cloud.eventarc_v1.types.MessageBus]
- next_page_token¶
A page token that can be sent to
ListMessageBusesto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.ListPipelinesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the ListPipelines method.
- page_size¶
Optional. The maximum number of results to return on each page. Note: The service may send fewer.
- Type
- page_token¶
Optional. The page token; provide the value from the
next_page_tokenfield in a previous call to retrieve the subsequent page.When paginating, all other parameters provided must match the previous call that provided the page token.
- Type
- order_by¶
Optional. The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a
descsuffix; for example:name desc, update_time.- Type
- filter¶
Optional. The filter field that the list request will filter on. Possible filters are described in https://google.aip.dev/160.
- Type
- class google.cloud.eventarc_v1.types.ListPipelinesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the ListPipelines method.
- pipelines¶
The requested pipelines, up to the number specified in
page_size.- Type
MutableSequence[google.cloud.eventarc_v1.types.Pipeline]
- next_page_token¶
A page token that can be sent to
ListPipelinesto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.ListProvidersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the ListProviders method.
- page_token¶
The page token; provide the value from the
next_page_tokenfield in a previousListProviderscall to retrieve the subsequent page.When paginating, all other parameters provided to
ListProvidersmust match the call that provided the page token.- Type
- order_by¶
The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting oder is ascending. To specify descending order for a field, append a
descsuffix; for example:name desc, _id.- Type
- class google.cloud.eventarc_v1.types.ListProvidersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the
ListProvidersmethod.- providers¶
The requested providers, up to the number specified in
page_size.- Type
MutableSequence[google.cloud.eventarc_v1.types.Provider]
- next_page_token¶
A page token that can be sent to
ListProvidersto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.ListTriggersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the ListTriggers method.
- page_size¶
The maximum number of triggers to return on each page. Note: The service may send fewer.
- Type
- page_token¶
The page token; provide the value from the
next_page_tokenfield in a previousListTriggerscall to retrieve the subsequent page.When paginating, all other parameters provided to
ListTriggersmust match the call that provided the page token.- Type
- order_by¶
The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a
descsuffix; for example:name desc, trigger_id.- Type
- filter¶
Filter field. Used to filter the Triggers to be listed. Possible filters are described in https://google.aip.dev/160. For example, using “?filter=destination:gke” would list only Triggers with a gke destination.
- Type
- class google.cloud.eventarc_v1.types.ListTriggersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe response message for the
ListTriggersmethod.- triggers¶
The requested triggers, up to the number specified in
page_size.- Type
MutableSequence[google.cloud.eventarc_v1.types.Trigger]
- next_page_token¶
A page token that can be sent to
ListTriggersto request the next page. If this is empty, then there are no more pages.- Type
- class google.cloud.eventarc_v1.types.LoggingConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe configuration for Platform Telemetry logging for Eventarc Advanced resources.
- log_severity¶
Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
- class LogSeverity(value)[source]¶
Bases:
proto.enums.EnumThe different severities for logging supported by Eventarc Advanced resources. This enum is an exhaustive list of log severities and is FROZEN. Do not expect new values to be added.
- Values:
- LOG_SEVERITY_UNSPECIFIED (0):
Log severity is not specified. This value is treated the same as NONE, but is used to distinguish between no update and update to NONE in update_masks.
- NONE (1):
Default value at resource creation, presence of this value must be treated as no logging/disable logging.
- DEBUG (2):
Debug or trace level logging.
- INFO (3):
Routine information, such as ongoing status or performance.
- NOTICE (4):
Normal but significant events, such as start up, shut down, or a configuration change.
- WARNING (5):
Warning events might cause problems.
- ERROR (6):
Error events are likely to cause problems.
- CRITICAL (7):
Critical events cause more severe problems or outages.
- ALERT (8):
A person must take action immediately.
- EMERGENCY (9):
One or more systems are unusable.
- class google.cloud.eventarc_v1.types.MessageBus(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMessageBus for the messages flowing through the system. The admin has visibility and control over the messages being published and consumed and can restrict publishers and subscribers to only a subset of data available in the system by defining authorization policies.
- name¶
Identifier. Resource name of the form projects/{project}/locations/{location}/messageBuses/{message_bus}
- Type
- uid¶
Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- Type
- etag¶
Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on update and delete requests to ensure that the client has an up-to-date value before proceeding.
- Type
- create_time¶
Output only. The creation time.
- update_time¶
Output only. The last-modified time.
- crypto_key_name¶
Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data.
It must match the pattern
projects/*/locations/*/keyRings/*/cryptoKeys/*.- Type
- logging_config¶
Optional. Config to control Platform logging for the Message Bus. This log configuration is applied to the Message Bus itself, and all the Enrollments attached to it.
- class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.eventarc_v1.types.NetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageNetwork Configuration that can be inherited by other protos.
- class google.cloud.eventarc_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the metadata of the long-running operation.
- create_time¶
Output only. The time the operation was created.
- end_time¶
Output only. The time the operation finished running.
- requested_cancellation¶
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
Code.CANCELLED.- Type
- class google.cloud.eventarc_v1.types.Pipeline(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of the Pipeline resource.
- name¶
Identifier. The resource name of the Pipeline. Must be unique within the location of the project and must be in
projects/{project}/locations/{location}/pipelines/{pipeline}format.- Type
- create_time¶
Output only. The creation time. A timestamp in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits. Examples: “2014-10-02T15:01:23Z” and “2014-10-02T15:01:23.045123456Z”.
- update_time¶
Output only. The last-modified time. A timestamp in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits. Examples: “2014-10-02T15:01:23Z” and “2014-10-02T15:01:23.045123456Z”.
- labels¶
Optional. User labels attached to the Pipeline that can be used to group resources. An object containing a list of “key”: value pairs. Example: { “name”: “wrench”, “mass”: “1.3kg”, “count”: “3” }.
- uid¶
Output only. Server-assigned unique identifier for the Pipeline. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- Type
- annotations¶
Optional. User-defined annotations. See https://google.aip.dev/128#annotations.
- destinations¶
Required. List of destinations to which messages will be forwarded. Currently, exactly one destination is supported per Pipeline.
- Type
MutableSequence[google.cloud.eventarc_v1.types.Pipeline.Destination]
- mediations¶
Optional. List of mediation operations to be performed on the message. Currently, only one Transformation operation is allowed in each Pipeline.
- Type
MutableSequence[google.cloud.eventarc_v1.types.Pipeline.Mediation]
- crypto_key_name¶
Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt the event data. If not set, an internal Google-owned key will be used to encrypt messages. It must match the pattern “projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}”.
- Type
- input_payload_format¶
Optional. The payload format expected for the messages received by the Pipeline. If input_payload_format is set then any messages not matching this format will be treated as persistent errors. If input_payload_format is not set, then the message data will be treated as an opaque binary and no output format can be set on the Pipeline through the Pipeline.Destination.output_payload_format field. Any Mediations on the Pipeline that involve access to the data field will fail as persistent errors.
- logging_config¶
Optional. Config to control Platform Logging for Pipelines.
- retry_policy¶
Optional. The retry policy to use in the pipeline.
- etag¶
Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.
- Type
- class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class Destination(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a target of an invocation over HTTP.
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.
- network_config¶
Optional. Network config is used to configure how Pipeline resolves and connects to a destination.
- http_endpoint¶
Optional. An HTTP endpoint destination described by an URI. If a DNS FQDN is provided as the endpoint, Pipeline will create a peering zone to the consumer VPC and forward DNS requests to the VPC specified by network config to resolve the service endpoint. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones
This field is a member of oneof
destination_descriptor.
- workflow¶
Optional. The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the Pipeline. Format:
projects/{project}/locations/{location}/workflows/{workflow}This field is a member of oneof
destination_descriptor.- Type
- message_bus¶
Optional. The resource name of the Message Bus to which events should be published. The Message Bus resource should exist in the same project as the Pipeline. Format:
projects/{project}/locations/{location}/messageBuses/{message_bus}This field is a member of oneof
destination_descriptor.- Type
- topic¶
Optional. The resource name of the Pub/Sub topic to which events should be published. Format:
projects/{project}/locations/{location}/topics/{topic}This field is a member of oneof
destination_descriptor.- Type
- authentication_config¶
Optional. An authentication config used to authenticate message requests, such that destinations can verify the source. For example, this can be used with private GCP destinations that require GCP credentials to access like Cloud Run. This field is optional and should be set only by users interested in authenticated push
- output_payload_format¶
Optional. The message format before it is delivered to the destination. If not set, the message will be delivered in the format it was originally delivered to the Pipeline. This field can only be set if Pipeline.input_payload_format is also set.
- class AuthenticationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a config used to authenticate message requests.
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.
- google_oidc¶
Optional. This authenticate method will apply Google OIDC tokens signed by a GCP service account to the requests.
This field is a member of oneof
authentication_method_descriptor.
- oauth_token¶
Optional. If specified, an OAuth token will be generated and attached as an
Authorizationheader in the HTTP request.This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
This field is a member of oneof
authentication_method_descriptor.
- class OAuthToken(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageContains information needed for generating an OAuth token. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
- service_account¶
Required. Service account email used to generate the OAuth token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow Pipeline to create OAuth2 tokens for authenticated requests.
- Type
- scope¶
Optional. OAuth scope to be used for generating OAuth access token. If not specified, “https://www.googleapis.com/auth/cloud-platform” will be used.
- Type
- class OidcToken(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a config used to authenticate with a Google OIDC token using a GCP service account. Use this authentication method to invoke your Cloud Run and Cloud Functions destinations or HTTP endpoints that support Google OIDC.
- service_account¶
Required. Service account email used to generate the OIDC Token. The principal who calls this API must have iam.serviceAccounts.actAs permission in the service account. See https://cloud.google.com/iam/docs/understanding-service-accounts?hl=en#sa_common for more information. Eventarc service agents must have roles/roles/iam.serviceAccountTokenCreator role to allow the Pipeline to create OpenID tokens for authenticated requests.
- Type
- class HttpEndpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a HTTP endpoint destination.
- uri¶
Required. The URI of the HTTP enpdoint.
The value must be a RFC2396 URI string. Examples:
https://svc.us-central1.p.local:8080/route. Only the HTTPS protocol is supported.- Type
- message_binding_template¶
Optional. The CEL expression used to modify how the destination-bound HTTP request is constructed.
If a binding expression is not specified here, the message is treated as a CloudEvent and is mapped to the HTTP request according to the CloudEvent HTTP Protocol Binding Binary Content Mode. In this representation, all fields except the
dataanddatacontenttypefield on the message are mapped to HTTP request headers with a prefix ofce-.To construct the HTTP request payload and the value of the content-type HTTP header, the payload format is defined as follows:
Use the output_payload_format_type on the Pipeline.Destination if it is set, else:
Use the input_payload_format_type on the Pipeline if it is set, else:
Treat the payload as opaque binary data.
The
datafield of the message is converted to the payload format or left as-is for case 3) and then attached as the payload of the HTTP request. Thecontent-typeheader on the HTTP request is set to the payload format type or left empty for case 3). However, if a mediation has updated thedatacontenttypefield on the message so that it is not the same as the payload format type but it is still a prefix of the payload format type, then thecontent-typeheader on the HTTP request is set to thisdatacontenttypevalue. For example, if thedatacontenttypeis “application/json” and the payload format type is “application/json; charset=utf-8”, then thecontent-typeheader on the HTTP request is set to “application/json; charset=utf-8”.If a non-empty binding expression is specified then this expression is used to modify the default CloudEvent HTTP Protocol Binding Binary Content representation. The result of the CEL expression must be a map of key/value pairs which is used as follows:
If a map named
headersexists on the result of the expression, then its key/value pairs are directly mapped to the HTTP request headers. The headers values are constructed from the corresponding value type’s canonical representation. If theheadersfield doesn’t exist then the resulting HTTP request will be the headers of the CloudEvent HTTP Binding Binary Content Mode representation of the final message. Note: If the specified binding expression, has updated thedatacontenttypefield on the message so that it is not the same as the payload format type but it is still a prefix of the payload format type, then thecontent-typeheader in theheadersmap is set to thisdatacontenttypevalue.If a field named
bodyexists on the result of the expression then its value is directly mapped to the body of the request. If the value of thebodyfield is of type bytes or string then it is used for the HTTP request body as-is, with no conversion. If the body field is of any other type then it is converted to a JSON string. If the body field does not exist then the resulting payload of the HTTP request will be data value of the CloudEvent HTTP Binding Binary Content Mode representation of the final message as described earlier.Any other fields in the resulting expression will be ignored.
The CEL expression may access the incoming CloudEvent message in its definition, as follows:
The
datafield of the incoming CloudEvent message can be accessed using themessage.datavalue. Subfields ofmessage.datamay also be accessed if an input_payload_format has been specified on the Pipeline.Each attribute of the incoming CloudEvent message can be accessed using the
message.<key>value, where is replaced with the name of the attribute.Existing headers can be accessed in the CEL expression using the
headersvariable. Theheadersvariable defines a map of key/value pairs corresponding to the HTTP headers of the CloudEvent HTTP Binding Binary Content Mode representation of the final message as described earlier. For example, the following CEL expression can be used to construct an HTTP request by adding an additional header to the HTTP headers of the CloudEvent HTTP Binding Binary Content Mode representation of the final message and by overwriting the body of the request:
{ "headers": headers.merge({"new-header-key": "new-header-value"}), "body": "new-body" }
Additionally, the following CEL extension functions are provided for use in this CEL expression:
toBase64Url: map.toBase64Url() -> string
Converts a CelValue to a base64url encoded string
toJsonString: map.toJsonString() -> string
Converts a CelValue to a JSON string
merge: map1.merge(map2) -> map3
Merges the passed CEL map with the existing CEL map the function is applied to.
If the same key exists in both maps, if the key’s value is type map both maps are merged else the value from the passed map is used.
denormalize: map.denormalize() -> map
Denormalizes a CEL map such that every value of type map or key in the map is expanded to return a single level map.
The resulting keys are “.” separated indices of the map keys.
For example: { “a”: 1, “b”: { “c”: 2, “d”: 3 } “e”: [4, 5] } .denormalize() -> { “a”: 1, “b.c”: 2, “b.d”: 3, “e.0”: 4, “e.1”: 5 }
setField: map.setField(key, value) -> message
Sets the field of the message with the given key to the given value.
If the field is not present it will be added.
If the field is present it will be overwritten.
The key can be a dot separated path to set a field in a nested message.
Key must be of type string.
Value may be any valid type.
removeFields: map.removeFields([key1, key2, …]) -> message
Removes the fields of the map with the given keys.
The keys can be a dot separated path to remove a field in a nested message.
If a key is not found it will be ignored.
Keys must be of type string.
toMap: [map1, map2, …].toMap() -> map
Converts a CEL list of CEL maps to a single CEL map
toDestinationPayloadFormat(): message.data.toDestinationPayloadFormat() -> string or bytes
Converts the message data to the destination payload format specified in Pipeline.Destination.output_payload_format
This function is meant to be applied to the message.data field.
If the destination payload format is not set, the function will return the message data unchanged.
toCloudEventJsonWithPayloadFormat: message.toCloudEventJsonWithPayloadFormat() -> map
Converts a message to the corresponding structure of JSON format for CloudEvents
This function applies toDestinationPayloadFormat() to the message data. It also sets the corresponding datacontenttype of the CloudEvent, as indicated by Pipeline.Destination.output_payload_format. If no output_payload_format is set it will use the existing datacontenttype on the CloudEvent if present, else leave datacontenttype absent.
This function expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then this function will fail.
The result is a CEL map that corresponds to the JSON representation of the CloudEvent. To convert that data to a JSON string it can be chained with the toJsonString function.
The Pipeline expects that the message it receives adheres to the standard CloudEvent format. If it doesn’t then the outgoing message request may fail with a persistent error.
- Type
- class NetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a network config to be used for destination resolution and connectivity.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class Mediation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageMediation defines different ways to modify the Pipeline.
- transformation¶
Optional. How the Pipeline is to transform messages
This field is a member of oneof
mediation_descriptor.
- class Transformation(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageTransformation defines the way to transform an incoming message.
- transformation_template¶
Optional. The CEL expression template to apply to transform messages. The following CEL extension functions are provided for use in this CEL expression:
merge: map1.merge(map2) -> map3
Merges the passed CEL map with the existing CEL map the function is applied to.
If the same key exists in both maps, if the key’s value is type map both maps are merged else the value from the passed map is used.
denormalize: map.denormalize() -> map
Denormalizes a CEL map such that every value of type map or key in the map is expanded to return a single level map.
The resulting keys are “.” separated indices of the map keys.
For example: { “a”: 1, “b”: { “c”: 2, “d”: 3 } “e”: [4, 5] } .denormalize() -> { “a”: 1, “b.c”: 2, “b.d”: 3, “e.0”: 4, “e.1”: 5 }
setField: map.setField(key, value) -> message
Sets the field of the message with the given key to the given value.
If the field is not present it will be added.
If the field is present it will be overwritten.
The key can be a dot separated path to set a field in a nested message.
Key must be of type string.
Value may be any valid type.
removeFields: map.removeFields([key1, key2, …]) -> message
Removes the fields of the map with the given keys.
The keys can be a dot separated path to remove a field in a nested message.
If a key is not found it will be ignored.
Keys must be of type string.
toMap: [map1, map2, …].toMap() -> map
Converts a CEL list of CEL maps to a single CEL map
toDestinationPayloadFormat(): message.data.toDestinationPayloadFormat() -> string or bytes
Converts the message data to the destination payload format specified in Pipeline.Destination.output_payload_format
This function is meant to be applied to the message.data field.
If the destination payload format is not set, the function will return the message data unchanged.
toCloudEventJsonWithPayloadFormat: message.toCloudEventJsonWithPayloadFormat() -> map
Converts a message to the corresponding structure of JSON format for CloudEvents
This function applies toDestinationPayloadFormat() to the message data. It also sets the corresponding datacontenttype of the CloudEvent, as indicated by Pipeline.Destination.output_payload_format. If no output_payload_format is set it will use the existing datacontenttype on the CloudEvent if present, else leave datacontenttype absent.
This function expects that the content of the message will adhere to the standard CloudEvent format. If it doesn’t then this function will fail.
The result is a CEL map that corresponds to the JSON representation of the CloudEvent. To convert that data to a JSON string it can be chained with the toJsonString function.
- Type
- class MessagePayloadFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the format of message data.
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.
- class AvroFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe format of an AVRO message payload.
- class JsonFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe format of a JSON message payload.
- class ProtobufFormat(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe format of a Protobuf message payload.
- class RetryPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.). The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant.
- max_attempts¶
Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.
- Type
- min_retry_delay¶
Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 5.
- max_retry_delay¶
Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 60.
- class google.cloud.eventarc_v1.types.Provider(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of the Provider resource.
- name¶
Output only. In
projects/{project}/locations/{location}/providers/{provider_id}format.- Type
- display_name¶
Output only. Human friendly name for the Provider. For example “Cloud Storage”.
- Type
- event_types¶
Output only. Event types for this provider.
- Type
MutableSequence[google.cloud.eventarc_v1.types.EventType]
- class google.cloud.eventarc_v1.types.Pubsub(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a Pub/Sub transport.
- topic¶
Optional. The name of the Pub/Sub topic created and managed by Eventarc as a transport for the event delivery. Format:
projects/{PROJECT_ID}/topics/{TOPIC_NAME}.You can set an existing topic for triggers of the type
google.cloud.pubsub.topic.v1.messagePublished. The topic you provide here is not deleted by Eventarc at trigger deletion.- Type
- class google.cloud.eventarc_v1.types.StateCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA condition that is part of the trigger state computation.
- code¶
The canonical code of the condition.
- Type
google.rpc.code_pb2.Code
- class google.cloud.eventarc_v1.types.Transport(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the transport intermediaries created for the trigger to deliver events.
- class google.cloud.eventarc_v1.types.Trigger(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA representation of the trigger resource.
- name¶
Required. The resource name of the trigger. Must be unique within the location of the project and must be in
projects/{project}/locations/{location}/triggers/{trigger}format.- Type
- uid¶
Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
- Type
- create_time¶
Output only. The creation time.
- update_time¶
Output only. The last-modified time.
- event_filters¶
Required. Unordered list. The list of filters that applies to event attributes. Only events that match all the provided filters are sent to the destination.
- Type
MutableSequence[google.cloud.eventarc_v1.types.EventFilter]
- service_account¶
Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger.
The
iam.serviceAccounts.actAspermission must be granted on the service account to allow a principal to impersonate the service account. For more information, see the Roles and permissions page specific to the trigger destination.- Type
- destination¶
Required. Destination specifies where the events should be sent to.
- transport¶
Optional. To deliver messages, Eventarc might use other Google Cloud products as a transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes.
- labels¶
Optional. User labels attached to the triggers that can be used to group resources.
- channel¶
Optional. The name of the channel associated with the trigger in
projects/{project}/locations/{location}/channels/{channel}format. You must provide a channel to receive events from Eventarc SaaS partners.- Type
- conditions¶
Output only. The reason(s) why a trigger is in FAILED state.
- Type
MutableMapping[str, google.cloud.eventarc_v1.types.StateCondition]
- event_data_content_type¶
Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to
application/jsonif the value is not defined.- Type
- satisfies_pzs¶
Output only. Whether or not this Trigger satisfies the requirements of physical zone separation
- Type
- etag¶
Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding.
- Type
- class ConditionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class google.cloud.eventarc_v1.types.UpdateChannelRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the UpdateChannel method.
- channel¶
The channel to be updated.
- update_mask¶
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of “*”.
- class google.cloud.eventarc_v1.types.UpdateEnrollmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the UpdateEnrollment method.
- enrollment¶
Required. The Enrollment to be updated.
- update_mask¶
Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of “*”.
- allow_missing¶
Optional. If set to true, and the Enrollment is not found, a new Enrollment will be created. In this situation,
update_maskis ignored.- Type
- class google.cloud.eventarc_v1.types.UpdateGoogleApiSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the UpdateGoogleApiSource method.
- google_api_source¶
Required. The GoogleApiSource to be updated.
- update_mask¶
Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of “*”.
- allow_missing¶
Optional. If set to true, and the GoogleApiSource is not found, a new GoogleApiSource will be created. In this situation,
update_maskis ignored.- Type
- class google.cloud.eventarc_v1.types.UpdateGoogleChannelConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the UpdateGoogleChannelConfig method.
- google_channel_config¶
Required. The config to be updated.
- update_mask¶
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of “*”.
- class google.cloud.eventarc_v1.types.UpdateMessageBusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the UpdateMessageBus method.
- message_bus¶
Required. The MessageBus to be updated.
- update_mask¶
Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of “*”.
- allow_missing¶
Optional. If set to true, and the MessageBus is not found, a new MessageBus will be created. In this situation,
update_maskis ignored.- Type
- class google.cloud.eventarc_v1.types.UpdatePipelineRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the UpdatePipeline method.
- pipeline¶
Required. The Pipeline to be updated.
- update_mask¶
Optional. The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of “*”.
- allow_missing¶
Optional. If set to true, and the Pipeline is not found, a new Pipeline will be created. In this situation,
update_maskis ignored.- Type
- class google.cloud.eventarc_v1.types.UpdateTriggerRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe request message for the UpdateTrigger method.
- trigger¶
The trigger to be updated.
- update_mask¶
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of “*”.
- allow_missing¶
If set to true, and the trigger is not found, a new trigger will be created. In this situation,
update_maskis ignored.- Type
