0.22.4 (latest) 0.22.3 0.21.0 0.20.0 0.19.0 0.18.0 0.17.37 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.1 0.7.0 0.6.0 0.5.0 0.4.1 0.3.2 0.2.0 0.1.2

    BatchServiceAsyncClient(
        *,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
        transport: typing.Optional[
            typing.Union[
                str,
                google.cloud.batch_v1alpha.services.batch_service.transports.base.BatchServiceTransport,
                typing.Callable[
                    [...],
                    google.cloud.batch_v1alpha.services.batch_service.transports.base.BatchServiceTransport,
                ],
            ]
        ] = "grpc_asyncio",
        client_options: typing.Optional[
            google.api_core.client_options.ClientOptions
        ] = None,
        client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
    )

Google Batch Service.
The service manages user submitted batch jobs and allocates
Google Compute Engine VM instances to run the jobs.

## Properties

### api_endpoint

Return the API endpoint used by the client instance.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `str` | The API endpoint used by the client instance. |

### transport

Returns the transport used by the client instance.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `BatchServiceTransport` | The transport used by the client instance. |

### universe_domain

Return the universe domain used by the client instance.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `str` | The universe domain used by the client instance. |

## Methods

### BatchServiceAsyncClient

    BatchServiceAsyncClient(
        *,
        credentials: typing.Optional[google.auth.credentials.Credentials] = None,
        transport: typing.Optional[
            typing.Union[
                str,
                google.cloud.batch_v1alpha.services.batch_service.transports.base.BatchServiceTransport,
                typing.Callable[
                    [...],
                    google.cloud.batch_v1alpha.services.batch_service.transports.base.BatchServiceTransport,
                ],
            ]
        ] = "grpc_asyncio",
        client_options: typing.Optional[
            google.api_core.client_options.ClientOptions
        ] = None,
        client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
    )

Instantiates the batch service async client.

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

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

### cancel_job

    cancel_job(
        request: typing.Optional[
            typing.Union[google.cloud.batch_v1alpha.types.batch.CancelJobRequest, 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

Cancel a Job.

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

    async def sample_cancel_job():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.CancelJobRequest.html(
            name="name_value",
        )

        # Make the request
        operation = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_cancel_job(request=request)

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

        response = await operation.result()

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.CancelJobRequest, dict]]` The request object. CancelJob Request. |
| `name` | `` `str` `` Required. Job name. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `google.api_core.operation_async.AsyncOperation` | An object representing a long-running operation. The result type for the operation will be [CancelJobResponse](https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.CancelJobResponse) Response to the CancelJob request. |

### cancel_operation

    cancel_operation(
        request: typing.Optional[
            typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict]
        ] = 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

Starts asynchronous cancellation on a long-running operation.

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `` `.operations_pb2.CancelOperationRequest` `` The request object. Request message for `CancelOperation` method. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

### common_billing_account_path

    common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

### common_folder_path

    common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

### common_location_path

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

Returns a fully-qualified location string.

### common_organization_path

    common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

### common_project_path

    common_project_path(project: str) -> str

Returns a fully-qualified project string.

### create_job

    create_job(
        request: typing.Optional[
            typing.Union[google.cloud.batch_v1alpha.types.batch.CreateJobRequest, dict]
        ] = None,
        *,
        parent: typing.Optional[str] = None,
        job: typing.Optional[google.cloud.batch_v1alpha.types.job.Job] = None,
        job_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.cloud.batch_v1alpha.types.job.Job

Create a Job.

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

    async def sample_create_job():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.CreateJobRequest.html(
            parent="parent_value",
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_create_job(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.CreateJobRequest, dict]]` The request object. CreateJob Request. |
| `parent` | `` `str` `` Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}" This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. |
| `job` | `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.Job` Required. The Job to create. This corresponds to the `job` field on the `request` instance; if `request` is provided, this should not be set. |
| `job_id` | `` `str` `` ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}". This corresponds to the `job_id` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.Job` | The Cloud Batch Job description. |

