Class EventarcAsyncClient (0.2.4)

EventarcAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.eventarc_v1.services.eventarc.transports.base.EventarcTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-eventarc/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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

transport

Returns the transport used by the client instance.

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

Methods

EventarcAsyncClient

EventarcAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.eventarc_v1.services.eventarc.transports.base.EventarcTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-eventarc/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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`	`Union[str, .EventarcTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.

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

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_trigger

create_trigger(request: Optional[google.cloud.eventarc_v1.types.eventarc.CreateTriggerRequest] = None, *, parent: Optional[str] = None, trigger: Optional[google.cloud.eventarc_v1.types.trigger.Trigger] = None, trigger_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a new trigger in a particular project and location.

Parameters
Name	Description
`request`	`CreateTriggerRequest` 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`	`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_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Trigger A representation of the trigger resource.

delete_trigger

delete_trigger(request: Optional[google.cloud.eventarc_v1.types.eventarc.DeleteTriggerRequest] = None, *, name: Optional[str] = None, allow_missing: Optional[bool] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Delete a single trigger.

Parameters
Name	Description
`request`	`DeleteTriggerRequest` 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_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Trigger A representation of the trigger resource.

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
`EventarcAsyncClient`	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
`EventarcAsyncClient`	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
`EventarcAsyncClient`	The constructed client.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

get_trigger

get_trigger(request: Optional[google.cloud.eventarc_v1.types.eventarc.GetTriggerRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Get a single trigger.

Parameters
Name	Description
`request`	`GetTriggerRequest` 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.

list_triggers

list_triggers(request: Optional[google.cloud.eventarc_v1.types.eventarc.ListTriggersRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

List triggers.

Parameters
Name	Description
`request`	`ListTriggersRequest` 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.ListTriggersAsyncPager`	The response message for the ListTriggers method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_service_account_path

parse_service_account_path(path: str)

Parses a service_account path into its component segments.

parse_trigger_path

parse_trigger_path(path: str)

Parses a trigger path into its component segments.

service_account_path

service_account_path(project: str, service_account: str)

Returns a fully-qualified service_account string.

service_path

service_path()

Returns a fully-qualified service string.

trigger_path

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

Returns a fully-qualified trigger string.

update_trigger

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

Update a single trigger.

Parameters
Name	Description
`request`	`UpdateTriggerRequest` The request object. The request message for the UpdateTrigger method.
`trigger`	`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 will be updated. If no field mask is provided, all provided fields in the request will be 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_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Trigger A representation of the trigger resource.