Package Classes (1.14.0)

Summary of entries of Classes for eventarc.

Classes

EventarcAsyncClient

Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

EventarcClient

Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

ListChannelConnectionsAsyncPager

A pager for iterating through list_channel_connections requests.

This class thinly wraps an initial ListChannelConnectionsResponse object, and provides an __aiter__ method to iterate through its channel_connections field.

If there are more pages, the __aiter__ method will make additional ListChannelConnections requests and continue to iterate through the channel_connections field on the corresponding responses.

All the usual ListChannelConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChannelConnectionsPager

A pager for iterating through list_channel_connections requests.

This class thinly wraps an initial ListChannelConnectionsResponse object, and provides an __iter__ method to iterate through its channel_connections field.

If there are more pages, the __iter__ method will make additional ListChannelConnections requests and continue to iterate through the channel_connections field on the corresponding responses.

All the usual ListChannelConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChannelsAsyncPager

A pager for iterating through list_channels requests.

This class thinly wraps an initial ListChannelsResponse object, and provides an __aiter__ method to iterate through its channels field.

If there are more pages, the __aiter__ method will make additional ListChannels requests and continue to iterate through the channels field on the corresponding responses.

All the usual ListChannelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChannelsPager

A pager for iterating through list_channels requests.

This class thinly wraps an initial ListChannelsResponse object, and provides an __iter__ method to iterate through its channels field.

If there are more pages, the __iter__ method will make additional ListChannels requests and continue to iterate through the channels field on the corresponding responses.

All the usual ListChannelsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnrollmentsAsyncPager

A pager for iterating through list_enrollments requests.

This class thinly wraps an initial ListEnrollmentsResponse object, and provides an __aiter__ method to iterate through its enrollments field.

If there are more pages, the __aiter__ method will make additional ListEnrollments requests and continue to iterate through the enrollments field on the corresponding responses.

All the usual ListEnrollmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnrollmentsPager

A pager for iterating through list_enrollments requests.

This class thinly wraps an initial ListEnrollmentsResponse object, and provides an __iter__ method to iterate through its enrollments field.

If there are more pages, the __iter__ method will make additional ListEnrollments requests and continue to iterate through the enrollments field on the corresponding responses.

All the usual ListEnrollmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGoogleApiSourcesAsyncPager

A pager for iterating through list_google_api_sources requests.

This class thinly wraps an initial ListGoogleApiSourcesResponse object, and provides an __aiter__ method to iterate through its google_api_sources field.

If there are more pages, the __aiter__ method will make additional ListGoogleApiSources requests and continue to iterate through the google_api_sources field on the corresponding responses.

All the usual ListGoogleApiSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGoogleApiSourcesPager

A pager for iterating through list_google_api_sources requests.

This class thinly wraps an initial ListGoogleApiSourcesResponse object, and provides an __iter__ method to iterate through its google_api_sources field.

If there are more pages, the __iter__ method will make additional ListGoogleApiSources requests and continue to iterate through the google_api_sources field on the corresponding responses.

All the usual ListGoogleApiSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListMessageBusEnrollmentsAsyncPager

A pager for iterating through list_message_bus_enrollments requests.

This class thinly wraps an initial ListMessageBusEnrollmentsResponse object, and provides an __aiter__ method to iterate through its enrollments field.

If there are more pages, the __aiter__ method will make additional ListMessageBusEnrollments requests and continue to iterate through the enrollments field on the corresponding responses.

All the usual ListMessageBusEnrollmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListMessageBusEnrollmentsPager

A pager for iterating through list_message_bus_enrollments requests.

This class thinly wraps an initial ListMessageBusEnrollmentsResponse object, and provides an __iter__ method to iterate through its enrollments field.

If there are more pages, the __iter__ method will make additional ListMessageBusEnrollments requests and continue to iterate through the enrollments field on the corresponding responses.

All the usual ListMessageBusEnrollmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListMessageBusesAsyncPager

A pager for iterating through list_message_buses requests.

This class thinly wraps an initial ListMessageBusesResponse object, and provides an __aiter__ method to iterate through its message_buses field.

If there are more pages, the __aiter__ method will make additional ListMessageBuses requests and continue to iterate through the message_buses field on the corresponding responses.

All the usual ListMessageBusesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListMessageBusesPager

A pager for iterating through list_message_buses requests.

This class thinly wraps an initial ListMessageBusesResponse object, and provides an __iter__ method to iterate through its message_buses field.

If there are more pages, the __iter__ method will make additional ListMessageBuses requests and continue to iterate through the message_buses field on the corresponding responses.

All the usual ListMessageBusesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPipelinesAsyncPager

A pager for iterating through list_pipelines requests.

This class thinly wraps an initial ListPipelinesResponse object, and provides an __aiter__ method to iterate through its pipelines field.

If there are more pages, the __aiter__ method will make additional ListPipelines requests and continue to iterate through the pipelines field on the corresponding responses.

All the usual ListPipelinesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPipelinesPager

A pager for iterating through list_pipelines requests.

This class thinly wraps an initial ListPipelinesResponse object, and provides an __iter__ method to iterate through its pipelines field.

If there are more pages, the __iter__ method will make additional ListPipelines requests and continue to iterate through the pipelines field on the corresponding responses.

All the usual ListPipelinesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProvidersAsyncPager

A pager for iterating through list_providers requests.

This class thinly wraps an initial ListProvidersResponse object, and provides an __aiter__ method to iterate through its providers field.

If there are more pages, the __aiter__ method will make additional ListProviders requests and continue to iterate through the providers field on the corresponding responses.

All the usual ListProvidersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListProvidersPager

A pager for iterating through list_providers requests.

This class thinly wraps an initial ListProvidersResponse object, and provides an __iter__ method to iterate through its providers field.

