com.google.api.services.dataflow

Class Dataflow.Projects.Locations.Sql.Validate

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<ValidateResponse>

com.google.api.services.dataflow.Dataflow.Projects.Locations.Sql.Validate

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataflow.Projects.Locations.Sql

public class Dataflow.Projects.Locations.Sql.Validate
extends DataflowRequest<ValidateResponse>

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

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	Validate(String projectId, String location) Validates a GoogleSQL query for Cloud Dataflow syntax.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getLocation() The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
String	getProjectId() Required.
String	getQuery() The sql query to validate.
Dataflow.Projects.Locations.Sql.Validate	set(String parameterName, Object value)
Dataflow.Projects.Locations.Sql.Validate	set$Xgafv(String $Xgafv) V1 error format.
Dataflow.Projects.Locations.Sql.Validate	setAccessToken(String accessToken) OAuth access token.
Dataflow.Projects.Locations.Sql.Validate	setAlt(String alt) Data format for response.
Dataflow.Projects.Locations.Sql.Validate	setCallback(String callback) JSONP
Dataflow.Projects.Locations.Sql.Validate	setFields(String fields) Selector specifying which fields to include in a partial response.
Dataflow.Projects.Locations.Sql.Validate	setKey(String key) API key.
Dataflow.Projects.Locations.Sql.Validate	setLocation(String location) The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) to which to direct the request.
Dataflow.Projects.Locations.Sql.Validate	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dataflow.Projects.Locations.Sql.Validate	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dataflow.Projects.Locations.Sql.Validate	setProjectId(String projectId) Required.
Dataflow.Projects.Locations.Sql.Validate	setQuery(String query) The sql query to validate.
Dataflow.Projects.Locations.Sql.Validate	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dataflow.Projects.Locations.Sql.Validate	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dataflow.Projects.Locations.Sql.Validate	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, 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

Validate

protected Validate(String projectId,
                   String location)

Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the given query parses correctly, and if able to look up schema information from DataCatalog, will validate that the query analyzes properly as well. Create a request for the method "sql.validate". 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 - Required. The ID of the Cloud Platform project that the job belongs to.

location - The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ValidateResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ValidateResponse>

Throws:

IOException

set$Xgafv

public Dataflow.Projects.Locations.Sql.Validate set$Xgafv(String $Xgafv)

Description copied from class: DataflowRequest

V1 error format.

Overrides:

set$Xgafv in class DataflowRequest<ValidateResponse>

setAccessToken

public Dataflow.Projects.Locations.Sql.Validate setAccessToken(String accessToken)

Description copied from class: DataflowRequest

OAuth access token.

Overrides:

setAccessToken in class DataflowRequest<ValidateResponse>

setAlt

public Dataflow.Projects.Locations.Sql.Validate setAlt(String alt)

Description copied from class: DataflowRequest

Data format for response.

Overrides:

setAlt in class DataflowRequest<ValidateResponse>

setCallback

public Dataflow.Projects.Locations.Sql.Validate setCallback(String callback)

Description copied from class: DataflowRequest

JSONP

Overrides:

setCallback in class DataflowRequest<ValidateResponse>

setFields

public Dataflow.Projects.Locations.Sql.Validate setFields(String fields)

Description copied from class: DataflowRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DataflowRequest<ValidateResponse>

setKey

public Dataflow.Projects.Locations.Sql.Validate 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<ValidateResponse>

setOauthToken

public Dataflow.Projects.Locations.Sql.Validate setOauthToken(String oauthToken)

Description copied from class: DataflowRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DataflowRequest<ValidateResponse>

setPrettyPrint

public Dataflow.Projects.Locations.Sql.Validate setPrettyPrint(Boolean prettyPrint)

Description copied from class: DataflowRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DataflowRequest<ValidateResponse>

setQuotaUser

public Dataflow.Projects.Locations.Sql.Validate 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<ValidateResponse>

setUploadType

public Dataflow.Projects.Locations.Sql.Validate setUploadType(String uploadType)

Description copied from class: DataflowRequest

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

Overrides:

setUploadType in class DataflowRequest<ValidateResponse>

setUploadProtocol

public Dataflow.Projects.Locations.Sql.Validate setUploadProtocol(String uploadProtocol)

Description copied from class: DataflowRequest

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

Overrides:

setUploadProtocol in class DataflowRequest<ValidateResponse>

getProjectId

public String getProjectId()

Required. The ID of the Cloud Platform project that the job belongs to.

setProjectId

public Dataflow.Projects.Locations.Sql.Validate setProjectId(String projectId)

Required. The ID of the Cloud Platform project that the job belongs to.

getLocation

public String getLocation()

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.

setLocation

public Dataflow.Projects.Locations.Sql.Validate setLocation(String location)

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) to which to direct the request.

getQuery

public String getQuery()

The sql query to validate.

setQuery

public Dataflow.Projects.Locations.Sql.Validate setQuery(String query)

The sql query to validate.

set

public Dataflow.Projects.Locations.Sql.Validate set(String parameterName,
                                                    Object value)

Overrides:

set in class DataflowRequest<ValidateResponse>