Class BatchServiceClient (0.17.31)

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

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the batch service client.

Releases underlying transport's resources.

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)

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.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

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)

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)

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)

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.

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)

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

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

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

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)

Gets information about a location.

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.

Gets the latest state of a long-running operation.

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)

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)

Returns a fully-qualified job string.

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)

Lists information about the supported locations for this service.

Lists operations that match the specified filter in the request.

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)

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)

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a job path into its component segments.

Parses a resource_allowance path into its component segments.

Parses a task_group path into its component segments.

Parses a task path into its component segments.

Returns a fully-qualified resource_allowance string.

Returns a fully-qualified task_group string.

Returns a fully-qualified task string.

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)

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)