MessagesV1Beta3AsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataflow_v1beta3.services.messages_v1_beta3.transports.base.MessagesV1Beta3Transport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dataflow-client/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)The Dataflow Messages API is used for monitoring the progress of Dataflow jobs.
Inheritance
builtins.object > MessagesV1Beta3AsyncClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| MessagesV1Beta3Transport | The transport used by the client instance. |
Methods
MessagesV1Beta3AsyncClient
MessagesV1Beta3AsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.dataflow_v1beta3.services.messages_v1_beta3.transports.base.MessagesV1Beta3Transport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-dataflow-client/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the messages v1 beta3 client.
| 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, `.MessagesV1Beta3Transport`]
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 |
| Type | Description |
| google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| MessagesV1Beta3AsyncClient | 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.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| MessagesV1Beta3AsyncClient | 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.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| MessagesV1Beta3AsyncClient | The constructed client. |
get_transport_class
get_transport_class()Returns an appropriate transport class.
list_job_messages
list_job_messages(request: Optional[google.cloud.dataflow_v1beta3.types.messages.ListJobMessagesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Request the job status.
To request the status of a job, we recommend using
projects.locations.jobs.messages.list with a regional
endpoint.
Using projects.jobs.messages.list is not recommended, as you
can only request the status of jobs that are running in
us-central1.
| Name | Description |
| request |
ListJobMessagesRequest
The request object. Request to list job messages. Up to max_results messages will be returned in the time range specified starting with the oldest messages first. If no time range is specified the results with start with the oldest message. |
| 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. |
| Type | Description |
| google.cloud.dataflow_v1beta3.services.messages_v1_beta3.pagers.ListJobMessagesAsyncPager | Response to a request to list job messages. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.