com.google.api.services.dataproc.v1beta2

Class Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline

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.v1beta2.DataprocRequest<Operation>

com.google.api.services.dataproc.v1beta2.Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Dataproc.Projects.Locations.WorkflowTemplates

public class Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline
extends DataprocRequest<Operation>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

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	InstantiateInline(String parent, WorkflowTemplate content) Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get.

Method Summary

Modifier and Type	Method and Description
String	getInstanceId() Deprecated.
String	getParent() Required.
String	getRequestId() Optional.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	set(String parameterName, Object value)
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	set$Xgafv(String $Xgafv) V1 error format.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setAccessToken(String accessToken) OAuth access token.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setAlt(String alt) Data format for response.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setCallback(String callback) JSONP
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setFields(String fields) Selector specifying which fields to include in a partial response.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setInstanceId(String instanceId) Deprecated.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setKey(String key) API key.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setParent(String parent) Required.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setRequestId(String requestId) Optional.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.dataproc.v1beta2.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

InstantiateInline

protected InstantiateInline(String parent,
                            WorkflowTemplate content)

Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.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.co m/dataproc/docs/reference/rpc/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.instantiateInline". 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.

InstantiateInline#initialize(com.google.api.client.googleapis.services.Ab stractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

parent - Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}

content - the WorkflowTemplate

Since:

1.13

Method Detail

set$Xgafv

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline 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.InstantiateInline setAccessToken(String accessToken)

Description copied from class: DataprocRequest

OAuth access token.

Overrides:

setAccessToken in class DataprocRequest<Operation>

setAlt

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline setAlt(String alt)

Description copied from class: DataprocRequest

Data format for response.

Overrides:

setAlt in class DataprocRequest<Operation>

setCallback

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline setCallback(String callback)

Description copied from class: DataprocRequest

JSONP

Overrides:

setCallback in class DataprocRequest<Operation>

setFields

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline 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.InstantiateInline 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.InstantiateInline 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.InstantiateInline 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.InstantiateInline 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.InstantiateInline 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.InstantiateInline setUploadProtocol(String uploadProtocol)

Description copied from class: DataprocRequest

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

Overrides:

setUploadProtocol in class DataprocRequest<Operation>

getParent

public String getParent()

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}

setParent

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline setParent(String parent)

Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}

getInstanceId

public String getInstanceId()

Deprecated. Please use request_id field instead.

setInstanceId

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline setInstanceId(String instanceId)

Deprecated. Please use request_id field instead.

getRequestId

public String getRequestId()

Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

setRequestId

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline setRequestId(String requestId)

Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

set

public Dataproc.Projects.Locations.WorkflowTemplates.InstantiateInline set(String parameterName,
                                                                           Object value)

Overrides:

set in class DataprocRequest<Operation>