EventarcAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.eventarc_v1.services.eventarc.transports.base.EventarcTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = 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: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.eventarc_v1.services.eventarc.transports.base.EventarcTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = 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,
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
channel_connection_path
channel_connection_path(project: str, location: str, channel_connection: str)
Returns a fully-qualified channel_connection string.
channel_path
channel_path(project: str, location: str, channel: str)
Returns a fully-qualified channel string.
cloud_function_path
cloud_function_path(project: str, location: str, function: str)
Returns a fully-qualified cloud_function string.
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_channel
create_channel(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.CreateChannelRequest, dict]] = None, *, parent: Optional[str] = None, channel: Optional[google.cloud.eventarc_v1.types.channel.Channel] = None, channel_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a new channel in a particular project and location.
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"
channel.provider = "provider_value"
request = eventarc_v1.CreateChannelRequest(
parent="parent_value",
channel=channel,
channel_id="channel_id_value",
validate_only=True,
)
# 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 |
Required. The parent collection in which to add this channel. This corresponds to the |
channel |
Channel
Required. The channel to create. This corresponds to the |
channel_id |
Required. The user-provided ID to be assigned to the channel. This corresponds to the |
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 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: Optional[Union[google.cloud.eventarc_v1.types.eventarc.CreateChannelConnectionRequest, dict]] = None, *, parent: Optional[str] = None, channel_connection: Optional[google.cloud.eventarc_v1.types.channel_connection.ChannelConnection] = None, channel_connection_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a new ChannelConnection in a particular project and location.
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 |
Required. The parent collection in which to add this channel connection. This corresponds to the |
channel_connection |
ChannelConnection
Required. Channel connection to create. This corresponds to the |
channel_connection_id |
Required. The user-provided ID to be assigned to the channel connection. This corresponds to the |
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 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_trigger
create_trigger(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.CreateTriggerRequest, dict]] = None, *, parent: Optional[str] = None, trigger: Optional[google.cloud.eventarc_v1.types.trigger.Trigger] = None, trigger_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Create a new trigger in a particular project and location.
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",
validate_only=True,
)
# 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 |
Required. The parent collection in which to add this trigger. This corresponds to the |
trigger |
Trigger
Required. The trigger to create. This corresponds to the |
trigger_id |
Required. The user-provided ID to be assigned to the trigger. This corresponds to the |
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_channel
delete_channel(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.DeleteChannelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a single channel.
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",
validate_only=True,
)
# 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 |
Required. The name of the channel to be deleted. This corresponds to the |
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 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: Optional[Union[google.cloud.eventarc_v1.types.eventarc.DeleteChannelConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a single ChannelConnection.
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 |
Required. The name of the channel connection to delete. This corresponds to the |
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 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_trigger
delete_trigger(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.DeleteTriggerRequest, dict]] = None, *, name: Optional[str] = None, allow_missing: Optional[bool] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Delete a single trigger.
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",
validate_only=True,
)
# 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 |
Required. The name of the trigger to be deleted. This corresponds to the |
allow_missing |
If set to true, and the trigger is not found, the request will succeed but no action will be taken on the server. This corresponds to the |
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_channel
get_channel(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.GetChannelRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a single Channel.
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 |
Required. The name of the channel to get. This corresponds to the |
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: Optional[Union[google.cloud.eventarc_v1.types.eventarc.GetChannelConnectionRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a single ChannelConnection.
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 |
Required. The name of the channel connection to get. This corresponds to the |
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_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
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 variabel 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 |
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_transport_class
get_transport_class()
Returns an appropriate transport class.
get_trigger
get_trigger(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.GetTriggerRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Get a single trigger.
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 |
Required. The name of the trigger to get. This corresponds to the |
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_channel_connections
list_channel_connections(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.ListChannelConnectionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List channel connections.
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 |
Required. The parent collection from which to list channel connections. This corresponds to the |
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.ListChannelConnectionsAsyncPager | The response message for the ListChannelConnections method. Iterating over this object will yield results and resolve additional pages automatically. |
list_channels
list_channels(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.ListChannelsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List channels.
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 |
Required. The parent collection to list channels on. This corresponds to the |
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.ListChannelsAsyncPager | The response message for the ListChannels method. Iterating over this object will yield results and resolve additional pages automatically. |
list_triggers
list_triggers(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.ListTriggersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
List triggers.
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 |
Required. The parent collection to list triggers on. This corresponds to the |
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_channel_connection_path
parse_channel_connection_path(path: str)
Parses a channel_connection path into its component segments.
parse_channel_path
parse_channel_path(path: str)
Parses a channel path into its component segments.
parse_cloud_function_path
parse_cloud_function_path(path: str)
Parses a cloud_function path into its component segments.
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_channel
update_channel(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.UpdateChannelRequest, dict]] = None, *, channel: Optional[google.cloud.eventarc_v1.types.channel.Channel] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a single channel.
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(
validate_only=True,
)
# 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 |
Channel
The channel to be updated. This corresponds to the |
update_mask |
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*". This corresponds to the |
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 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_trigger
update_trigger(request: Optional[Union[google.cloud.eventarc_v1.types.eventarc.UpdateTriggerRequest, dict]] = 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update a single trigger.
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(
validate_only=True,
)
# 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 |
Trigger
The trigger to be updated. This corresponds to the |
update_mask |
The fields to be updated; only fields explicitly provided are updated. If no field mask is provided, all provided fields in the request are updated. To update all fields, provide a field mask of "*". This corresponds to the |
allow_missing |
If set to true, and the trigger is not found, a new trigger will be created. In this situation, |
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. |