com.google.api.services.coordinate

Class Coordinate.Jobs.Patch

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.coordinate.CoordinateRequest<Job>

com.google.api.services.coordinate.Coordinate.Jobs.Patch

All Implemented Interfaces:

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

Enclosing class:

Coordinate.Jobs

public class Coordinate.Jobs.Patch
extends CoordinateRequest<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	Coordinate.Jobs.Patch(java.lang.String teamId, java.math.BigInteger jobId, Job content) Updates a job.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAddress() Job address as newline (Unix) separated string
java.lang.String	getAssignee() Assignee email address, or empty string to unassign.
java.lang.String	getCustomerName() Customer name
java.lang.String	getCustomerPhoneNumber() Customer phone number
java.util.List<java.lang.String>	getCustomField() Sets the value of custom fields.
java.math.BigInteger	getJobId() Job number
java.lang.Double	getLat() The latitude coordinate of this job's location.
java.lang.Double	getLng() The longitude coordinate of this job's location.
java.lang.String	getNote() Job note as newline (Unix) separated string
java.lang.String	getProgress() Job progress
java.lang.String	getTeamId() Team ID
java.lang.String	getTitle() Job title
Coordinate.Jobs.Patch	set(java.lang.String parameterName, java.lang.Object value)
Coordinate.Jobs.Patch	setAddress(java.lang.String address) Job address as newline (Unix) separated string
Coordinate.Jobs.Patch	setAlt(java.lang.String alt) Data format for the response.
Coordinate.Jobs.Patch	setAssignee(java.lang.String assignee) Assignee email address, or empty string to unassign.
Coordinate.Jobs.Patch	setCustomerName(java.lang.String customerName) Customer name
Coordinate.Jobs.Patch	setCustomerPhoneNumber(java.lang.String customerPhoneNumber) Customer phone number
Coordinate.Jobs.Patch	setCustomField(java.util.List<java.lang.String> customField) Sets the value of custom fields.
Coordinate.Jobs.Patch	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Coordinate.Jobs.Patch	setJobId(java.math.BigInteger jobId) Job number
Coordinate.Jobs.Patch	setKey(java.lang.String key) API key.
Coordinate.Jobs.Patch	setLat(java.lang.Double lat) The latitude coordinate of this job's location.
Coordinate.Jobs.Patch	setLng(java.lang.Double lng) The longitude coordinate of this job's location.
Coordinate.Jobs.Patch	setNote(java.lang.String note) Job note as newline (Unix) separated string
Coordinate.Jobs.Patch	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Coordinate.Jobs.Patch	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Coordinate.Jobs.Patch	setProgress(java.lang.String progress) Job progress
Coordinate.Jobs.Patch	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Coordinate.Jobs.Patch	setTeamId(java.lang.String teamId) Team ID
Coordinate.Jobs.Patch	setTitle(java.lang.String title) Job title
Coordinate.Jobs.Patch	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.coordinate.CoordinateRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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

Constructor Detail

Coordinate.Jobs.Patch

protected Coordinate.Jobs.Patch(java.lang.String teamId,
                     java.math.BigInteger jobId,
                     Job content)

Updates a job. Fields that are set in the job state will be updated. This method supports patch semantics. Create a request for the method "jobs.patch". This request holds the parameters needed by the the coordinate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Coordinate.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

teamId - Team ID

jobId - Job number

content - the Job

Since:

1.13

Method Detail

setAlt

public Coordinate.Jobs.Patch setAlt(java.lang.String alt)

Description copied from class: CoordinateRequest

Data format for the response.

Overrides:

setAlt in class CoordinateRequest<Job>

setFields

public Coordinate.Jobs.Patch setFields(java.lang.String fields)

Description copied from class: CoordinateRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class CoordinateRequest<Job>

setKey

public Coordinate.Jobs.Patch setKey(java.lang.String key)

Description copied from class: CoordinateRequest

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 CoordinateRequest<Job>

setOauthToken

public Coordinate.Jobs.Patch setOauthToken(java.lang.String oauthToken)

Description copied from class: CoordinateRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class CoordinateRequest<Job>

setPrettyPrint

public Coordinate.Jobs.Patch setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: CoordinateRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class CoordinateRequest<Job>

setQuotaUser

public Coordinate.Jobs.Patch setQuotaUser(java.lang.String quotaUser)

Description copied from class: CoordinateRequest

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 userIp if both are provided.

Overrides:

setQuotaUser in class CoordinateRequest<Job>

setUserIp

public Coordinate.Jobs.Patch setUserIp(java.lang.String userIp)

Description copied from class: CoordinateRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class CoordinateRequest<Job>

getTeamId

public java.lang.String getTeamId()

Team ID

setTeamId

public Coordinate.Jobs.Patch setTeamId(java.lang.String teamId)

Team ID

getJobId

public java.math.BigInteger getJobId()

Job number

setJobId

public Coordinate.Jobs.Patch setJobId(java.math.BigInteger jobId)

Job number

getAddress

public java.lang.String getAddress()

Job address as newline (Unix) separated string

setAddress

public Coordinate.Jobs.Patch setAddress(java.lang.String address)

Job address as newline (Unix) separated string

getAssignee

public java.lang.String getAssignee()

Assignee email address, or empty string to unassign.

setAssignee

public Coordinate.Jobs.Patch setAssignee(java.lang.String assignee)

Assignee email address, or empty string to unassign.

getCustomField

public java.util.List<java.lang.String> getCustomField()

Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.

setCustomField

public Coordinate.Jobs.Patch setCustomField(java.util.List<java.lang.String> customField)

Sets the value of custom fields. To set a custom field, pass the field id (from /team/teamId/custom_fields), a URL escaped '=' character, and the desired value as a parameter. For example, customField=12%3DAlice. Repeat the parameter for each custom field. Note that '=' cannot appear in the parameter value. Specifying an invalid, or inactive enum field will result in an error 500.

getCustomerName

public java.lang.String getCustomerName()

Customer name

setCustomerName

public Coordinate.Jobs.Patch setCustomerName(java.lang.String customerName)

Customer name

getCustomerPhoneNumber

public java.lang.String getCustomerPhoneNumber()

Customer phone number

setCustomerPhoneNumber

public Coordinate.Jobs.Patch setCustomerPhoneNumber(java.lang.String customerPhoneNumber)

Customer phone number

getLat

public java.lang.Double getLat()

The latitude coordinate of this job's location.

setLat

public Coordinate.Jobs.Patch setLat(java.lang.Double lat)

The latitude coordinate of this job's location.

getLng

public java.lang.Double getLng()

The longitude coordinate of this job's location.

setLng

public Coordinate.Jobs.Patch setLng(java.lang.Double lng)

The longitude coordinate of this job's location.

getNote

public java.lang.String getNote()

Job note as newline (Unix) separated string

setNote

public Coordinate.Jobs.Patch setNote(java.lang.String note)

Job note as newline (Unix) separated string

getProgress

public java.lang.String getProgress()

Job progress

setProgress

public Coordinate.Jobs.Patch setProgress(java.lang.String progress)

Job progress

getTitle

public java.lang.String getTitle()

Job title

setTitle

public Coordinate.Jobs.Patch setTitle(java.lang.String title)

Job title

set

public Coordinate.Jobs.Patch set(java.lang.String parameterName,
                        java.lang.Object value)

Overrides:

set in class CoordinateRequest<Job>