Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.WorkflowTemplatesResource.InstantiateInlineRequest

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.com/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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Operation>
DataprocBaseServiceRequest<Operation>
ProjectsResource.LocationsResource.WorkflowTemplatesResource.InstantiateInlineRequest
Implements
IClientServiceRequest<Operation>
IClientServiceRequest
Inherited Members
DataprocBaseServiceRequest<Operation>.Xgafv
DataprocBaseServiceRequest<Operation>.AccessToken
DataprocBaseServiceRequest<Operation>.Alt
DataprocBaseServiceRequest<Operation>.Callback
DataprocBaseServiceRequest<Operation>.Fields
DataprocBaseServiceRequest<Operation>.Key
DataprocBaseServiceRequest<Operation>.OauthToken
DataprocBaseServiceRequest<Operation>.PrettyPrint
DataprocBaseServiceRequest<Operation>.QuotaUser
DataprocBaseServiceRequest<Operation>.UploadType
DataprocBaseServiceRequest<Operation>.UploadProtocol
ClientServiceRequest<Operation>.Execute()
ClientServiceRequest<Operation>.ExecuteAsStream()
ClientServiceRequest<Operation>.ExecuteAsync()
ClientServiceRequest<Operation>.ExecuteAsync(CancellationToken)
ClientServiceRequest<Operation>.ExecuteAsStreamAsync()
ClientServiceRequest<Operation>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<Operation>.CreateRequest(bool?)
ClientServiceRequest<Operation>.GenerateRequestUri()
ClientServiceRequest<Operation>.GetDefaultETagAction(string)
ClientServiceRequest<Operation>.ETagAction
ClientServiceRequest<Operation>.ModifyRequest
ClientServiceRequest<Operation>.ValidateParameters
ClientServiceRequest<Operation>.ApiVersion
ClientServiceRequest<Operation>.RequestParameters
ClientServiceRequest<Operation>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dataproc.v1
Assembly: Google.Apis.Dataproc.v1.dll
Syntax
public class ProjectsResource.LocationsResource.WorkflowTemplatesResource.InstantiateInlineRequest : DataprocBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

InstantiateInlineRequest(IClientService, WorkflowTemplate, string)

Constructs a new InstantiateInline request.

Declaration
public InstantiateInlineRequest(IClientService service, WorkflowTemplate body, string parent)
Parameters
Type Name Description
IClientService service
WorkflowTemplate body
string parent

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.MethodName

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}

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
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.

Declaration
[RequestParameter("requestId", RequestParameterType.Query)]
public virtual string RequestId { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Operation>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides
ClientServiceRequest<Operation>.GetBody()

InitParameters()

Initializes InstantiateInline parameter list.

Declaration
protected override void InitParameters()
Overrides
DataprocBaseServiceRequest<Operation>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX