Summary of entries of Methods for workflows.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient
ExecutionsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows.executions_v1.services.executions.transports.base.ExecutionsTransport, typing.Callable[[...], google.cloud.workflows.executions_v1.services.executions.transports.base.ExecutionsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the executions async client.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.cancel_execution
cancel_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1.types.executions.CancelExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1.types.executions.Execution
Cancels an execution of the given name.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.cancel_execution
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.common_folder_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.common_location_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.common_project_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1.types.executions.CreateExecutionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.workflows.executions_v1.types.executions.Execution
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1.types.executions.Execution
Creates a new execution using the latest revision of the given workflow.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.create_execution
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.execution_path
execution_path(project: str, location: str, workflow: str, execution: str) -> str
Returns a fully-qualified execution string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.execution_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1.types.executions.GetExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1.types.executions.Execution
Returns an execution of the given name.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.get_execution
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.workflows.executions_v1.services.executions.transports.base.ExecutionsTransport
]
Returns an appropriate transport class.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.get_transport_class
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1.types.executions.ListExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.workflows.executions_v1.services.executions.pagers.ListExecutionsAsyncPager
)
Returns a list of executions which belong to the workflow with the given name.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.list_executions
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.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.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.parse_execution_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.parse_workflow_path
parse_workflow_path(path: str) -> typing.Dict[str, str]
Parses a workflow path into its component segments.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.parse_workflow_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.workflow_path
workflow_path(project: str, location: str, workflow: str) -> str
Returns a fully-qualified workflow string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsAsyncClient.workflow_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient
ExecutionsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows.executions_v1.services.executions.transports.base.ExecutionsTransport, typing.Callable[[...], google.cloud.workflows.executions_v1.services.executions.transports.base.ExecutionsTransport]]] = 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 =
Instantiates the executions client.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.exit
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.cancel_execution
cancel_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1.types.executions.CancelExecutionRequest,
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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1.types.executions.Execution
Cancels an execution of the given name.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.cancel_execution
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_folder_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_location_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_organization_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.common_project_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1.types.executions.CreateExecutionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.workflows.executions_v1.types.executions.Execution
] = 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1.types.executions.Execution
Creates a new execution using the latest revision of the given workflow.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.create_execution
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.execution_path
execution_path(project: str, location: str, workflow: str, execution: str) -> str
Returns a fully-qualified execution string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.execution_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.from_service_account_file
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.from_service_account_info
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.from_service_account_json
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1.types.executions.GetExecutionRequest,
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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1.types.executions.Execution
Returns an execution of the given name.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.get_execution
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1.types.executions.ListExecutionsRequest,
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, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.workflows.executions_v1.services.executions.pagers.ListExecutionsPager
)
Returns a list of executions which belong to the workflow with the given name.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.list_executions
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.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.
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_common_folder_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_common_location_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_common_project_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_execution_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_workflow_path
parse_workflow_path(path: str) -> typing.Dict[str, str]
Parses a workflow path into its component segments.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.parse_workflow_path
google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.workflow_path
workflow_path(project: str, location: str, workflow: str) -> str
Returns a fully-qualified workflow string.
See more: google.cloud.workflows.executions_v1.services.executions.ExecutionsClient.workflow_path
google.cloud.workflows.executions_v1.services.executions.pagers.ListExecutionsAsyncPager
ListExecutionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workflows.executions_v1.types.executions.ListExecutionsResponse
],
],
request: google.cloud.workflows.executions_v1.types.executions.ListExecutionsRequest,
response: google.cloud.workflows.executions_v1.types.executions.ListExecutionsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.workflows.executions_v1.services.executions.pagers.ListExecutionsAsyncPager
google.cloud.workflows.executions_v1.services.executions.pagers.ListExecutionsPager
ListExecutionsPager(
method: typing.Callable[
[...],
google.cloud.workflows.executions_v1.types.executions.ListExecutionsResponse,
],
request: google.cloud.workflows.executions_v1.types.executions.ListExecutionsRequest,
response: google.cloud.workflows.executions_v1.types.executions.ListExecutionsResponse,
*,
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, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.workflows.executions_v1.services.executions.pagers.ListExecutionsPager
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient
ExecutionsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows.executions_v1beta.services.executions.transports.base.ExecutionsTransport, typing.Callable[[...], google.cloud.workflows.executions_v1beta.services.executions.transports.base.ExecutionsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the executions async client.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.cancel_execution
cancel_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1beta.types.executions.CancelExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1beta.types.executions.Execution
Cancels an execution of the given name.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.cancel_execution
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1beta.types.executions.CreateExecutionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.workflows.executions_v1beta.types.executions.Execution
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1beta.types.executions.Execution
Creates a new execution using the latest revision of the given workflow.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.create_execution
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.execution_path
execution_path(project: str, location: str, workflow: str, execution: str) -> str
Returns a fully-qualified execution string.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.execution_path
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1beta.types.executions.GetExecutionRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1beta.types.executions.Execution
Returns an execution of the given name.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.get_execution
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.workflows.executions_v1beta.services.executions.transports.base.ExecutionsTransport
]
Returns an appropriate transport class.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.workflows.executions_v1beta.services.executions.pagers.ListExecutionsAsyncPager
)
Returns a list of executions which belong to the workflow with the given name.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.list_executions
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.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.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.parse_workflow_path
parse_workflow_path(path: str) -> typing.Dict[str, str]
Parses a workflow path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.workflow_path
workflow_path(project: str, location: str, workflow: str) -> str
Returns a fully-qualified workflow string.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsAsyncClient.workflow_path
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient
ExecutionsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows.executions_v1beta.services.executions.transports.base.ExecutionsTransport, typing.Callable[[...], google.cloud.workflows.executions_v1beta.services.executions.transports.base.ExecutionsTransport]]] = 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 =
Instantiates the executions client.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.exit
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.cancel_execution
cancel_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1beta.types.executions.CancelExecutionRequest,
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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1beta.types.executions.Execution
Cancels an execution of the given name.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.cancel_execution
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.common_folder_path
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.common_location_path
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.common_project_path
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.create_execution
create_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1beta.types.executions.CreateExecutionRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
execution: typing.Optional[
google.cloud.workflows.executions_v1beta.types.executions.Execution
] = 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1beta.types.executions.Execution
Creates a new execution using the latest revision of the given workflow.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.create_execution
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.execution_path
execution_path(project: str, location: str, workflow: str, execution: str) -> str
Returns a fully-qualified execution string.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.execution_path
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.get_execution
get_execution(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1beta.types.executions.GetExecutionRequest,
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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows.executions_v1beta.types.executions.Execution
Returns an execution of the given name.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.get_execution
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.list_executions
list_executions(
request: typing.Optional[
typing.Union[
google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsRequest,
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, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.workflows.executions_v1beta.services.executions.pagers.ListExecutionsPager
)
Returns a list of executions which belong to the workflow with the given name.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.list_executions
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.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.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.parse_execution_path
parse_execution_path(path: str) -> typing.Dict[str, str]
Parses a execution path into its component segments.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.parse_execution_path
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.parse_workflow_path
parse_workflow_path(path: str) -> typing.Dict[str, str]
Parses a workflow path into its component segments.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.parse_workflow_path
google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.workflow_path
workflow_path(project: str, location: str, workflow: str) -> str
Returns a fully-qualified workflow string.
See more: google.cloud.workflows.executions_v1beta.services.executions.ExecutionsClient.workflow_path
google.cloud.workflows.executions_v1beta.services.executions.pagers.ListExecutionsAsyncPager
ListExecutionsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsResponse
],
],
request: google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsRequest,
response: google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.workflows.executions_v1beta.services.executions.pagers.ListExecutionsAsyncPager
google.cloud.workflows.executions_v1beta.services.executions.pagers.ListExecutionsPager
ListExecutionsPager(
method: typing.Callable[
[...],
google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsResponse,
],
request: google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsRequest,
response: google.cloud.workflows.executions_v1beta.types.executions.ListExecutionsResponse,
*,
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, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.workflows.executions_v1beta.services.executions.pagers.ListExecutionsPager
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient
WorkflowsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport, typing.Callable[[...], google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the workflows async client.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_billing_account_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_folder_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_location_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_organization_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.common_project_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.create_workflow
create_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1.types.workflows.CreateWorkflowRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
workflow: typing.Optional[
google.cloud.workflows_v1.types.workflows.Workflow
] = None,
workflow_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new workflow.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.create_workflow
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.crypto_key_path
crypto_key_path(project: str, location: str, keyRing: str, cryptoKey: str) -> str
Returns a fully-qualified crypto_key string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.crypto_key_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.delete_operation
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.delete_workflow
delete_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1.types.workflows.DeleteWorkflowRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a workflow with the specified name.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.delete_workflow
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.from_service_account_file
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.from_service_account_info
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.from_service_account_json
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_location
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_mtls_endpoint_and_cert_source
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_operation
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport
]
Returns an appropriate transport class.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_transport_class
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_workflow
get_workflow(
request: typing.Optional[
typing.Union[google.cloud.workflows_v1.types.workflows.GetWorkflowRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows_v1.types.workflows.Workflow
Gets details of a single workflow.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.get_workflow
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.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_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.list_locations
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.list_operations
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.list_workflows
list_workflows(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsAsyncPager
Lists workflows in a given project and location.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.list_workflows
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.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.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_billing_account_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_folder_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_location_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_organization_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_common_project_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_crypto_key_path
parse_crypto_key_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_crypto_key_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_workflow_path
parse_workflow_path(path: str) -> typing.Dict[str, str]
Parses a workflow path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.parse_workflow_path
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.update_workflow
update_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1.types.workflows.UpdateWorkflowRequest, dict
]
] = None,
*,
workflow: typing.Optional[
google.cloud.workflows_v1.types.workflows.Workflow
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing workflow.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.update_workflow
google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.workflow_path
workflow_path(project: str, location: str, workflow: str) -> str
Returns a fully-qualified workflow string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsAsyncClient.workflow_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient
WorkflowsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport, typing.Callable[[...], google.cloud.workflows_v1.services.workflows.transports.base.WorkflowsTransport]]] = 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 =
Instantiates the workflows client.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient
google.cloud.workflows_v1.services.workflows.WorkflowsClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.exit
google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_billing_account_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_folder_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_location_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_organization_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.common_project_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.create_workflow
create_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1.types.workflows.CreateWorkflowRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
workflow: typing.Optional[
google.cloud.workflows_v1.types.workflows.Workflow
] = None,
workflow_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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new workflow.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.create_workflow
google.cloud.workflows_v1.services.workflows.WorkflowsClient.crypto_key_path
crypto_key_path(project: str, location: str, keyRing: str, cryptoKey: str) -> str
Returns a fully-qualified crypto_key string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.crypto_key_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.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, typing.Union[str, bytes]]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.delete_operation
google.cloud.workflows_v1.services.workflows.WorkflowsClient.delete_workflow
delete_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1.types.workflows.DeleteWorkflowRequest, 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a workflow with the specified name.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.delete_workflow
google.cloud.workflows_v1.services.workflows.WorkflowsClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.from_service_account_file
google.cloud.workflows_v1.services.workflows.WorkflowsClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.from_service_account_info
google.cloud.workflows_v1.services.workflows.WorkflowsClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.from_service_account_json
google.cloud.workflows_v1.services.workflows.WorkflowsClient.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, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.get_location
google.cloud.workflows_v1.services.workflows.WorkflowsClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.get_mtls_endpoint_and_cert_source
google.cloud.workflows_v1.services.workflows.WorkflowsClient.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, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.get_operation
google.cloud.workflows_v1.services.workflows.WorkflowsClient.get_workflow
get_workflow(
request: typing.Optional[
typing.Union[google.cloud.workflows_v1.types.workflows.GetWorkflowRequest, 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows_v1.types.workflows.Workflow
Gets details of a single workflow.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.get_workflow
google.cloud.workflows_v1.services.workflows.WorkflowsClient.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, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.list_locations
google.cloud.workflows_v1.services.workflows.WorkflowsClient.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, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.list_operations
google.cloud.workflows_v1.services.workflows.WorkflowsClient.list_workflows
list_workflows(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest, 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsPager
Lists workflows in a given project and location.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.list_workflows
google.cloud.workflows_v1.services.workflows.WorkflowsClient.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.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_billing_account_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_folder_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_location_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_organization_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_common_project_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_crypto_key_path
parse_crypto_key_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_crypto_key_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_workflow_path
parse_workflow_path(path: str) -> typing.Dict[str, str]
Parses a workflow path into its component segments.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.parse_workflow_path
google.cloud.workflows_v1.services.workflows.WorkflowsClient.update_workflow
update_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1.types.workflows.UpdateWorkflowRequest, dict
]
] = None,
*,
workflow: typing.Optional[
google.cloud.workflows_v1.types.workflows.Workflow
] = 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates an existing workflow.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.update_workflow
google.cloud.workflows_v1.services.workflows.WorkflowsClient.workflow_path
workflow_path(project: str, location: str, workflow: str) -> str
Returns a fully-qualified workflow string.
See more: google.cloud.workflows_v1.services.workflows.WorkflowsClient.workflow_path
google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsAsyncPager
ListWorkflowsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workflows_v1.types.workflows.ListWorkflowsResponse
],
],
request: google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest,
response: google.cloud.workflows_v1.types.workflows.ListWorkflowsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsAsyncPager
google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsPager
ListWorkflowsPager(
method: typing.Callable[
[...], google.cloud.workflows_v1.types.workflows.ListWorkflowsResponse
],
request: google.cloud.workflows_v1.types.workflows.ListWorkflowsRequest,
response: google.cloud.workflows_v1.types.workflows.ListWorkflowsResponse,
*,
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, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.workflows_v1.services.workflows.pagers.ListWorkflowsPager
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient
WorkflowsAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport, typing.Callable[[...], google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the workflows async client.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_billing_account_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_folder_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_location_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_organization_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.common_project_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.create_workflow
create_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.CreateWorkflowRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
workflow: typing.Optional[
google.cloud.workflows_v1beta.types.workflows.Workflow
] = None,
workflow_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new workflow.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.create_workflow
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.delete_workflow
delete_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.DeleteWorkflowRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a workflow with the specified name.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.delete_workflow
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.from_service_account_file
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.from_service_account_info
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.from_service_account_json
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport
]
Returns an appropriate transport class.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.get_transport_class
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.get_workflow
get_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.GetWorkflowRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows_v1beta.types.workflows.Workflow
Gets details of a single Workflow.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.get_workflow
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.list_workflows
list_workflows(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.ListWorkflowsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsAsyncPager
Lists Workflows in a given project and location.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.list_workflows
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.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.
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_common_folder_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_common_location_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_common_organization_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_common_project_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_workflow_path
parse_workflow_path(path: str) -> typing.Dict[str, str]
Parses a workflow path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.parse_workflow_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.update_workflow
update_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.UpdateWorkflowRequest, dict
]
] = None,
*,
workflow: typing.Optional[
google.cloud.workflows_v1beta.types.workflows.Workflow
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an existing workflow.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.update_workflow
google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.workflow_path
workflow_path(project: str, location: str, workflow: str) -> str
Returns a fully-qualified workflow string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsAsyncClient.workflow_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient
WorkflowsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport, typing.Callable[[...], google.cloud.workflows_v1beta.services.workflows.transports.base.WorkflowsTransport]]] = 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 =
Instantiates the workflows client.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.exit
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_billing_account_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_folder_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_location_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_organization_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.common_project_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.create_workflow
create_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.CreateWorkflowRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
workflow: typing.Optional[
google.cloud.workflows_v1beta.types.workflows.Workflow
] = None,
workflow_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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new workflow.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.create_workflow
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.delete_workflow
delete_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.DeleteWorkflowRequest, 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a workflow with the specified name.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.delete_workflow
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.from_service_account_file
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.from_service_account_info
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.from_service_account_json
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.get_mtls_endpoint_and_cert_source
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.get_workflow
get_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.GetWorkflowRequest, 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows_v1beta.types.workflows.Workflow
Gets details of a single Workflow.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.get_workflow
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.list_workflows
list_workflows(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.ListWorkflowsRequest, 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsPager
Lists Workflows in a given project and location.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.list_workflows
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.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.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_billing_account_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_folder_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_location_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_organization_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_common_project_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_workflow_path
parse_workflow_path(path: str) -> typing.Dict[str, str]
Parses a workflow path into its component segments.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.parse_workflow_path
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.update_workflow
update_workflow(
request: typing.Optional[
typing.Union[
google.cloud.workflows_v1beta.types.workflows.UpdateWorkflowRequest, dict
]
] = None,
*,
workflow: typing.Optional[
google.cloud.workflows_v1beta.types.workflows.Workflow
] = 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates an existing workflow.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.update_workflow
google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.workflow_path
workflow_path(project: str, location: str, workflow: str) -> str
Returns a fully-qualified workflow string.
See more: google.cloud.workflows_v1beta.services.workflows.WorkflowsClient.workflow_path
google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsAsyncPager
ListWorkflowsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.workflows_v1beta.types.workflows.ListWorkflowsResponse
],
],
request: google.cloud.workflows_v1beta.types.workflows.ListWorkflowsRequest,
response: google.cloud.workflows_v1beta.types.workflows.ListWorkflowsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsAsyncPager
google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsPager
ListWorkflowsPager(
method: typing.Callable[
[...], google.cloud.workflows_v1beta.types.workflows.ListWorkflowsResponse
],
request: google.cloud.workflows_v1beta.types.workflows.ListWorkflowsRequest,
response: google.cloud.workflows_v1beta.types.workflows.ListWorkflowsResponse,
*,
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, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.workflows_v1beta.services.workflows.pagers.ListWorkflowsPager