CloudSchedulerAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.scheduler_v1beta1.services.cloud_scheduler.transports.base.CloudSchedulerTransport] = '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>)
The Cloud Scheduler API allows external entities to reliably schedule asynchronous jobs.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
CloudSchedulerTransport | The transport used by the client instance. |
Methods
CloudSchedulerAsyncClient
CloudSchedulerAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.scheduler_v1beta1.services.cloud_scheduler.transports.base.CloudSchedulerTransport] = '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>)
Instantiates the cloud scheduler client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_job
create_job(
request: typing.Optional[
typing.Union[
google.cloud.scheduler_v1beta1.types.cloudscheduler.CreateJobRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
job: typing.Optional[google.cloud.scheduler_v1beta1.types.job.Job] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.scheduler_v1beta1.types.job.Job
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)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.scheduler_v1beta1.types.CreateJobRequest, dict]]
The request object. Request message for CreateJob. |
parent |
Required. The location name. For example: |
job |
Job
Required. The job to add. The user can optionally specify a name for the job in name. name cannot be the same as an existing job. If a name is not specified then the system will generate a random unique name that will be returned (name) in the response. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.scheduler_v1beta1.types.Job | Configuration for a job. The maximum allowed size for a job is 1MB. |
delete_job
delete_job(
request: typing.Optional[
typing.Union[
google.cloud.scheduler_v1beta1.types.cloudscheduler.DeleteJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.scheduler_v1beta1.types.DeleteJobRequest, dict]]
The request object. Request message for deleting a job using DeleteJob. |
name |
Required. The job name. For example: |
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. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
CloudSchedulerAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
CloudSchedulerAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
CloudSchedulerAsyncClient | The constructed client. |
get_job
get_job(
request: typing.Optional[
typing.Union[
google.cloud.scheduler_v1beta1.types.cloudscheduler.GetJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.scheduler_v1beta1.types.job.Job
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)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.scheduler_v1beta1.types.GetJobRequest, dict]]
The request object. Request message for GetJob. |
name |
Required. The job name. For example: |
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 | |
---|---|
Type | Description |
google.cloud.scheduler_v1beta1.types.Job | Configuration for a job. The maximum allowed size for a job is 1MB. |
get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 | |
---|---|
Type | Description |
| Location object. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.scheduler_v1beta1.services.cloud_scheduler.transports.base.CloudSchedulerTransport
]
)
Returns an appropriate transport class.
Parameter | |
---|---|
Name | Description |
label |
typing.Optional[str]
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
job_path
job_path(project: str, location: str, job: str) -> str
Returns a fully-qualified job string.
list_jobs
list_jobs(
request: typing.Optional[
typing.Union[
google.cloud.scheduler_v1beta1.types.cloudscheduler.ListJobsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.scheduler_v1beta1.services.cloud_scheduler.pagers.ListJobsAsyncPager
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)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.scheduler_v1beta1.types.ListJobsRequest, dict]]
The request object. Request message for listing jobs using ListJobs. |
parent |
Required. The location name. For example: |
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 | |
---|---|
Type | Description |
google.cloud.scheduler_v1beta1.services.cloud_scheduler.pagers.ListJobsAsyncPager | Response message for listing jobs using ListJobs. Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 | |
---|---|
Type | Description |
| Response message for ListLocations method. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
parse_job_path
parse_job_path(path: str) -> typing.Dict[str, str]
Parses a job path into its component segments.
parse_topic_path
parse_topic_path(path: str) -> typing.Dict[str, str]
Parses a topic path into its component segments.
pause_job
pause_job(
request: typing.Optional[
typing.Union[
google.cloud.scheduler_v1beta1.types.cloudscheduler.PauseJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.scheduler_v1beta1.types.job.Job
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)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.scheduler_v1beta1.types.PauseJobRequest, dict]]
The request object. Request message for PauseJob. |
name |
Required. The job name. For example: |
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 | |
---|---|
Type | Description |
google.cloud.scheduler_v1beta1.types.Job | Configuration for a job. The maximum allowed size for a job is 1MB. |
resume_job
resume_job(
request: typing.Optional[
typing.Union[
google.cloud.scheduler_v1beta1.types.cloudscheduler.ResumeJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.scheduler_v1beta1.types.job.Job
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)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.scheduler_v1beta1.types.ResumeJobRequest, dict]]
The request object. Request message for ResumeJob. |
name |
Required. The job name. For example: |
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 | |
---|---|
Type | Description |
google.cloud.scheduler_v1beta1.types.Job | Configuration for a job. The maximum allowed size for a job is 1MB. |
run_job
run_job(
request: typing.Optional[
typing.Union[
google.cloud.scheduler_v1beta1.types.cloudscheduler.RunJobRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.scheduler_v1beta1.types.job.Job
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)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.scheduler_v1beta1.types.RunJobRequest, dict]]
The request object. Request message for forcing a job to run now using RunJob. |
name |
Required. The job name. For example: |
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 | |
---|---|
Type | Description |
google.cloud.scheduler_v1beta1.types.Job | Configuration for a job. The maximum allowed size for a job is 1MB. |
topic_path
topic_path(project: str, topic: str) -> str
Returns a fully-qualified topic string.
update_job
update_job(
request: typing.Optional[
typing.Union[
google.cloud.scheduler_v1beta1.types.cloudscheduler.UpdateJobRequest, dict
]
] = None,
*,
job: typing.Optional[google.cloud.scheduler_v1beta1.types.job.Job] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Union[
google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.scheduler_v1beta1.types.job.Job
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)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.scheduler_v1beta1.types.UpdateJobRequest, dict]]
The request object. Request message for UpdateJob. |
job |
Job
Required. The new job properties. name must be specified. Output only fields cannot be modified using UpdateJob. Any value specified for an output only field will be ignored. This corresponds to the |
update_mask |
A mask used to specify which fields of the job are being updated. This corresponds to the |
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 | |
---|---|
Type | Description |
google.cloud.scheduler_v1beta1.types.Job | Configuration for a job. The maximum allowed size for a job is 1MB. |