As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

BatchService¶

class google.cloud.batch_v1alpha.services.batch_service.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 object>)[source]¶

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

Instantiates the batch service async client.

Parameters

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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

async cancel_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.CancelJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.CancelJobRequest(
        name="name_value",
    )

    # Make the request
    operation = client.cancel_job(request=request)

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.batch_v1alpha.types.CancelJobResponse Response to the CancelJob request.

Return type

google.api_core.operation_async.AsyncOperation

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.CreateJobRequest, dict]] = None, *, parent: Optional[str] = None, job: Optional[google.cloud.batch_v1alpha.types.job.Job] = None, job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.job.Job[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.CreateJobRequest(
        parent="parent_value",
    )

    # Make the request
    response = await client.create_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[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 (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Cloud Batch Job description.

Return type

google.cloud.batch_v1alpha.types.Job

async create_resource_allowance(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.CreateResourceAllowanceRequest, dict]] = None, *, parent: Optional[str] = None, resource_allowance: Optional[google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance] = None, resource_allowance_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    resource_allowance = batch_v1alpha.ResourceAllowance()
    resource_allowance.usage_resource_allowance.spec.type_ = "type__value"
    resource_allowance.usage_resource_allowance.spec.limit.calendar_period = "DAY"

    request = batch_v1alpha.CreateResourceAllowanceRequest(
        parent="parent_value",
        resource_allowance=resource_allowance,
    )

    # Make the request
    response = await client.create_resource_allowance(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[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 (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project.

Return type

google.cloud.batch_v1alpha.types.ResourceAllowance

async delete_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.DeleteJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.DeleteJobRequest(
    )

    # Make the request
    operation = client.delete_job(request=request)

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

async delete_resource_allowance(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.DeleteResourceAllowanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.DeleteResourceAllowanceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_resource_allowance(request=request)

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BatchServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BatchServiceAsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BatchServiceAsyncClient

async get_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.GetJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.job.Job[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.GetJobRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Cloud Batch Job description.

Return type

google.cloud.batch_v1alpha.types.Job

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

async get_resource_allowance(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.GetResourceAllowanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.GetResourceAllowanceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_resource_allowance(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project.

Return type

google.cloud.batch_v1alpha.types.ResourceAllowance

async get_task(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.GetTaskRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.task.Task[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.GetTaskRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_task(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

A Cloud Batch task.

Return type

google.cloud.batch_v1alpha.types.Task

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.batch_v1alpha.services.batch_service.transports.base.BatchServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

static job_path(project: str, location: str, job: str) → str¶: Returns a fully-qualified job string.

async list_jobs(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.ListJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsAsyncPager[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.ListJobsRequest(
    )

    # Make the request
    page_result = client.list_jobs(request=request)

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

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

ListJob Response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

async list_resource_allowances(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesAsyncPager[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.ListResourceAllowancesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_resource_allowances(request=request)

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

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

ListResourceAllowances Response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesAsyncPager

async list_tasks(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.ListTasksRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksAsyncPager[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.ListTasksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_tasks(request=request)

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

Parameters

request (Optional[Union[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, str]]) – Strings which should be sent along with the request as metadata.

Returns

ListTasks Response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksAsyncPager

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_job_path(path: str) → Dict[str, str]¶: Parses a job path into its component segments.

static parse_resource_allowance_path(path: str) → Dict[str, str]¶: Parses a resource_allowance path into its component segments.

static parse_task_group_path(path: str) → Dict[str, str]¶: Parses a task_group path into its component segments.

static parse_task_path(path: str) → Dict[str, str]¶: Parses a task path into its component segments.

static resource_allowance_path(project: str, location: str, resource_allowance: str) → str¶: Returns a fully-qualified resource_allowance string.

static task_group_path(project: str, location: str, job: str, task_group: str) → str¶: Returns a fully-qualified task_group string.

static task_path(project: str, location: str, job: str, task_group: str, task: str) → str¶: Returns a fully-qualified task string.

property transport: google.cloud.batch_v1alpha.services.batch_service.transports.base.BatchServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: BatchServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.UpdateJobRequest, dict]] = None, *, job: Optional[google.cloud.batch_v1alpha.types.job.Job] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.job.Job[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    request = batch_v1alpha.UpdateJobRequest(
    )

    # Make the request
    response = await client.update_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.batch_v1alpha.types.UpdateJobRequest, dict]]) – The request object. UpdateJob Request.
job (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Cloud Batch Job description.

Return type

google.cloud.batch_v1alpha.types.Job

async update_resource_allowance(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.UpdateResourceAllowanceRequest, dict]] = None, *, resource_allowance: Optional[google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance[source]¶

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.BatchServiceAsyncClient()

    # Initialize request argument(s)
    resource_allowance = batch_v1alpha.ResourceAllowance()
    resource_allowance.usage_resource_allowance.spec.type_ = "type__value"
    resource_allowance.usage_resource_allowance.spec.limit.calendar_period = "DAY"

    request = batch_v1alpha.UpdateResourceAllowanceRequest(
        resource_allowance=resource_allowance,
    )

    # Make the request
    response = await client.update_resource_allowance(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.batch_v1alpha.types.UpdateResourceAllowanceRequest, dict]]) – The request object. UpdateResourceAllowance Request.
resource_allowance (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, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project.

Return type

google.cloud.batch_v1alpha.types.ResourceAllowance

class google.cloud.batch_v1alpha.services.batch_service.BatchServiceClient(*, 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]]] = 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 = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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

Instantiates the batch service client.

Parameters

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

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

cancel_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.CancelJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

def sample_cancel_job():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.CancelJobRequest(
        name="name_value",
    )

    # Make the request
    operation = client.cancel_job(request=request)

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.batch_v1alpha.types.CancelJobResponse Response to the CancelJob request.

Return type

google.api_core.operation.Operation

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (CancelOperationRequest) – The request object. Request message for CancelOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.CreateJobRequest, dict]] = None, *, parent: Optional[str] = None, job: Optional[google.cloud.batch_v1alpha.types.job.Job] = None, job_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.job.Job[source]¶

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

def sample_create_job():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.CreateJobRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.create_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[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 (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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Cloud Batch Job description.

Return type

google.cloud.batch_v1alpha.types.Job

create_resource_allowance(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.CreateResourceAllowanceRequest, dict]] = None, *, parent: Optional[str] = None, resource_allowance: Optional[google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance] = None, resource_allowance_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance[source]¶

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

def sample_create_resource_allowance():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    resource_allowance = batch_v1alpha.ResourceAllowance()
    resource_allowance.usage_resource_allowance.spec.type_ = "type__value"
    resource_allowance.usage_resource_allowance.spec.limit.calendar_period = "DAY"

    request = batch_v1alpha.CreateResourceAllowanceRequest(
        parent="parent_value",
        resource_allowance=resource_allowance,
    )

    # Make the request
    response = client.create_resource_allowance(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[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 (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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project.

Return type

google.cloud.batch_v1alpha.types.ResourceAllowance

delete_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.DeleteJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

def sample_delete_job():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.DeleteJobRequest(
    )

    # Make the request
    operation = client.delete_job(request=request)

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation.Operation

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

None

delete_resource_allowance(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.DeleteResourceAllowanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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

def sample_delete_resource_allowance():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.DeleteResourceAllowanceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_resource_allowance(request=request)

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BatchServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BatchServiceClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BatchServiceClient

get_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.GetJobRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.job.Job[source]¶

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

def sample_get_job():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.GetJobRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Cloud Batch Job description.

Return type

google.cloud.batch_v1alpha.types.Job

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An Operation object.

Return type

Operation

get_resource_allowance(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.GetResourceAllowanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance[source]¶

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

def sample_get_resource_allowance():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.GetResourceAllowanceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_resource_allowance(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project.

Return type

google.cloud.batch_v1alpha.types.ResourceAllowance

get_task(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.GetTaskRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.task.Task[source]¶

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

def sample_get_task():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.GetTaskRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_task(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A Cloud Batch task.

Return type

google.cloud.batch_v1alpha.types.Task

static job_path(project: str, location: str, job: str) → str[source]¶: Returns a fully-qualified job string.

list_jobs(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.ListJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsPager[source]¶

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

def sample_list_jobs():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.ListJobsRequest(
    )

    # Make the request
    page_result = client.list_jobs(request=request)

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

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

ListJob Response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsPager

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

list_resource_allowances(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesPager[source]¶

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

def sample_list_resource_allowances():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.ListResourceAllowancesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_resource_allowances(request=request)

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

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

ListResourceAllowances Response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesPager

list_tasks(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.ListTasksRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksPager[source]¶

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

def sample_list_tasks():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.ListTasksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_tasks(request=request)

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

Parameters

request (Union[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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

ListTasks Response.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksPager

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_job_path(path: str) → Dict[str, str][source]¶: Parses a job path into its component segments.

static parse_resource_allowance_path(path: str) → Dict[str, str][source]¶: Parses a resource_allowance path into its component segments.

static parse_task_group_path(path: str) → Dict[str, str][source]¶: Parses a task_group path into its component segments.

static parse_task_path(path: str) → Dict[str, str][source]¶: Parses a task path into its component segments.

static resource_allowance_path(project: str, location: str, resource_allowance: str) → str[source]¶: Returns a fully-qualified resource_allowance string.

static task_group_path(project: str, location: str, job: str, task_group: str) → str[source]¶: Returns a fully-qualified task_group string.

static task_path(project: str, location: str, job: str, task_group: str, task: str) → str[source]¶: Returns a fully-qualified task string.

property transport: google.cloud.batch_v1alpha.services.batch_service.transports.base.BatchServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

BatchServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_job(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.UpdateJobRequest, dict]] = None, *, job: Optional[google.cloud.batch_v1alpha.types.job.Job] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.job.Job[source]¶

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

def sample_update_job():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    request = batch_v1alpha.UpdateJobRequest(
    )

    # Make the request
    response = client.update_job(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.batch_v1alpha.types.UpdateJobRequest, dict]) – The request object. UpdateJob Request.
job (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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Cloud Batch Job description.

Return type

google.cloud.batch_v1alpha.types.Job

update_resource_allowance(request: Optional[Union[google.cloud.batch_v1alpha.types.batch.UpdateResourceAllowanceRequest, dict]] = None, *, resource_allowance: Optional[google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.batch_v1alpha.types.resource_allowance.ResourceAllowance[source]¶

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

def sample_update_resource_allowance():
    # Create a client
    client = batch_v1alpha.BatchServiceClient()

    # Initialize request argument(s)
    resource_allowance = batch_v1alpha.ResourceAllowance()
    resource_allowance.usage_resource_allowance.spec.type_ = "type__value"
    resource_allowance.usage_resource_allowance.spec.limit.calendar_period = "DAY"

    request = batch_v1alpha.UpdateResourceAllowanceRequest(
        resource_allowance=resource_allowance,
    )

    # Make the request
    response = client.update_resource_allowance(request=request)

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.batch_v1alpha.types.UpdateResourceAllowanceRequest, dict]) – The request object. UpdateResourceAllowance Request.
resource_allowance (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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The Resource Allowance description for Cloud Batch. Only one Resource Allowance is supported now under a specific location and project.

Return type

google.cloud.batch_v1alpha.types.ResourceAllowance

class google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsAsyncPager(method: Callable[[...], Awaitable[google.cloud.batch_v1alpha.types.batch.ListJobsResponse]], request: google.cloud.batch_v1alpha.types.batch.ListJobsRequest, response: google.cloud.batch_v1alpha.types.batch.ListJobsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_jobs requests.

This class thinly wraps an initial google.cloud.batch_v1alpha.types.ListJobsResponse object, and provides an __aiter__ method to iterate through its jobs field.

If there are more pages, the __aiter__ method will make additional ListJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual google.cloud.batch_v1alpha.types.ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.batch_v1alpha.types.ListJobsRequest) – The initial request object.
response (google.cloud.batch_v1alpha.types.ListJobsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.batch_v1alpha.services.batch_service.pagers.ListJobsPager(method: Callable[[...], google.cloud.batch_v1alpha.types.batch.ListJobsResponse], request: google.cloud.batch_v1alpha.types.batch.ListJobsRequest, response: google.cloud.batch_v1alpha.types.batch.ListJobsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_jobs requests.

This class thinly wraps an initial google.cloud.batch_v1alpha.types.ListJobsResponse object, and provides an __iter__ method to iterate through its jobs field.

If there are more pages, the __iter__ method will make additional ListJobs requests and continue to iterate through the jobs field on the corresponding responses.

All the usual google.cloud.batch_v1alpha.types.ListJobsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.batch_v1alpha.types.ListJobsRequest) – The initial request object.
response (google.cloud.batch_v1alpha.types.ListJobsResponse) – The initial response object.
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.

class google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesAsyncPager(method: Callable[[...], Awaitable[google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesResponse]], request: google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesRequest, response: google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_resource_allowances requests.

This class thinly wraps an initial google.cloud.batch_v1alpha.types.ListResourceAllowancesResponse object, and provides an __aiter__ method to iterate through its resource_allowances field.

If there are more pages, the __aiter__ method will make additional ListResourceAllowances requests and continue to iterate through the resource_allowances field on the corresponding responses.

All the usual google.cloud.batch_v1alpha.types.ListResourceAllowancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.batch_v1alpha.types.ListResourceAllowancesRequest) – The initial request object.
response (google.cloud.batch_v1alpha.types.ListResourceAllowancesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.batch_v1alpha.services.batch_service.pagers.ListResourceAllowancesPager(method: Callable[[...], google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesResponse], request: google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesRequest, response: google.cloud.batch_v1alpha.types.batch.ListResourceAllowancesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_resource_allowances requests.

This class thinly wraps an initial google.cloud.batch_v1alpha.types.ListResourceAllowancesResponse object, and provides an __iter__ method to iterate through its resource_allowances field.

If there are more pages, the __iter__ method will make additional ListResourceAllowances requests and continue to iterate through the resource_allowances field on the corresponding responses.

All the usual google.cloud.batch_v1alpha.types.ListResourceAllowancesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.batch_v1alpha.types.ListResourceAllowancesRequest) – The initial request object.
response (google.cloud.batch_v1alpha.types.ListResourceAllowancesResponse) – The initial response object.
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.

class google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksAsyncPager(method: Callable[[...], Awaitable[google.cloud.batch_v1alpha.types.batch.ListTasksResponse]], request: google.cloud.batch_v1alpha.types.batch.ListTasksRequest, response: google.cloud.batch_v1alpha.types.batch.ListTasksResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_tasks requests.

This class thinly wraps an initial google.cloud.batch_v1alpha.types.ListTasksResponse object, and provides an __aiter__ method to iterate through its tasks field.

If there are more pages, the __aiter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual google.cloud.batch_v1alpha.types.ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.batch_v1alpha.types.ListTasksRequest) – The initial request object.
response (google.cloud.batch_v1alpha.types.ListTasksResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.batch_v1alpha.services.batch_service.pagers.ListTasksPager(method: Callable[[...], google.cloud.batch_v1alpha.types.batch.ListTasksResponse], request: google.cloud.batch_v1alpha.types.batch.ListTasksRequest, response: google.cloud.batch_v1alpha.types.batch.ListTasksResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_tasks requests.

This class thinly wraps an initial google.cloud.batch_v1alpha.types.ListTasksResponse object, and provides an __iter__ method to iterate through its tasks field.

If there are more pages, the __iter__ method will make additional ListTasks requests and continue to iterate through the tasks field on the corresponding responses.

All the usual google.cloud.batch_v1alpha.types.ListTasksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.batch_v1alpha.types.ListTasksRequest) – The initial request object.
response (google.cloud.batch_v1alpha.types.ListTasksResponse) – The initial response object.
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.

BatchService¶

google-cloud-batch

Navigation

Related Topics