Class EventarcClient (1.13.1)

Version 1.13.1

• 1.14.0 (latest)
• 1.13.2
• 1.12.0
• 1.11.5
• 1.10.0
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.2.4
• 0.1.0

EventarcClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.eventarc_v1.services.eventarc.transports.base.EventarcTransport, typing.Callable[[...], google.cloud.eventarc_v1.services.eventarc.transports.base.EventarcTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
str	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
EventarcTransport	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
str	The universe domain used by the client instance.

Methods

EventarcClient

EventarcClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.eventarc_v1.services.eventarc.transports.base.EventarcTransport, typing.Callable[[...], google.cloud.eventarc_v1.services.eventarc.transports.base.EventarcTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the eventarc client.

Parameters
Name	Description
credentials	Optional[google.auth.credentials.Credentials] The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Optional[Union[str,EventarcTransport,Callable[..., EventarcTransport]]] The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the EventarcTransport constructor. If set to None, a transport is chosen automatically.
client_options	Optional[Union[google.api_core.client_options.ClientOptions, dict]] Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

Warning: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	.operations_pb2.CancelOperationRequest The request object. Request message for CancelOperation method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

channel_connection_path

channel_connection_path(
    project: str, location: str, channel_connection: str
) -> str

Returns a fully-qualified channel_connection string.

channel_path

channel_path(project: str, location: str, channel: str) -> str

Returns a fully-qualified channel string.

cloud_function_path

cloud_function_path(project: str, location: str, function: str) -> str

Returns a fully-qualified cloud_function string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_channel

create_channel(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.CreateChannelRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    channel: typing.Optional[google.cloud.eventarc_v1.types.channel.Channel] = None,
    channel_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Create a new channel in a particular project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_create_channel():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    channel = eventarc_v1.Channel()
    channel.pubsub_topic = "pubsub_topic_value"
    channel.name = "name_value"

    request = eventarc_v1.CreateChannelRequest(
        parent="parent_value",
        channel=channel,
        channel_id="channel_id_value",
    )

    # Make the request
    operation = client.create_channel(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.CreateChannelRequest, dict] The request object. The request message for the CreateChannel method.
parent	str Required. The parent collection in which to add this channel. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
channel	google.cloud.eventarc_v1.types.Channel Required. The channel to create. This corresponds to the channel field on the request instance; if request is provided, this should not be set.
channel_id	str Required. The user-provided ID to be assigned to the channel. This corresponds to the channel_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Channel 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.

create_channel_connection

create_channel_connection(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.CreateChannelConnectionRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    channel_connection: typing.Optional[
        google.cloud.eventarc_v1.types.channel_connection.ChannelConnection
    ] = None,
    channel_connection_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Create a new ChannelConnection in a particular project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_create_channel_connection():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    channel_connection = eventarc_v1.ChannelConnection()
    channel_connection.name = "name_value"
    channel_connection.channel = "channel_value"

    request = eventarc_v1.CreateChannelConnectionRequest(
        parent="parent_value",
        channel_connection=channel_connection,
        channel_connection_id="channel_connection_id_value",
    )

    # Make the request
    operation = client.create_channel_connection(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.CreateChannelConnectionRequest, dict] The request object. The request message for the CreateChannelConnection method.
parent	str Required. The parent collection in which to add this channel connection. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
channel_connection	google.cloud.eventarc_v1.types.ChannelConnection Required. Channel connection to create. This corresponds to the channel_connection field on the request instance; if request is provided, this should not be set.
channel_connection_id	str Required. The user-provided ID to be assigned to the channel connection. This corresponds to the channel_connection_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

create_enrollment

create_enrollment(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.CreateEnrollmentRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    enrollment: typing.Optional[
        google.cloud.eventarc_v1.types.enrollment.Enrollment
    ] = None,
    enrollment_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Create a new Enrollment in a particular project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_create_enrollment():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    enrollment = eventarc_v1.Enrollment()
    enrollment.cel_match = "cel_match_value"
    enrollment.message_bus = "message_bus_value"
    enrollment.destination = "destination_value"

    request = eventarc_v1.CreateEnrollmentRequest(
        parent="parent_value",
        enrollment=enrollment,
        enrollment_id="enrollment_id_value",
    )

    # Make the request
    operation = client.create_enrollment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.CreateEnrollmentRequest, dict] The request object. The request message for the CreateEnrollment method.
parent	str Required. The parent collection in which to add this enrollment. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
enrollment	google.cloud.eventarc_v1.types.Enrollment Required. The enrollment to create. This corresponds to the enrollment field on the request instance; if request is provided, this should not be set.
enrollment_id	str 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]>__?$). This corresponds to the enrollment_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

create_google_api_source

create_google_api_source(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.CreateGoogleApiSourceRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    google_api_source: typing.Optional[
        google.cloud.eventarc_v1.types.google_api_source.GoogleApiSource
    ] = None,
    google_api_source_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Create a new GoogleApiSource in a particular project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_create_google_api_source():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    google_api_source = eventarc_v1.GoogleApiSource()
    google_api_source.destination = "destination_value"

    request = eventarc_v1.CreateGoogleApiSourceRequest(
        parent="parent_value",
        google_api_source=google_api_source,
        google_api_source_id="google_api_source_id_value",
    )

    # Make the request
    operation = client.create_google_api_source(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.CreateGoogleApiSourceRequest, dict] The request object. The request message for the CreateGoogleApiSource method.
parent	str Required. The parent collection in which to add this google api source. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
google_api_source	google.cloud.eventarc_v1.types.GoogleApiSource Required. The google api source to create. This corresponds to the google_api_source field on the request instance; if request is provided, this should not be set.
google_api_source_id	str 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]>__?$). This corresponds to the google_api_source_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be GoogleApiSource A GoogleApiSource represents a subscription of 1P events from a MessageBus.

create_message_bus

create_message_bus(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.CreateMessageBusRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    message_bus: typing.Optional[
        google.cloud.eventarc_v1.types.message_bus.MessageBus
    ] = None,
    message_bus_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Create a new MessageBus in a particular project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_create_message_bus():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.CreateMessageBusRequest(
        parent="parent_value",
        message_bus_id="message_bus_id_value",
    )

    # Make the request
    operation = client.create_message_bus(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.CreateMessageBusRequest, dict] The request object. The request message for the CreateMessageBus method.
parent	str Required. The parent collection in which to add this message bus. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
message_bus	google.cloud.eventarc_v1.types.MessageBus Required. The message bus to create. This corresponds to the message_bus field on the request instance; if request is provided, this should not be set.
message_bus_id	str 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]>__?$) This corresponds to the message_bus_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

