• Home
• com.google.apis
• google-api-services-dataflow
• v1b3-rev20231112-2.0.0
• source code
• Dataflow.Projects.Locations.Templates.Launch.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.dataflow.Dataflow.Projects.Locations.Templates.Launch.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataflow
Class Dataflow.Projects.Locations.Templates.Launch



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


com.google.api.services.dataflow.Dataflow.Projects.Locations.Templates.Launch

















All Implemented Interfaces:
Cloneable, Map<String,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
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 
Launch(String projectId,
      String location,
      LaunchTemplateParameters content)
Launch a template.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


String
getDynamicTemplateGcsPath()
Path to dynamic template spec file on Cloud Storage.



String
getDynamicTemplateStagingLocation()
Cloud Storage path for staging dependencies.



String
getGcsPath()
A Cloud Storage path to the template from which to create the job.



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



String
getProjectId()
Required.



Boolean
getValidateOnly()
If true, the request is validated but not actually executed.



Dataflow.Projects.Locations.Templates.Launch
set(String parameterName,
   Object value) 


Dataflow.Projects.Locations.Templates.Launch
set$Xgafv(String $Xgafv)
V1 error format.



Dataflow.Projects.Locations.Templates.Launch
setAccessToken(String accessToken)
OAuth access token.



Dataflow.Projects.Locations.Templates.Launch
setAlt(String alt)
Data format for response.



Dataflow.Projects.Locations.Templates.Launch
setCallback(String callback)
JSONP



Dataflow.Projects.Locations.Templates.Launch
setDynamicTemplateGcsPath(String dynamicTemplateGcsPath)
Path to dynamic template spec file on Cloud Storage.



Dataflow.Projects.Locations.Templates.Launch
setDynamicTemplateStagingLocation(String dynamicTemplateStagingLocation)
Cloud Storage path for staging dependencies.



Dataflow.Projects.Locations.Templates.Launch
setFields(String fields)
Selector specifying which fields to include in a partial response.



Dataflow.Projects.Locations.Templates.Launch
setGcsPath(String gcsPath)
A Cloud Storage path to the template from which to create the job.



Dataflow.Projects.Locations.Templates.Launch
setKey(String key)
API key.



Dataflow.Projects.Locations.Templates.Launch
setLocation(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(String oauthToken)
OAuth 2.0 token for the current user.



Dataflow.Projects.Locations.Templates.Launch
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



Dataflow.Projects.Locations.Templates.Launch
setProjectId(String projectId)
Required.



Dataflow.Projects.Locations.Templates.Launch
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



Dataflow.Projects.Locations.Templates.Launch
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



Dataflow.Projects.Locations.Templates.Launch
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.



Dataflow.Projects.Locations.Templates.Launch
setValidateOnly(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, 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





Launch
protected Launch(String projectId,
                 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(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(String accessToken)
Description copied from class: DataflowRequest
OAuth access token.

Overrides:
setAccessToken in class DataflowRequest<LaunchTemplateResponse>








setAlt
public Dataflow.Projects.Locations.Templates.Launch setAlt(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(String callback)
Description copied from class: DataflowRequest
JSONP

Overrides:
setCallback in class DataflowRequest<LaunchTemplateResponse>








setFields
public Dataflow.Projects.Locations.Templates.Launch setFields(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(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(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(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(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(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(String uploadProtocol)
Description copied from class: DataflowRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class DataflowRequest<LaunchTemplateResponse>








getProjectId
public String getProjectId()
Required. The ID of the Cloud Platform project that the job belongs to.







setProjectId
public Dataflow.Projects.Locations.Templates.Launch 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.Templates.Launch setLocation(String location)
The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
 endpoints) to which to direct the request.







getDynamicTemplateGcsPath
public String getDynamicTemplateGcsPath()
Path to dynamic template spec file on Cloud Storage. The file must be a Json serialized
         DynamicTemplateFieSpec object.







setDynamicTemplateGcsPath
public Dataflow.Projects.Locations.Templates.Launch setDynamicTemplateGcsPath(String dynamicTemplateGcsPath)
Path to dynamic template spec file on Cloud Storage. The file must be a Json serialized
 DynamicTemplateFieSpec object.







getDynamicTemplateStagingLocation
public 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(String dynamicTemplateStagingLocation)
Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL,
 beginning with `gs://`.







getGcsPath
public 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(String gcsPath)
A Cloud Storage path to the template from which to create the job. Must be valid Cloud
 Storage URL, beginning with 'gs://'.







getValidateOnly
public Boolean getValidateOnly()
If true, the request is validated but not actually executed. Defaults to false.







setValidateOnly
public Dataflow.Projects.Locations.Templates.Launch setValidateOnly(Boolean validateOnly)
If true, the request is validated but not actually executed. Defaults to false.







set
public Dataflow.Projects.Locations.Templates.Launch set(String parameterName,
                                                        Object value)

Overrides:
set in class DataflowRequest<LaunchTemplateResponse>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.