If there are more pages, the __iter__ method will make additional ListProviders requests and continue to iterate through the providers field on the corresponding responses.

All the usual ListProvidersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTriggersAsyncPager

A pager for iterating through list_triggers requests.

This class thinly wraps an initial ListTriggersResponse object, and provides an __aiter__ method to iterate through its triggers field.

If there are more pages, the __aiter__ method will make additional ListTriggers requests and continue to iterate through the triggers field on the corresponding responses.

All the usual ListTriggersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListTriggersPager

A pager for iterating through list_triggers requests.

This class thinly wraps an initial ListTriggersResponse object, and provides an __iter__ method to iterate through its triggers field.

If there are more pages, the __iter__ method will make additional ListTriggers requests and continue to iterate through the triggers field on the corresponding responses.

All the usual ListTriggersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

State lists all the possible states of a Channel

    1. The SaaS provider disconnected from this
        Channel.
    2. 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.

ChannelConnection

A 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.

CloudRun

Represents a Cloud Run destination.

CreateChannelConnectionRequest

The request message for the CreateChannelConnection method.

CreateChannelRequest

The request message for the CreateChannel method.

CreateEnrollmentRequest

The request message for the CreateEnrollment method.

CreateGoogleApiSourceRequest

The request message for the CreateGoogleApiSource method.

CreateMessageBusRequest

The request message for the CreateMessageBus method.

CreatePipelineRequest

The request message for the CreatePipeline method.

CreateTriggerRequest

The request message for the CreateTrigger method.

DeleteChannelConnectionRequest

The request message for the DeleteChannelConnection method.

DeleteChannelRequest

The request message for the DeleteChannel method.

DeleteEnrollmentRequest

The request message for the DeleteEnrollment method.

DeleteGoogleApiSourceRequest

The request message for the DeleteGoogleApiSource method.

DeleteMessageBusRequest

The request message for the DeleteMessageBus method.

DeletePipelineRequest

The request message for the DeletePipeline method.

DeleteTriggerRequest

The request message for the DeleteTrigger method.

Destination

Represents 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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Enrollment

An 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.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

EventFilter

Filters events based on exact matches on the CloudEvents attributes.

EventType

A representation of the event type resource.

FilteringAttribute

A representation of the FilteringAttribute resource. Filtering attributes are per event type.

GKE

Represents a GKE destination.

GetChannelConnectionRequest

The request message for the GetChannelConnection method.

GetChannelRequest

The request message for the GetChannel method.

GetEnrollmentRequest

The request message for the GetEnrollment method.

GetGoogleApiSourceRequest

The request message for the GetGoogleApiSource method.

GetGoogleChannelConfigRequest

The request message for the GetGoogleChannelConfig method.

GetMessageBusRequest

The request message for the GetMessageBus method.

GetPipelineRequest

The request message for the GetPipeline method.

GetProviderRequest

The request message for the GetProvider method.

GetTriggerRequest

The request message for the GetTrigger method.

GoogleApiSource

A GoogleApiSource represents a subscription of 1P events from a MessageBus.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

GoogleChannelConfig

A 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.

HttpEndpoint

Represents a HTTP endpoint destination.

ListChannelConnectionsRequest

The request message for the ListChannelConnections method.

ListChannelConnectionsResponse

The response message for the ListChannelConnections method.

ListChannelsRequest

The request message for the ListChannels method.

ListChannelsResponse

The response message for the ListChannels method.

ListEnrollmentsRequest

The request message for the ListEnrollments method.

ListEnrollmentsResponse

The response message for the ListEnrollments method.

ListGoogleApiSourcesRequest

The request message for the ListGoogleApiSources method.

ListGoogleApiSourcesResponse

The response message for the ListGoogleApiSources method.

ListMessageBusEnrollmentsRequest

The request message for the ListMessageBusEnrollments method.

ListMessageBusEnrollmentsResponse

The response message for the ListMessageBusEnrollments method.`

ListMessageBusesRequest

The request message for the ListMessageBuses method.

ListMessageBusesResponse

The response message for the ListMessageBuses method.

ListPipelinesRequest

The request message for the ListPipelines method.

ListPipelinesResponse

The response message for the ListPipelines method.

ListProvidersRequest

The request message for the ListProviders method.

ListProvidersResponse

The response message for the ListProviders method.

ListTriggersRequest

The request message for the ListTriggers method.

ListTriggersResponse

The response message for the ListTriggers method.

LoggingConfig

The configuration for Platform Telemetry logging for Eventarc Advanced resources.

LogSeverity

The 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.

MessageBus

MessageBus 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.

AnnotationsEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

NetworkConfig

Network Configuration that can be inherited by other protos.

OperationMetadata

Represents the metadata of the long-running operation.

Pipeline

A representation of the Pipeline resource.

AnnotationsEntry

The abstract base class for a message.

Destination

Represents a target of an invocation over HTTP.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AuthenticationConfig

Represents a config used to authenticate message requests.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OAuthToken

Contains information needed for generating an OAuth token <https://developers.google.com/identity/protocols/OAuth2>__. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

OidcToken

Represents 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.

HttpEndpoint

Represents a HTTP endpoint destination.

NetworkConfig

Represents a network config to be used for destination resolution and connectivity.

LabelsEntry

The abstract base class for a message.

Mediation

Mediation defines different ways to modify the Pipeline.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Transformation

Transformation defines the way to transform an incoming message.

MessagePayloadFormat

Represents the format of message data.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AvroFormat

The format of an AVRO message payload.

JsonFormat

The format of a JSON message payload.

ProtobufFormat

The format of a Protobuf message payload.

RetryPolicy

The 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.

Modules

pagers

API documentation for eventarc_v1.services.eventarc.pagers module.