create_pipeline

create_pipeline(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.CreatePipelineRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    pipeline: typing.Optional[google.cloud.eventarc_v1.types.pipeline.Pipeline] = None,
    pipeline_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Create a new Pipeline in a particular project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_create_pipeline():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    pipeline = eventarc_v1.Pipeline()
    pipeline.destinations.http_endpoint.uri = "uri_value"

    request = eventarc_v1.CreatePipelineRequest(
        parent="parent_value",
        pipeline=pipeline,
        pipeline_id="pipeline_id_value",
    )

    # Make the request
    operation = client.create_pipeline(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.CreatePipelineRequest, dict] The request object. The request message for the CreatePipeline method.
parent	str Required. The parent collection in which to add this pipeline. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
pipeline	google.cloud.eventarc_v1.types.Pipeline Required. The pipeline to create. This corresponds to the pipeline field on the request instance; if request is provided, this should not be set.
pipeline_id	str Required. The user-provided ID to be assigned to the Pipeline. This corresponds to the pipeline_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Pipeline A representation of the Pipeline resource.

create_trigger

create_trigger(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.CreateTriggerRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    trigger: typing.Optional[google.cloud.eventarc_v1.types.trigger.Trigger] = None,
    trigger_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Create a new trigger in a particular project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_create_trigger():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    trigger = eventarc_v1.Trigger()
    trigger.name = "name_value"
    trigger.event_filters.attribute = "attribute_value"
    trigger.event_filters.value = "value_value"
    trigger.destination.cloud_run.service = "service_value"
    trigger.destination.cloud_run.region = "region_value"

    request = eventarc_v1.CreateTriggerRequest(
        parent="parent_value",
        trigger=trigger,
        trigger_id="trigger_id_value",
    )

    # Make the request
    operation = client.create_trigger(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.CreateTriggerRequest, dict] The request object. The request message for the CreateTrigger method.
parent	str Required. The parent collection in which to add this trigger. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
trigger	google.cloud.eventarc_v1.types.Trigger Required. The trigger to create. This corresponds to the trigger field on the request instance; if request is provided, this should not be set.
trigger_id	str Required. The user-provided ID to be assigned to the trigger. This corresponds to the trigger_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Trigger A representation of the trigger resource.

crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

delete_channel

delete_channel(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.DeleteChannelRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Delete a single channel.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_delete_channel():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.DeleteChannelRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_channel(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.DeleteChannelRequest, dict] The request object. The request message for the DeleteChannel method.
name	str Required. The name of the channel to be deleted. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Channel 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.

delete_channel_connection

delete_channel_connection(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.DeleteChannelConnectionRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Delete a single ChannelConnection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_delete_channel_connection():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.DeleteChannelConnectionRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_channel_connection(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.DeleteChannelConnectionRequest, dict] The request object. The request message for the DeleteChannelConnection method.
name	str Required. The name of the channel connection to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

delete_enrollment

delete_enrollment(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.DeleteEnrollmentRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    etag: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Delete a single Enrollment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_delete_enrollment():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.DeleteEnrollmentRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_enrollment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.DeleteEnrollmentRequest, dict] The request object. The request message for the DeleteEnrollment method.
name	str Required. The name of the Enrollment to be deleted. This corresponds to the name field on the request instance; if request is provided, this should not be set.
etag	str Optional. If provided, the Enrollment will only be deleted if the etag matches the current etag on the resource. This corresponds to the etag field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

delete_google_api_source

delete_google_api_source(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.DeleteGoogleApiSourceRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    etag: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Delete a single GoogleApiSource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_delete_google_api_source():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.DeleteGoogleApiSourceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_google_api_source(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.DeleteGoogleApiSourceRequest, dict] The request object. The request message for the DeleteGoogleApiSource method.
name	str Required. The name of the GoogleApiSource to be deleted. This corresponds to the name field on the request instance; if request is provided, this should not be set.
etag	str Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource. This corresponds to the etag field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be GoogleApiSource A GoogleApiSource represents a subscription of 1P events from a MessageBus.

delete_message_bus

delete_message_bus(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.DeleteMessageBusRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    etag: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Delete a single message bus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_delete_message_bus():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.DeleteMessageBusRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_message_bus(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.DeleteMessageBusRequest, dict] The request object. The request message for the DeleteMessageBus method.
name	str Required. The name of the MessageBus to be deleted. This corresponds to the name field on the request instance; if request is provided, this should not be set.
etag	str Optional. If provided, the MessageBus will only be deleted if the etag matches the current etag on the resource. This corresponds to the etag field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	.operations_pb2.DeleteOperationRequest The request object. Request message for DeleteOperation method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

delete_pipeline

delete_pipeline(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.DeletePipelineRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    etag: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Delete a single pipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_delete_pipeline():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.DeletePipelineRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_pipeline(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.DeletePipelineRequest, dict] The request object. The request message for the DeletePipeline method.
name	str Required. The name of the Pipeline to be deleted. This corresponds to the name field on the request instance; if request is provided, this should not be set.
etag	str Optional. If provided, the Pipeline will only be deleted if the etag matches the current etag on the resource. This corresponds to the etag field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Pipeline A representation of the Pipeline resource.

delete_trigger

delete_trigger(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.DeleteTriggerRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    allow_missing: typing.Optional[bool] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Delete a single trigger.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_delete_trigger():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.DeleteTriggerRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_trigger(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.DeleteTriggerRequest, dict] The request object. The request message for the DeleteTrigger method.
name	str Required. The name of the trigger to be deleted. This corresponds to the name field on the request instance; if request is provided, this should not be set.
allow_missing	bool If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server. This corresponds to the allow_missing field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Trigger A representation of the trigger resource.

enrollment_path

enrollment_path(project: str, location: str, enrollment: str) -> str

Returns a fully-qualified enrollment string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
EventarcClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
info	dict The service account private key info.

Returns
Type	Description
EventarcClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
EventarcClient	The constructed client.

get_channel

get_channel(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.GetChannelRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.channel.Channel

Get a single Channel.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_channel():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetChannelRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_channel(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetChannelRequest, dict] The request object. The request message for the GetChannel method.
name	str Required. The name of the channel to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.Channel	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.

get_channel_connection

get_channel_connection(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.GetChannelConnectionRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.channel_connection.ChannelConnection

Get a single ChannelConnection.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_channel_connection():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetChannelConnectionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_channel_connection(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetChannelConnectionRequest, dict] The request object. The request message for the GetChannelConnection method.
name	str Required. The name of the channel connection to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.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.

get_enrollment

get_enrollment(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.GetEnrollmentRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.enrollment.Enrollment

Get a single Enrollment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_enrollment():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetEnrollmentRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_enrollment(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetEnrollmentRequest, dict] The request object. The request message for the GetEnrollment method.
name	str Required. The name of the Enrollment to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.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.

get_google_api_source

get_google_api_source(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.GetGoogleApiSourceRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.google_api_source.GoogleApiSource

Get a single GoogleApiSource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_google_api_source():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetGoogleApiSourceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_google_api_source(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetGoogleApiSourceRequest, dict] The request object. The request message for the GetGoogleApiSource method.
name	str Required. The name of the google api source to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.GoogleApiSource	A GoogleApiSource represents a subscription of 1P events from a MessageBus.

get_google_channel_config

get_google_channel_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.GetGoogleChannelConfigRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.google_channel_config.GoogleChannelConfig

Get a GoogleChannelConfig

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_google_channel_config():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetGoogleChannelConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_google_channel_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetGoogleChannelConfigRequest, dict] The request object. The request message for the GetGoogleChannelConfig method.
name	str Required. The name of the config to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.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.

get_iam_policy

get_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters
Name	Description
request	.iam_policy_pb2.GetIamPolicyRequest The request object. Request message for GetIamPolicy method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.policy_pb2.Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:[e-mail]"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:[e-mail]="" -="" group:[e-mail]="" -="" domain:google.com="" -="" serviceaccount:[e-mail]="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:[e-mail]="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name	Description
request	.location_pb2.GetLocationRequest The request object. Request message for GetLocation method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.location_pb2.Location	Location object.

get_message_bus

get_message_bus(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.GetMessageBusRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.message_bus.MessageBus

Get a single MessageBus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_message_bus():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetMessageBusRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_message_bus(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetMessageBusRequest, dict] The request object. The request message for the GetMessageBus method.
name	str Required. The name of the message bus to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.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.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
client_options	google.api_core.client_options.ClientOptions Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns
Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
request	.operations_pb2.GetOperationRequest The request object. Request message for GetOperation method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.operations_pb2.Operation	An Operation object.

get_pipeline

get_pipeline(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.GetPipelineRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.pipeline.Pipeline

Get a single Pipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_pipeline():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetPipelineRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_pipeline(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetPipelineRequest, dict] The request object. The request message for the GetPipeline method.
name	str Required. The name of the pipeline to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.Pipeline	A representation of the Pipeline resource.

get_provider

get_provider(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.GetProviderRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.discovery.Provider

Get a single Provider.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_provider():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetProviderRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_provider(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetProviderRequest, dict] The request object. The request message for the GetProvider method.
name	str Required. The name of the provider to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.Provider	A representation of the Provider resource.

get_trigger

get_trigger(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.GetTriggerRequest, dict]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.trigger.Trigger

Get a single trigger.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_get_trigger():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.GetTriggerRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_trigger(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.GetTriggerRequest, dict] The request object. The request message for the GetTrigger method.
name	str Required. The name of the trigger to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.Trigger	A representation of the trigger resource.

google_api_source_path

google_api_source_path(project: str, location: str, google_api_source: str) -> str

Returns a fully-qualified google_api_source string.

google_channel_config_path

google_channel_config_path(project: str, location: str) -> str

Returns a fully-qualified google_channel_config string.

list_channel_connections

list_channel_connections(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.ListChannelConnectionsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListChannelConnectionsPager

List channel connections.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_channel_connections():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListChannelConnectionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_channel_connections(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListChannelConnectionsRequest, dict] The request object. The request message for the ListChannelConnections method.
parent	str Required. The parent collection from which to list channel connections. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListChannelConnectionsPager	The response message for the ListChannelConnections method. Iterating over this object will yield results and resolve additional pages automatically.

list_channels

list_channels(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.ListChannelsRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListChannelsPager

List channels.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_channels():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListChannelsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_channels(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListChannelsRequest, dict] The request object. The request message for the ListChannels method.
parent	str Required. The parent collection to list channels on. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListChannelsPager	The response message for the ListChannels method. Iterating over this object will yield results and resolve additional pages automatically.

list_enrollments

list_enrollments(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.ListEnrollmentsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListEnrollmentsPager

List Enrollments.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_enrollments():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListEnrollmentsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_enrollments(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListEnrollmentsRequest, dict] The request object. The request message for the ListEnrollments method.
parent	str Required. The parent collection to list triggers on. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListEnrollmentsPager	The response message for the ListEnrollments method. Iterating over this object will yield results and resolve additional pages automatically.

list_google_api_sources

list_google_api_sources(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.ListGoogleApiSourcesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListGoogleApiSourcesPager

List GoogleApiSources.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_google_api_sources():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListGoogleApiSourcesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_google_api_sources(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListGoogleApiSourcesRequest, dict] The request object. The request message for the ListGoogleApiSources method.
parent	str Required. The parent collection to list GoogleApiSources on. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListGoogleApiSourcesPager	The response message for the ListGoogleApiSources method. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name	Description
request	.location_pb2.ListLocationsRequest The request object. Request message for ListLocations method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.location_pb2.ListLocationsResponse	Response message for ListLocations method.

list_message_bus_enrollments

list_message_bus_enrollments(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.ListMessageBusEnrollmentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListMessageBusEnrollmentsPager

List message bus enrollments.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_message_bus_enrollments():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListMessageBusEnrollmentsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_message_bus_enrollments(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListMessageBusEnrollmentsRequest, dict] The request object. The request message for the ListMessageBusEnrollments method.
parent	str Required. The parent message bus to list enrollments on. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListMessageBusEnrollmentsPager	The response message for the ListMessageBusEnrollments method.\` Iterating over this object will yield results and resolve additional pages automatically.

list_message_buses

list_message_buses(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.ListMessageBusesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListMessageBusesPager

List message buses.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_message_buses():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListMessageBusesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_message_buses(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListMessageBusesRequest, dict] The request object. The request message for the ListMessageBuses method.
parent	str Required. The parent collection to list triggers on. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListMessageBusesPager	The response message for the ListMessageBuses method. Iterating over this object will yield results and resolve additional pages automatically.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name	Description
request	.operations_pb2.ListOperationsRequest The request object. Request message for ListOperations method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.operations_pb2.ListOperationsResponse	Response message for ListOperations method.

list_pipelines

list_pipelines(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.ListPipelinesRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListPipelinesPager

List pipelines.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_pipelines():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListPipelinesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_pipelines(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListPipelinesRequest, dict] The request object. The request message for the ListPipelines method.
parent	str Required. The parent collection to list pipelines on. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListPipelinesPager	The response message for the ListPipelines method. Iterating over this object will yield results and resolve additional pages automatically.

list_providers

list_providers(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.ListProvidersRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListProvidersPager

List providers.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_providers():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListProvidersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_providers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListProvidersRequest, dict] The request object. The request message for the ListProviders method.
parent	str Required. The parent of the provider to get. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListProvidersPager	The response message for the ListProviders method. Iterating over this object will yield results and resolve additional pages automatically.

list_triggers

list_triggers(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.ListTriggersRequest, dict]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.services.eventarc.pagers.ListTriggersPager

List triggers.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_list_triggers():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.ListTriggersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_triggers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.ListTriggersRequest, dict] The request object. The request message for the ListTriggers method.
parent	str Required. The parent collection to list triggers on. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.services.eventarc.pagers.ListTriggersPager	The response message for the ListTriggers method. Iterating over this object will yield results and resolve additional pages automatically.

message_bus_path

message_bus_path(project: str, location: str, message_bus: str) -> str

Returns a fully-qualified message_bus string.

network_attachment_path

network_attachment_path(project: str, region: str, networkattachment: str) -> str

Returns a fully-qualified network_attachment string.

parse_channel_connection_path

parse_channel_connection_path(path: str) -> typing.Dict[str, str]

Parses a channel_connection path into its component segments.

parse_channel_path

parse_channel_path(path: str) -> typing.Dict[str, str]

Parses a channel path into its component segments.

parse_cloud_function_path

parse_cloud_function_path(path: str) -> typing.Dict[str, str]

Parses a cloud_function path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_crypto_key_path

parse_crypto_key_path(path: str) -> typing.Dict[str, str]

Parses a crypto_key path into its component segments.

parse_enrollment_path

parse_enrollment_path(path: str) -> typing.Dict[str, str]

Parses a enrollment path into its component segments.

parse_google_api_source_path

parse_google_api_source_path(path: str) -> typing.Dict[str, str]

Parses a google_api_source path into its component segments.

parse_google_channel_config_path

parse_google_channel_config_path(path: str) -> typing.Dict[str, str]

Parses a google_channel_config path into its component segments.

parse_message_bus_path

parse_message_bus_path(path: str) -> typing.Dict[str, str]

Parses a message_bus path into its component segments.

parse_network_attachment_path

parse_network_attachment_path(path: str) -> typing.Dict[str, str]

Parses a network_attachment path into its component segments.

parse_pipeline_path

parse_pipeline_path(path: str) -> typing.Dict[str, str]

Parses a pipeline path into its component segments.

parse_provider_path

parse_provider_path(path: str) -> typing.Dict[str, str]

Parses a provider path into its component segments.

parse_service_account_path

parse_service_account_path(path: str) -> typing.Dict[str, str]

Parses a service_account path into its component segments.

parse_service_path

parse_service_path(path: str) -> typing.Dict[str, str]

Parses a service path into its component segments.

parse_topic_path

parse_topic_path(path: str) -> typing.Dict[str, str]

Parses a topic path into its component segments.

parse_trigger_path

parse_trigger_path(path: str) -> typing.Dict[str, str]

Parses a trigger path into its component segments.

parse_workflow_path

parse_workflow_path(path: str) -> typing.Dict[str, str]

Parses a workflow path into its component segments.

pipeline_path

pipeline_path(project: str, location: str, pipeline: str) -> str

Returns a fully-qualified pipeline string.

provider_path

provider_path(project: str, location: str, provider: str) -> str

Returns a fully-qualified provider string.

service_account_path

service_account_path(project: str, service_account: str) -> str

Returns a fully-qualified service_account string.

service_path

service_path() -> str

Returns a fully-qualified service string.

set_iam_policy

set_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters
Name	Description
request	.iam_policy_pb2.SetIamPolicyRequest The request object. Request message for SetIamPolicy method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.policy_pb2.Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:[e-mail]"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:[e-mail]="" -="" group:[e-mail]="" -="" domain:google.com="" -="" serviceaccount:[e-mail]="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:[e-mail]="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters
Name	Description
request	.iam_policy_pb2.TestIamPermissionsRequest The request object. Request message for TestIamPermissions method.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
.iam_policy_pb2.TestIamPermissionsResponse	Response message for TestIamPermissions method.

topic_path

topic_path(project: str, topic: str) -> str

Returns a fully-qualified topic string.

trigger_path

trigger_path(project: str, location: str, trigger: str) -> str

Returns a fully-qualified trigger string.

update_channel

update_channel(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.UpdateChannelRequest, dict]
    ] = None,
    *,
    channel: typing.Optional[google.cloud.eventarc_v1.types.channel.Channel] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Update a single channel.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_update_channel():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.UpdateChannelRequest(
    )

    # Make the request
    operation = client.update_channel(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.UpdateChannelRequest, dict] The request object. The request message for the UpdateChannel method.
channel	google.cloud.eventarc_v1.types.Channel The channel to be updated. This corresponds to the channel field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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 "*". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Channel 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.

update_enrollment

update_enrollment(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.UpdateEnrollmentRequest, dict
        ]
    ] = None,
    *,
    enrollment: typing.Optional[
        google.cloud.eventarc_v1.types.enrollment.Enrollment
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Update a single Enrollment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_update_enrollment():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    enrollment = eventarc_v1.Enrollment()
    enrollment.cel_match = "cel_match_value"
    enrollment.message_bus = "message_bus_value"
    enrollment.destination = "destination_value"

    request = eventarc_v1.UpdateEnrollmentRequest(
        enrollment=enrollment,
    )

    # Make the request
    operation = client.update_enrollment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.UpdateEnrollmentRequest, dict] The request object. The request message for the UpdateEnrollment method.
enrollment	google.cloud.eventarc_v1.types.Enrollment Required. The Enrollment to be updated. This corresponds to the enrollment field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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 "*". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

update_google_api_source

update_google_api_source(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.UpdateGoogleApiSourceRequest, dict
        ]
    ] = None,
    *,
    google_api_source: typing.Optional[
        google.cloud.eventarc_v1.types.google_api_source.GoogleApiSource
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Update a single GoogleApiSource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_update_google_api_source():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    google_api_source = eventarc_v1.GoogleApiSource()
    google_api_source.destination = "destination_value"

    request = eventarc_v1.UpdateGoogleApiSourceRequest(
        google_api_source=google_api_source,
    )

    # Make the request
    operation = client.update_google_api_source(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.UpdateGoogleApiSourceRequest, dict] The request object. The request message for the UpdateGoogleApiSource method.
google_api_source	google.cloud.eventarc_v1.types.GoogleApiSource Required. The GoogleApiSource to be updated. This corresponds to the google_api_source field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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 "*". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be GoogleApiSource A GoogleApiSource represents a subscription of 1P events from a MessageBus.

update_google_channel_config

update_google_channel_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.UpdateGoogleChannelConfigRequest,
            dict,
        ]
    ] = None,
    *,
    google_channel_config: typing.Optional[
        google.cloud.eventarc_v1.types.google_channel_config.GoogleChannelConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.eventarc_v1.types.google_channel_config.GoogleChannelConfig

Update a single GoogleChannelConfig

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_update_google_channel_config():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    google_channel_config = eventarc_v1.GoogleChannelConfig()
    google_channel_config.name = "name_value"

    request = eventarc_v1.UpdateGoogleChannelConfigRequest(
        google_channel_config=google_channel_config,
    )

    # Make the request
    response = client.update_google_channel_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.UpdateGoogleChannelConfigRequest, dict] The request object. The request message for the UpdateGoogleChannelConfig method.
google_channel_config	google.cloud.eventarc_v1.types.GoogleChannelConfig Required. The config to be updated. This corresponds to the google_channel_config field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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 "*". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.eventarc_v1.types.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.

update_message_bus

update_message_bus(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.UpdateMessageBusRequest, dict
        ]
    ] = None,
    *,
    message_bus: typing.Optional[
        google.cloud.eventarc_v1.types.message_bus.MessageBus
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Update a single message bus.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_update_message_bus():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.UpdateMessageBusRequest(
    )

    # Make the request
    operation = client.update_message_bus(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.UpdateMessageBusRequest, dict] The request object. The request message for the UpdateMessageBus method.
message_bus	google.cloud.eventarc_v1.types.MessageBus Required. The MessageBus to be updated. This corresponds to the message_bus field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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 "*". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

update_pipeline

update_pipeline(
    request: typing.Optional[
        typing.Union[
            google.cloud.eventarc_v1.types.eventarc.UpdatePipelineRequest, dict
        ]
    ] = None,
    *,
    pipeline: typing.Optional[google.cloud.eventarc_v1.types.pipeline.Pipeline] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Update a single pipeline.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_update_pipeline():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    pipeline = eventarc_v1.Pipeline()
    pipeline.destinations.http_endpoint.uri = "uri_value"

    request = eventarc_v1.UpdatePipelineRequest(
        pipeline=pipeline,
    )

    # Make the request
    operation = client.update_pipeline(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.UpdatePipelineRequest, dict] The request object. The request message for the UpdatePipeline method.
pipeline	google.cloud.eventarc_v1.types.Pipeline Required. The Pipeline to be updated. This corresponds to the pipeline field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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 "*". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Pipeline A representation of the Pipeline resource.

update_trigger

update_trigger(
    request: typing.Optional[
        typing.Union[google.cloud.eventarc_v1.types.eventarc.UpdateTriggerRequest, dict]
    ] = None,
    *,
    trigger: typing.Optional[google.cloud.eventarc_v1.types.trigger.Trigger] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    allow_missing: typing.Optional[bool] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Update a single trigger.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import eventarc_v1

def sample_update_trigger():
    # Create a client
    client = eventarc_v1.EventarcClient()

    # Initialize request argument(s)
    request = eventarc_v1.UpdateTriggerRequest(
    )

    # Make the request
    operation = client.update_trigger(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.eventarc_v1.types.UpdateTriggerRequest, dict] The request object. The request message for the UpdateTrigger method.
trigger	google.cloud.eventarc_v1.types.Trigger The trigger to be updated. This corresponds to the trigger field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask 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 "*". This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
allow_missing	bool If set to true, and the trigger is not found, a new trigger will be created. In this situation, update_mask is ignored. This corresponds to the allow_missing field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be Trigger A representation of the trigger resource.

workflow_path

workflow_path(project: str, location: str, workflow: str) -> str

Returns a fully-qualified workflow string.