com.google.api.services.dataflow

Class Dataflow.Projects.Locations.Jobs.GetMetrics

java.lang.Object

java.util.AbstractMap<String,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.dataflow.DataflowRequest<JobMetrics>

com.google.api.services.dataflow.Dataflow.Projects.Locations.Jobs.GetMetrics

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataflow.Projects.Locations.Jobs

public class Dataflow.Projects.Locations.Jobs.GetMetrics
extends DataflowRequest<JobMetrics>

Nested Class Summary

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

GenericData.Flags

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

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

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	GetMetrics(String projectId, String location, String jobId) Request the job status.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getJobId() The job to get metrics for.
String	getLocation() The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
String	getProjectId() A project id.
String	getStartTime() Return only metric data that has changed since this time.
Dataflow.Projects.Locations.Jobs.GetMetrics	set(String parameterName, Object value)
Dataflow.Projects.Locations.Jobs.GetMetrics	set$Xgafv(String $Xgafv) V1 error format.
Dataflow.Projects.Locations.Jobs.GetMetrics	setAccessToken(String accessToken) OAuth access token.
Dataflow.Projects.Locations.Jobs.GetMetrics	setAlt(String alt) Data format for response.
Dataflow.Projects.Locations.Jobs.GetMetrics	setCallback(String callback) JSONP
Dataflow.Projects.Locations.Jobs.GetMetrics	setFields(String fields) Selector specifying which fields to include in a partial response.
Dataflow.Projects.Locations.Jobs.GetMetrics	setJobId(String jobId) The job to get metrics for.
Dataflow.Projects.Locations.Jobs.GetMetrics	setKey(String key) API key.
Dataflow.Projects.Locations.Jobs.GetMetrics	setLocation(String location) The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) that contains the job specified by job_id.
Dataflow.Projects.Locations.Jobs.GetMetrics	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dataflow.Projects.Locations.Jobs.GetMetrics	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dataflow.Projects.Locations.Jobs.GetMetrics	setProjectId(String projectId) A project id.
Dataflow.Projects.Locations.Jobs.GetMetrics	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dataflow.Projects.Locations.Jobs.GetMetrics	setStartTime(String startTime) Return only metric data that has changed since this time.
Dataflow.Projects.Locations.Jobs.GetMetrics	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dataflow.Projects.Locations.Jobs.GetMetrics	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dataflow.DataflowRequest

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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, 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

GetMetrics

protected GetMetrics(String projectId,
                     String location,
                     String jobId)

Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. Create a request for the method "jobs.getMetrics". This request holds the parameters needed by the the dataflow server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

projectId - A project id.

location - The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

jobId - The job to get metrics for.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<JobMetrics>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<JobMetrics>

Throws:

IOException

set$Xgafv

public Dataflow.Projects.Locations.Jobs.GetMetrics set$Xgafv(String $Xgafv)

Description copied from class: DataflowRequest

V1 error format.

Overrides:

set$Xgafv in class DataflowRequest<JobMetrics>

setAccessToken

public Dataflow.Projects.Locations.Jobs.GetMetrics setAccessToken(String accessToken)

Description copied from class: DataflowRequest

OAuth access token.

Overrides:

setAccessToken in class DataflowRequest<JobMetrics>

setAlt

public Dataflow.Projects.Locations.Jobs.GetMetrics setAlt(String alt)

Description copied from class: DataflowRequest

Data format for response.

Overrides:

setAlt in class DataflowRequest<JobMetrics>

setCallback

public Dataflow.Projects.Locations.Jobs.GetMetrics setCallback(String callback)

Description copied from class: DataflowRequest

JSONP

Overrides:

setCallback in class DataflowRequest<JobMetrics>

setFields

public Dataflow.Projects.Locations.Jobs.GetMetrics setFields(String fields)

Description copied from class: DataflowRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DataflowRequest<JobMetrics>

setKey

public Dataflow.Projects.Locations.Jobs.GetMetrics setKey(String key)

Description copied from class: DataflowRequest

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 DataflowRequest<JobMetrics>

setOauthToken

public Dataflow.Projects.Locations.Jobs.GetMetrics setOauthToken(String oauthToken)

Description copied from class: DataflowRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DataflowRequest<JobMetrics>

setPrettyPrint

public Dataflow.Projects.Locations.Jobs.GetMetrics setPrettyPrint(Boolean prettyPrint)

Description copied from class: DataflowRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DataflowRequest<JobMetrics>

setQuotaUser

public Dataflow.Projects.Locations.Jobs.GetMetrics setQuotaUser(String quotaUser)

Description copied from class: DataflowRequest

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 DataflowRequest<JobMetrics>

setUploadType

public Dataflow.Projects.Locations.Jobs.GetMetrics setUploadType(String uploadType)

Description copied from class: DataflowRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DataflowRequest<JobMetrics>

setUploadProtocol

public Dataflow.Projects.Locations.Jobs.GetMetrics setUploadProtocol(String uploadProtocol)

Description copied from class: DataflowRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DataflowRequest<JobMetrics>

getProjectId

public String getProjectId()

A project id.

setProjectId

public Dataflow.Projects.Locations.Jobs.GetMetrics setProjectId(String projectId)

A project id.

getLocation

public String getLocation()

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

setLocation

public Dataflow.Projects.Locations.Jobs.GetMetrics setLocation(String location)

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) that contains the job specified by job_id.

getJobId

public String getJobId()

The job to get metrics for.

setJobId

public Dataflow.Projects.Locations.Jobs.GetMetrics setJobId(String jobId)

The job to get metrics for.

getStartTime

public String getStartTime()

Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

setStartTime

public Dataflow.Projects.Locations.Jobs.GetMetrics setStartTime(String startTime)

Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

set

public Dataflow.Projects.Locations.Jobs.GetMetrics set(String parameterName,
                                                       Object value)

Overrides:

set in class DataflowRequest<JobMetrics>