Dataflow.Projects.Locations.Templates.Get (Dataflow API v1b3 (Rev. 302) 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.dataflow.DataflowRequest<GetTemplateResponse>
        
        com.google.api.services.dataflow.Dataflow.Projects.Locations.Templates.Get

All Implemented Interfaces:

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

Enclosing class:

Dataflow.Projects.Locations.Templates
```
public class Dataflow.Projects.Locations.Templates.Get
extends DataflowRequest<GetTemplateResponse>
```

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 Get(java.lang.String projectId, java.lang.String location)
Get the template associated with a template.

Constructors
Modifier	Constructor and Description
`protected`	`Get(java.lang.String projectId, java.lang.String location)` Get the template associated with a template.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getGcsPath()` Required.
`java.lang.String`	`getLocation()` The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request.
`java.lang.String`	`getProjectId()` Required.
`java.lang.String`	`getView()` The view to retrieve.
`Dataflow.Projects.Locations.Templates.Get`	`set(java.lang.String parameterName, java.lang.Object value)`
`Dataflow.Projects.Locations.Templates.Get`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Dataflow.Projects.Locations.Templates.Get`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Dataflow.Projects.Locations.Templates.Get`	`setAlt(java.lang.String alt)` Data format for response.
`Dataflow.Projects.Locations.Templates.Get`	`setCallback(java.lang.String callback)` JSONP
`Dataflow.Projects.Locations.Templates.Get`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Dataflow.Projects.Locations.Templates.Get`	`setGcsPath(java.lang.String gcsPath)` Required.
`Dataflow.Projects.Locations.Templates.Get`	`setKey(java.lang.String key)` API key.
`Dataflow.Projects.Locations.Templates.Get`	`setLocation(java.lang.String location)` The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) to which to direct the request.
`Dataflow.Projects.Locations.Templates.Get`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Dataflow.Projects.Locations.Templates.Get`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dataflow.Projects.Locations.Templates.Get`	`setProjectId(java.lang.String projectId)` Required.
`Dataflow.Projects.Locations.Templates.Get`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Dataflow.Projects.Locations.Templates.Get`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Dataflow.Projects.Locations.Templates.Get`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.
`Dataflow.Projects.Locations.Templates.Get`	`setView(java.lang.String view)` The view to retrieve.

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
  - Get
```
protected Get(java.lang.String projectId,
              java.lang.String location)
```
    Get the template associated with a template. Create a request for the method "templates.get". 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 java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetTemplateResponse>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GetTemplateResponse>
    
    Throws:
    
    java.io.IOException
  - set$Xgafv
```
public Dataflow.Projects.Locations.Templates.Get set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: DataflowRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DataflowRequest<GetTemplateResponse>
  - setAccessToken
```
public Dataflow.Projects.Locations.Templates.Get setAccessToken(java.lang.String accessToken)
```
    Description copied from class: DataflowRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DataflowRequest<GetTemplateResponse>
  - setAlt
```
public Dataflow.Projects.Locations.Templates.Get setAlt(java.lang.String alt)
```
    Description copied from class: DataflowRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DataflowRequest<GetTemplateResponse>
  - setCallback
```
public Dataflow.Projects.Locations.Templates.Get setCallback(java.lang.String callback)
```
    Description copied from class: DataflowRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DataflowRequest<GetTemplateResponse>
  - setFields
```
public Dataflow.Projects.Locations.Templates.Get setFields(java.lang.String fields)
```
    Description copied from class: DataflowRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class DataflowRequest<GetTemplateResponse>
  - setKey
```
public Dataflow.Projects.Locations.Templates.Get setKey(java.lang.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<GetTemplateResponse>
  - setOauthToken
```
public Dataflow.Projects.Locations.Templates.Get setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: DataflowRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DataflowRequest<GetTemplateResponse>
  - setPrettyPrint
```
public Dataflow.Projects.Locations.Templates.Get setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: DataflowRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DataflowRequest<GetTemplateResponse>
  - setQuotaUser
```
public Dataflow.Projects.Locations.Templates.Get setQuotaUser(java.lang.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<GetTemplateResponse>
  - setUploadType
```
public Dataflow.Projects.Locations.Templates.Get setUploadType(java.lang.String uploadType)
```
    Description copied from class: DataflowRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DataflowRequest<GetTemplateResponse>
  - setUploadProtocol
```
public Dataflow.Projects.Locations.Templates.Get setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: DataflowRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DataflowRequest<GetTemplateResponse>
  - getProjectId
```
public java.lang.String getProjectId()
```
    Required. The ID of the Cloud Platform project that the job belongs to.
  - setProjectId
```
public Dataflow.Projects.Locations.Templates.Get setProjectId(java.lang.String projectId)
```
    Required. The ID of the Cloud Platform project that the job belongs to.
  - getLocation
```
public java.lang.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.Templates.Get setLocation(java.lang.String location)
```
    The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) to which to direct the request.
  - getView
```
public java.lang.String getView()
```
    The view to retrieve. Defaults to METADATA_ONLY.
  - setView
```
public Dataflow.Projects.Locations.Templates.Get setView(java.lang.String view)
```
    The view to retrieve. Defaults to METADATA_ONLY.
  - getGcsPath
```
public java.lang.String getGcsPath()
```
    Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
  - setGcsPath
```
public Dataflow.Projects.Locations.Templates.Get setGcsPath(java.lang.String gcsPath)
```
    Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
  - set
```
public Dataflow.Projects.Locations.Templates.Get set(java.lang.String parameterName,
                                                     java.lang.Object value)
```
    Overrides:
    
    set in class DataflowRequest<GetTemplateResponse>

Dataflow API v1b3 (revision 302)

Class Dataflow.Projects.Locations.Templates.Get

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.dataflow.DataflowRequest

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

Get

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getProjectId

setProjectId

getLocation

setLocation

getView

setView

getGcsPath

setGcsPath

set