### create_resource_allowance

    create_resource_allowance(
        request: typing.Optional[
            typing.Union[
                google.cloud.batch_v1alpha.types.batch.CreateResourceAllowanceRequest, dict
            ]
        ] = None,
        *,
        parent: typing.Optional[str] = None,
        resource_allowance: typing.Optional[
            google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance
        ] = None,
        resource_allowance_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.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance

Create a Resource Allowance.

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

    async def sample_create_resource_allowance():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        resource_allowance = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ResourceAllowance.html()
        resource_allowance.usage_resource_allowance.spec.type_ = "type__value"
        resource_allowance.usage_resource_allowance.spec.limit.calendar_period = "DAY"

        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.CreateResourceAllowanceRequest.html(
            parent="parent_value",
            resource_allowance=resource_allowance,
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_create_resource_allowance(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.CreateResourceAllowanceRequest, dict]]` The request object. CreateResourceAllowance Request. |
| `parent` | `` `str` `` Required. The parent resource name where the ResourceAllowance will be created. Pattern: "projects/{project}/locations/{location}" This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. |
| `resource_allowance` | `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ResourceAllowance` Required. The ResourceAllowance to create. This corresponds to the `resource_allowance` field on the `request` instance; if `request` is provided, this should not be set. |
| `resource_allowance_id` | `` `str` `` ID used to uniquely identify the ResourceAllowance within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The resource_allowance.name field in the request will be ignored and the created resource name of the ResourceAllowance will be "{parent}/resourceAllowances/{resource_allowance_id}". This corresponds to the `resource_allowance_id` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ResourceAllowance` | The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project. |

### delete_job

    delete_job(
        request: typing.Optional[
            typing.Union[google.cloud.batch_v1alpha.types.batch.DeleteJobRequest, 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

Delete a Job.

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

    async def sample_delete_job():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.DeleteJobRequest.html(
        )

        # Make the request
        operation = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_delete_job(request=request)

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

        response = await operation.result()

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.DeleteJobRequest, dict]]` The request object. DeleteJob Request. |
| `name` | `` `str` `` Job name. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `google.api_core.operation_async.AsyncOperation` | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |

### delete_operation

    delete_operation(
        request: typing.Optional[
            typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, dict]
        ] = 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.

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `` `.operations_pb2.DeleteOperationRequest` `` The request object. Request message for `DeleteOperation` method. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

### delete_resource_allowance

    delete_resource_allowance(
        request: typing.Optional[
            typing.Union[
                google.cloud.batch_v1alpha.types.batch.DeleteResourceAllowanceRequest, 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

Delete a ResourceAllowance.

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

    async def sample_delete_resource_allowance():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.DeleteResourceAllowanceRequest.html(
            name="name_value",
        )

        # Make the request
        operation = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_delete_resource_allowance(request=request)

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

        response = await operation.result()

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.DeleteResourceAllowanceRequest, dict]]` The request object. DeleteResourceAllowance Request. |
| `name` | `` `str` `` Required. ResourceAllowance name. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `google.api_core.operation_async.AsyncOperation` | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |

### from_service_account_file

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

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

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `BatchServiceAsyncClient` | The constructed client. |

### from_service_account_info

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

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `info` | `dict` The service account private key info. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `BatchServiceAsyncClient` | The constructed client. |

### from_service_account_json

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

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

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `BatchServiceAsyncClient` | The constructed client. |

### get_job

    get_job(
        request: typing.Optional[
            typing.Union[google.cloud.batch_v1alpha.types.batch.GetJobRequest, 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.batch_v1alpha.types.job.Job

Get a Job specified by its resource name.

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

    async def sample_get_job():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.GetJobRequest.html(
            name="name_value",
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_get_job(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.GetJobRequest, dict]]` The request object. GetJob Request. |
| `name` | `` `str` `` Required. Job name. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.Job` | The Cloud Batch Job description. |

### get_location

    get_location(
        request: typing.Optional[
            typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, dict]
        ] = 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.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `` `.location_pb2.GetLocationRequest` `` The request object. Request message for `GetLocation` method. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `` `.location_pb2.Location` `` | Location object. |

### 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.

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

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

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

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

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `google.auth.exceptions.MutualTLSChannelError` | If any errors happen. |

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

### get_operation

    get_operation(
        request: typing.Optional[
            typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict]
        ] = 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.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `` `.operations_pb2.GetOperationRequest` `` The request object. Request message for `GetOperation` method. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `` `.operations_pb2.Operation` `` | An `Operation` object. |

### get_resource_allowance

    get_resource_allowance(
        request: typing.Optional[
            typing.Union[
                google.cloud.batch_v1alpha.types.batch.GetResourceAllowanceRequest, 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.batch_v1alpha.types.resource_allowance.ResourceAllowance

Get a ResourceAllowance specified by its resource
name.

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

    async def sample_get_resource_allowance():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.GetResourceAllowanceRequest.html(
            name="name_value",
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_get_resource_allowance(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.GetResourceAllowanceRequest, dict]]` The request object. GetResourceAllowance Request. |
| `name` | `` `str` `` Required. ResourceAllowance name. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ResourceAllowance` | The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project. |

### get_task

    get_task(
        request: typing.Optional[
            typing.Union[google.cloud.batch_v1alpha.types.batch.GetTaskRequest, 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.batch_v1alpha.types.task.Task

Return a single Task.

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

    async def sample_get_task():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.GetTaskRequest.html(
            name="name_value",
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_get_task(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.GetTaskRequest, dict]]` The request object. Request for a single Task by name. |
| `name` | `` `str` `` Required. Task name. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.Task` | A Cloud Batch task. |

### get_transport_class

    get_transport_class(
        label: typing.Optional[str] = None,
    ) -> typing.Type[
        google.cloud.batch_v1alpha.services.batch_service.transports.base.BatchServiceTransport
    ]

Returns an appropriate transport class.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `label` | `typing.Optional[str]` The name of the desired transport. If none is provided, then the first transport in the registry is used. |

### job_path

    job_path(project: str, location: str, job: str) -> str

Returns a fully-qualified job string.

### list_jobs

    list_jobs(
        request: typing.Optional[
            typing.Union[google.cloud.batch_v1alpha.types.batch.ListJobsRequest, 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.batch_v1alpha.services.batch_service.pagers.ListJobsAsyncPager

List all Jobs for a project within a region.

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

    async def sample_list_jobs():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ListJobsRequest.html(
        )

        # Make the request
        page_result = client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_list_jobs(request=request)

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ListJobsRequest, dict]]` The request object. ListJob Request. |
| `parent` | `` `str` `` Parent path. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsAsyncPager` | ListJob Response. Iterating over this object will yield results and resolve additional pages automatically. |

### list_locations

    list_locations(
        request: typing.Optional[
            typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, dict]
        ] = 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.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `` `.location_pb2.ListLocationsRequest` `` The request object. Request message for `ListLocations` method. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `` `.location_pb2.ListLocationsResponse` `` | Response message for `ListLocations` method. |

### list_operations

    list_operations(
        request: typing.Optional[
            typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict]
        ] = 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.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `` `.operations_pb2.ListOperationsRequest` `` The request object. Request message for `ListOperations` method. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `` `.operations_pb2.ListOperationsResponse` `` | Response message for `ListOperations` method. |

### list_resource_allowances

    list_resource_allowances(
        request: typing.Optional[
            typing.Union[
                google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesRequest, 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.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesAsyncPager
    )

List all ResourceAllowances for a project within a
region.

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

    async def sample_list_resource_allowances():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ListResourceAllowancesRequest.html(
            parent="parent_value",
        )

        # Make the request
        page_result = client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_list_resource_allowances(request=request)

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ListResourceAllowancesRequest, dict]]` The request object. ListResourceAllowances Request. |
| `parent` | `` `str` `` Required. Parent path. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesAsyncPager` | ListResourceAllowances Response. Iterating over this object will yield results and resolve additional pages automatically. |

### list_tasks

    list_tasks(
        request: typing.Optional[
            typing.Union[google.cloud.batch_v1alpha.types.batch.ListTasksRequest, 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.batch_v1alpha.services.batch_service.pagers.ListTasksAsyncPager

List Tasks associated with a job.

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

    async def sample_list_tasks():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ListTasksRequest.html(
            parent="parent_value",
        )

        # Make the request
        page_result = client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_list_tasks(request=request)

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

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ListTasksRequest, dict]]` The request object. ListTasks Request. |
| `parent` | `` `str` `` Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}" This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksAsyncPager` | ListTasks Response. Iterating over this object will yield results and resolve additional pages automatically. |

### parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

### parse_common_folder_path

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

Parse a folder path into its component segments.

### parse_common_location_path

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

Parse a location path into its component segments.

### parse_common_organization_path

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

Parse a organization path into its component segments.

### parse_common_project_path

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

Parse a project path into its component segments.

### parse_job_path

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

Parses a job path into its component segments.

### parse_resource_allowance_path

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

Parses a resource_allowance path into its component segments.

### parse_task_group_path

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

Parses a task_group path into its component segments.

### parse_task_path

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

Parses a task path into its component segments.

### resource_allowance_path

    resource_allowance_path(
        project: str, location: str, resource_allowance: str
    ) -> str

Returns a fully-qualified resource_allowance string.

### task_group_path

    task_group_path(project: str, location: str, job: str, task_group: str) -> str

Returns a fully-qualified task_group string.

### task_path

    task_path(project: str, location: str, job: str, task_group: str, task: str) -> str

Returns a fully-qualified task string.

### update_job

    update_job(
        request: typing.Optional[
            typing.Union[google.cloud.batch_v1alpha.types.batch.UpdateJobRequest, dict]
        ] = None,
        *,
        job: typing.Optional[google.cloud.batch_v1alpha.types.job.Job] = 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.cloud.batch_v1alpha.types.job.Job

Update a Job.

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

    async def sample_update_job():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.UpdateJobRequest.html(
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_update_job(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.UpdateJobRequest, dict]]` The request object. UpdateJob Request. |
| `job` | `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.Job` Required. The Job to update. Only fields specified in `updateMask` are updated. This corresponds to the `job` field on the `request` instance; if `request` is provided, this should not be set. |
| `update_mask` | `` `google.protobuf.field_mask_pb2.FieldMask` `` Required. Mask of fields to update. The `jobs.patch` method can only be used while a job is in the `QUEUED`, `SCHEDULED`, or `RUNNING` state and currently only supports increasing the value of the first `taskCount` field in the job's `taskGroups` field. Therefore, you must set the value of `updateMask` to `taskGroups`. Any other job fields in the update request will be ignored. For example, to update a job's `taskCount` to `2`, set `updateMask` to `taskGroups` and use the following request body: :: { "taskGroups":\[{ "taskCount": 2 }\] } This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.Job` | The Cloud Batch Job description. |

### update_resource_allowance

    update_resource_allowance(
        request: typing.Optional[
            typing.Union[
                google.cloud.batch_v1alpha.types.batch.UpdateResourceAllowanceRequest, dict
            ]
        ] = None,
        *,
        resource_allowance: typing.Optional[
            google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance
        ] = 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.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance

Update a Resource Allowance.

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

    async def sample_update_resource_allowance():
        # Create a client
        client = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html()

        # Initialize request argument(s)
        resource_allowance = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ResourceAllowance.html()
        resource_allowance.usage_resource_allowance.spec.type_ = "type__value"
        resource_allowance.usage_resource_allowance.spec.limit.calendar_period = "DAY"

        request = batch_v1alpha.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.UpdateResourceAllowanceRequest.html(
            resource_allowance=resource_allowance,
        )

        # Make the request
        response = await client.https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.services.batch_service.BatchServiceAsyncClient.html#google_cloud_batch_v1alpha_services_batch_service_BatchServiceAsyncClient_update_resource_allowance(request=request)

        # Handle the response
        print(response)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.UpdateResourceAllowanceRequest, dict]]` The request object. UpdateResourceAllowance Request. |
| `resource_allowance` | `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ResourceAllowance` Required. The ResourceAllowance to update. Update description. Only fields specified in `update_mask` are updated. This corresponds to the `resource_allowance` field on the `request` instance; if `request` is provided, this should not be set. |
| `update_mask` | `` `google.protobuf.field_mask_pb2.FieldMask` `` Required. Mask of fields to update. Field mask is used to specify the fields to be overwritten in the ResourceAllowance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. UpdateResourceAllowance request now only supports update on `limit` field. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set. |
| `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. |
| `timeout` | `float` The timeout for this request. |
| `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/python/docs/reference/batch/latest/google.cloud.batch_v1alpha.types.ResourceAllowance` | The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project. |