Dataflow.Projects.Locations.Templates.Launch (Dataflow API v1b3 (Rev. 284) 1.24.1)

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<LaunchTemplateResponse>
        
        com.google.api.services.dataflow.Dataflow.Projects.Locations.Templates.Launch

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.Launch
extends DataflowRequest<LaunchTemplateResponse>
```

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 Launch(java.lang.String projectId, java.lang.String location, LaunchTemplateParameters content)
Launch a template.

Constructors
Modifier	Constructor and Description
`protected`	`Launch(java.lang.String projectId, java.lang.String location, LaunchTemplateParameters content)` Launch a template.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDynamicTemplateGcsPath()` Path to dynamic template spec file on GCS.
`java.lang.String`	`getDynamicTemplateStagingLocation()` Cloud Storage path for staging dependencies.
`java.lang.String`	`getGcsPath()` A Cloud Storage path to the template from which to create the job.
`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.Boolean`	`getValidateOnly()` If true, the request is validated but not actually executed.
`Dataflow.Projects.Locations.Templates.Launch`	`set(java.lang.String parameterName, java.lang.Object value)`
`Dataflow.Projects.Locations.Templates.Launch`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Dataflow.Projects.Locations.Templates.Launch`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Dataflow.Projects.Locations.Templates.Launch`	`setAlt(java.lang.String alt)` Data format for response.
`Dataflow.Projects.Locations.Templates.Launch`	`setCallback(java.lang.String callback)` JSONP
`Dataflow.Projects.Locations.Templates.Launch`	`setDynamicTemplateGcsPath(java.lang.String dynamicTemplateGcsPath)` Path to dynamic template spec file on GCS.
`Dataflow.Projects.Locations.Templates.Launch`	`setDynamicTemplateStagingLocation(java.lang.String dynamicTemplateStagingLocation)` Cloud Storage path for staging dependencies.
`Dataflow.Projects.Locations.Templates.Launch`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Dataflow.Projects.Locations.Templates.Launch`	`setGcsPath(java.lang.String gcsPath)` A Cloud Storage path to the template from which to create the job.
`Dataflow.Projects.Locations.Templates.Launch`	`setKey(java.lang.String key)` API key.
`Dataflow.Projects.Locations.Templates.Launch`	`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.Launch`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Dataflow.Projects.Locations.Templates.Launch`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Dataflow.Projects.Locations.Templates.Launch`	`setProjectId(java.lang.String projectId)` Required.
`Dataflow.Projects.Locations.Templates.Launch`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Dataflow.Projects.Locations.Templates.Launch`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Dataflow.Projects.Locations.Templates.Launch`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.
`Dataflow.Projects.Locations.Templates.Launch`	`setValidateOnly(java.lang.Boolean validateOnly)` If true, the request is validated but not actually executed.

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, 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
  - Launch
```
protected Launch(java.lang.String projectId,
                 java.lang.String location,
                 LaunchTemplateParameters content)
```
    Launch a template. Create a request for the method "templates.launch". 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.
    
    content - the LaunchTemplateParameters
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Dataflow.Projects.Locations.Templates.Launch set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: DataflowRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class DataflowRequest<LaunchTemplateResponse>
  - setAccessToken
```
public Dataflow.Projects.Locations.Templates.Launch setAccessToken(java.lang.String accessToken)
```
    Description copied from class: DataflowRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class DataflowRequest<LaunchTemplateResponse>
  - setAlt
```
public Dataflow.Projects.Locations.Templates.Launch setAlt(java.lang.String alt)
```
    Description copied from class: DataflowRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class DataflowRequest<LaunchTemplateResponse>
  - setCallback
```
public Dataflow.Projects.Locations.Templates.Launch setCallback(java.lang.String callback)
```
    Description copied from class: DataflowRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class DataflowRequest<LaunchTemplateResponse>
  - setFields
```
public Dataflow.Projects.Locations.Templates.Launch 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<LaunchTemplateResponse>
  - setKey
```
public Dataflow.Projects.Locations.Templates.Launch 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<LaunchTemplateResponse>
  - setOauthToken
```
public Dataflow.Projects.Locations.Templates.Launch setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: DataflowRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class DataflowRequest<LaunchTemplateResponse>
  - setPrettyPrint
```
public Dataflow.Projects.Locations.Templates.Launch setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: DataflowRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class DataflowRequest<LaunchTemplateResponse>
  - setQuotaUser
```
public Dataflow.Projects.Locations.Templates.Launch 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<LaunchTemplateResponse>
  - setUploadType
```
public Dataflow.Projects.Locations.Templates.Launch setUploadType(java.lang.String uploadType)
```
    Description copied from class: DataflowRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class DataflowRequest<LaunchTemplateResponse>
  - setUploadProtocol
```
public Dataflow.Projects.Locations.Templates.Launch setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: DataflowRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class DataflowRequest<LaunchTemplateResponse>
  - 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.Launch 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.Launch setLocation(java.lang.String location)
```
    The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional- endpoints) to which to direct the request.
  - getGcsPath
```
public java.lang.String getGcsPath()
```
    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.Launch setGcsPath(java.lang.String gcsPath)
```
    A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
  - getDynamicTemplateGcsPath
```
public java.lang.String getDynamicTemplateGcsPath()
```
    Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object.
  - setDynamicTemplateGcsPath
```
public Dataflow.Projects.Locations.Templates.Launch setDynamicTemplateGcsPath(java.lang.String dynamicTemplateGcsPath)
```
    Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object.
  - getDynamicTemplateStagingLocation
```
public java.lang.String getDynamicTemplateStagingLocation()
```
    Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`.
  - setDynamicTemplateStagingLocation
```
public Dataflow.Projects.Locations.Templates.Launch setDynamicTemplateStagingLocation(java.lang.String dynamicTemplateStagingLocation)
```
    Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`.
  - getValidateOnly
```
public java.lang.Boolean getValidateOnly()
```
    If true, the request is validated but not actually executed. Defaults to false.
  - setValidateOnly
```
public Dataflow.Projects.Locations.Templates.Launch setValidateOnly(java.lang.Boolean validateOnly)
```
    If true, the request is validated but not actually executed. Defaults to false.
  - set
```
public Dataflow.Projects.Locations.Templates.Launch set(java.lang.String parameterName,
                                                        java.lang.Object value)
```
    Overrides:
    
    set in class DataflowRequest<LaunchTemplateResponse>

Dataflow API v1b3 (revision 284)

Class Dataflow.Projects.Locations.Templates.Launch

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

Launch

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getProjectId

setProjectId

getLocation

setLocation

getGcsPath

setGcsPath

getDynamicTemplateGcsPath

setDynamicTemplateGcsPath

getDynamicTemplateStagingLocation

setDynamicTemplateStagingLocation

getValidateOnly

setValidateOnly

set