google_api_cloud_scheduler v0.5.0 GoogleApi.CloudScheduler.V1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Gets information about a location.
Creates a job.
Deletes a job.
Gets a job.
Lists jobs.
Updates a job.
Pauses a job.
Resume a job.
Forces a job to run now.
Lists information about the supported locations for this service.
Link to this section Functions
cloudscheduler_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.Location.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Resource name for the location. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.Location{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_jobs_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_jobs_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a job.
Parameters
-
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The location name. For example:projects/PROJECT_ID/locations/LOCATION_ID
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudScheduler.V1.Model.Job.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.Job{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_jobs_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_jobs_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a job.
Parameters
-
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The job name. For example:projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.Empty{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_jobs_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_jobs_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets a job.
Parameters
-
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The job name. For example:projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.Job{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_jobs_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_jobs_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.ListJobsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists jobs.
Parameters
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The location name. For example:projects/PROJECT_ID/locations/LOCATION_ID
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - Requested page size.The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist.
:pageToken
(type:String.t
) - A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.ListJobsResponse{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_jobs_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_jobs_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a job.
If successful, the updated 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 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.
Parameters
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to servername
(type:String.t
) - Optionally caller-specified in CreateJob, after which it becomes output only.The job name. For example:
projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
.PROJECT_ID
can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projectsLOCATION_ID
is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.JOB_ID
can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - A mask used to specify which fields of the job are being updated. -
:body
(type:GoogleApi.CloudScheduler.V1.Model.Job.t
) -
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.Job{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_jobs_pause(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_jobs_pause( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Pauses a job.
If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.
Parameters
-
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The job name. For example:projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudScheduler.V1.Model.PauseJobRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.Job{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_jobs_resume(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_jobs_resume( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Resume a job.
This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.
Parameters
-
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The job name. For example:projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudScheduler.V1.Model.ResumeJobRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.Job{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_jobs_run(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_jobs_run( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.Job.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Forces a job to run now.
When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.
Parameters
-
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The job name. For example:projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudScheduler.V1.Model.RunJobRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.Job{}}
on success -
{:error, info}
on failure
cloudscheduler_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudscheduler_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudScheduler.V1.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.CloudScheduler.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The resource that owns the locations collection, if applicable. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudScheduler.V1.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure