target.apidocs.com.google.api.services.dataproc.Dataproc.Projects.Locations.WorkflowTemplates.Instantiate.html Maven / Gradle / Ivy
The newest version!
Dataproc.Projects.Locations.WorkflowTemplates.Instantiate (Cloud Dataproc API v1-rev20241025-2.0.0)
com.google.api.services.dataproc
Class Dataproc.Projects.Locations.WorkflowTemplates.Instantiate
- 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.dataproc.DataprocRequest<Operation>
-
- com.google.api.services.dataproc.Dataproc.Projects.Locations.WorkflowTemplates.Instantiate
-
- Enclosing class:
- Dataproc.Projects.Locations.WorkflowTemplates
public class Dataproc.Projects.Locations.WorkflowTemplates.Instantiate
extends DataprocRequest<Operation>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Instantiate(String name,
InstantiateWorkflowTemplateRequest content)
Instantiates a template and begins execution.The returned Operation can be used to track
execution of workflow by polling operations.get.
-
Method Summary
-
Methods inherited from class com.google.api.services.dataproc.DataprocRequest
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
-
Instantiate
protected Instantiate(String name,
InstantiateWorkflowTemplateRequest content)
Instantiates a template and begins execution.The returned Operation can be used to track
execution of workflow by polling operations.get. The Operation will complete when entire
workflow is finished.The running workflow can be aborted via operations.cancel. This will cause
any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The
Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/r
pc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata
(https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On
successful completion, Operation.response will be Empty.
Create a request for the method "workflowTemplates.instantiate".
This request holds the parameters needed by the the dataproc server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
operation. Dataproc.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be called to initialize this instance immediately after invoking the constructor.
- Parameters:
name - Required. The resource name of the workflow template, as described in
https://cloud.google.com/apis/design/resource_names. For
projects.regions.workflowTemplates.instantiate, the resource name of the template has the
following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
For projects.locations.workflowTemplates.instantiate, the resource name of the template
has the following format:
projects/{project_id}/locations/{location}/workflowTemplates/{template_id}content - the InstantiateWorkflowTemplateRequest- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate set$Xgafv(String $Xgafv)
Description copied from class: DataprocRequest
V1 error format.
- Overrides:
set$Xgafv in class DataprocRequest<Operation>
-
setAccessToken
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setAccessToken(String accessToken)
Description copied from class: DataprocRequest
OAuth access token.
- Overrides:
setAccessToken in class DataprocRequest<Operation>
-
setAlt
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setAlt(String alt)
Description copied from class: DataprocRequest
Data format for response.
- Overrides:
setAlt in class DataprocRequest<Operation>
-
setCallback
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setCallback(String callback)
Description copied from class: DataprocRequest
JSONP
- Overrides:
setCallback in class DataprocRequest<Operation>
-
setFields
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setFields(String fields)
Description copied from class: DataprocRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class DataprocRequest<Operation>
-
setKey
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setKey(String key)
Description copied from class: DataprocRequest
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 DataprocRequest<Operation>
-
setOauthToken
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setOauthToken(String oauthToken)
Description copied from class: DataprocRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class DataprocRequest<Operation>
-
setPrettyPrint
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setPrettyPrint(Boolean prettyPrint)
Description copied from class: DataprocRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class DataprocRequest<Operation>
-
setQuotaUser
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setQuotaUser(String quotaUser)
Description copied from class: DataprocRequest
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 DataprocRequest<Operation>
-
setUploadType
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setUploadType(String uploadType)
Description copied from class: DataprocRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class DataprocRequest<Operation>
-
setUploadProtocol
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setUploadProtocol(String uploadProtocol)
Description copied from class: DataprocRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class DataprocRequest<Operation>
-
getName
public String getName()
Required. The resource name of the workflow template, as described in
https://cloud.google.com/apis/design/resource_names. For
projects.regions.workflowTemplates.instantiate, the resource name of the template has the following
format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
projects.locations.workflowTemplates.instantiate, the resource name of the template has the
following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
-
setName
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate setName(String name)
Required. The resource name of the workflow template, as described in
https://cloud.google.com/apis/design/resource_names. For
projects.regions.workflowTemplates.instantiate, the resource name of the template has
the following format:
projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For
projects.locations.workflowTemplates.instantiate, the resource name of the template has
the following format:
projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
-
set
public Dataproc.Projects.Locations.WorkflowTemplates.Instantiate set(String parameterName,
Object value)
- Overrides:
set in class DataprocRequest<Operation>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy