CloudScheduler.Projects.Locations.Jobs.Run (Cloud Scheduler API v1beta1 (Rev. 31) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.cloudscheduler.v1beta1.CloudSchedulerRequest<Job>
        
        com.google.api.services.cloudscheduler.v1beta1.CloudScheduler.Projects.Locations.Jobs.Run

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

CloudScheduler.Projects.Locations.Jobs
```
public class CloudScheduler.Projects.Locations.Jobs.Run
extends CloudSchedulerRequest<Job>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Run(java.lang.String name, RunJobRequest content)
Forces a job to run now.

Constructors
Modifier	Constructor and Description
`protected`	`Run(java.lang.String name, RunJobRequest content)` Forces a job to run now.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getName()` Required.
`CloudScheduler.Projects.Locations.Jobs.Run`	`set(java.lang.String parameterName, java.lang.Object value)`
`CloudScheduler.Projects.Locations.Jobs.Run`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setAlt(java.lang.String alt)` Data format for response.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setCallback(java.lang.String callback)` JSONP
`CloudScheduler.Projects.Locations.Jobs.Run`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setKey(java.lang.String key)` API key.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setName(java.lang.String name)` Required.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`CloudScheduler.Projects.Locations.Jobs.Run`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.cloudscheduler.v1beta1.CloudSchedulerRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Run
```
protected Run(java.lang.String name,
              RunJobRequest content)
```
    Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. Create a request for the method "jobs.run". This request holds the parameters needed by the the cloudscheduler server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    CloudScheduler.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
    
    content - the RunJobRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public CloudScheduler.Projects.Locations.Jobs.Run set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: CloudSchedulerRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudSchedulerRequest<Job>
  - setAccessToken
```
public CloudScheduler.Projects.Locations.Jobs.Run setAccessToken(java.lang.String accessToken)
```
    Description copied from class: CloudSchedulerRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudSchedulerRequest<Job>
  - setAlt
```
public CloudScheduler.Projects.Locations.Jobs.Run setAlt(java.lang.String alt)
```
    Description copied from class: CloudSchedulerRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudSchedulerRequest<Job>
  - setCallback
```
public CloudScheduler.Projects.Locations.Jobs.Run setCallback(java.lang.String callback)
```
    Description copied from class: CloudSchedulerRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudSchedulerRequest<Job>
  - setFields
```
public CloudScheduler.Projects.Locations.Jobs.Run setFields(java.lang.String fields)
```
    Description copied from class: CloudSchedulerRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudSchedulerRequest<Job>
  - setKey
```
public CloudScheduler.Projects.Locations.Jobs.Run setKey(java.lang.String key)
```
    Description copied from class: CloudSchedulerRequest
    
    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.
    
    Overrides:
    
    setKey in class CloudSchedulerRequest<Job>
  - setOauthToken
```
public CloudScheduler.Projects.Locations.Jobs.Run setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: CloudSchedulerRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudSchedulerRequest<Job>
  - setPrettyPrint
```
public CloudScheduler.Projects.Locations.Jobs.Run setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: CloudSchedulerRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudSchedulerRequest<Job>
  - setQuotaUser
```
public CloudScheduler.Projects.Locations.Jobs.Run setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: CloudSchedulerRequest
    
    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.
    
    Overrides:
    
    setQuotaUser in class CloudSchedulerRequest<Job>
  - setUploadType
```
public CloudScheduler.Projects.Locations.Jobs.Run setUploadType(java.lang.String uploadType)
```
    Description copied from class: CloudSchedulerRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudSchedulerRequest<Job>
  - setUploadProtocol
```
public CloudScheduler.Projects.Locations.Jobs.Run setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: CloudSchedulerRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudSchedulerRequest<Job>
  - getName
```
public java.lang.String getName()
```
    Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
  - setName
```
public CloudScheduler.Projects.Locations.Jobs.Run setName(java.lang.String name)
```
    Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
  - set
```
public CloudScheduler.Projects.Locations.Jobs.Run set(java.lang.String parameterName,
                                                      java.lang.Object value)
```
    Overrides:
    
    set in class CloudSchedulerRequest<Job>

Cloud Scheduler API v1beta1 (revision 31)

Class CloudScheduler.Projects.Locations.Jobs.Run

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.cloudscheduler.v1beta1.CloudSchedulerRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Run

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

set