Class CloudSchedulerAsyncClient (2.14.1)

The Cloud Scheduler API allows external entities to reliably schedule asynchronous 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 cloud scheduler async client.

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.

Creates 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 scheduler_v1beta1

async def sample_create_job():
    # Create a client
    client = scheduler_v1beta1.CloudSchedulerAsyncClient()

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

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

    # Handle the response
    print(response)

Deletes 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 scheduler_v1beta1

async def sample_delete_job():
    # Create a client
    client = scheduler_v1beta1.CloudSchedulerAsyncClient()

    # Initialize request argument(s)
    request = scheduler_v1beta1.DeleteJobRequest(
        name="name_value",
    )

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

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.

Gets 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 scheduler_v1beta1

async def sample_get_job():
    # Create a client
    client = scheduler_v1beta1.CloudSchedulerAsyncClient()

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

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

    # Handle the response
    print(response)

Gets information about a location.

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.

Returns an appropriate transport class.

Returns a fully-qualified job string.

Lists jobs.

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

async def sample_list_jobs():
    # Create a client
    client = scheduler_v1beta1.CloudSchedulerAsyncClient()

    # Initialize request argument(s)
    request = scheduler_v1beta1.ListJobsRequest(
        parent="parent_value",
    )

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

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

Lists information about the supported locations for this service.

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 topic path into its component segments.

Pauses a job.

If a job is paused then the system will stop executing the job until it is re-enabled via xref_ResumeJob. The state of the job is stored in xref_state; if paused it will be set to xref_Job.State.PAUSED. A job must be in xref_Job.State.ENABLED to be paused.

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

async def sample_pause_job():
    # Create a client
    client = scheduler_v1beta1.CloudSchedulerAsyncClient()

    # Initialize request argument(s)
    request = scheduler_v1beta1.PauseJobRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Resume a job.

This method reenables a job after it has been xref_Job.State.PAUSED. The state of a job is stored in xref_Job.state; after calling this method it will be set to xref_Job.State.ENABLED. A job must be in xref_Job.State.PAUSED to be resumed.

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

async def sample_resume_job():
    # Create a client
    client = scheduler_v1beta1.CloudSchedulerAsyncClient()

    # Initialize request argument(s)
    request = scheduler_v1beta1.ResumeJobRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

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

async def sample_run_job():
    # Create a client
    client = scheduler_v1beta1.CloudSchedulerAsyncClient()

    # Initialize request argument(s)
    request = scheduler_v1beta1.RunJobRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Returns a fully-qualified topic string.

Updates a job.

If successful, the updated xref_Job is returned. If the job does not exist, NOT_FOUND is returned.

If UpdateJob does not successfully return, it is possible for the job to be in an xref_Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

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

async def sample_update_job():
    # Create a client
    client = scheduler_v1beta1.CloudSchedulerAsyncClient()

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

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

    # Handle the response
    print(response)