Show / Hide Table of Contents

Class ProjectsResource.RegionsResource.WorkflowTemplatesResource.InstantiateRequest

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/rpc/google.cloud.dataproc.v1beta2#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
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<Operation>
DataprocBaseServiceRequest<Operation>
ProjectsResource.RegionsResource.WorkflowTemplatesResource.InstantiateRequest
Implements
Google.Apis.Requests.IClientServiceRequest<Operation>
Google.Apis.Requests.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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Dataproc.v1beta2
Assembly: Google.Apis.Dataproc.v1beta2.dll
Syntax
public class InstantiateRequest : DataprocBaseServiceRequest<Operation>, IClientServiceRequest<Operation>, IClientServiceRequest

Constructors

InstantiateRequest(IClientService, InstantiateWorkflowTemplateRequest, String)

Constructs a new Instantiate request.

Declaration
public InstantiateRequest(IClientService service, InstantiateWorkflowTemplateRequest body, string name)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
InstantiateWorkflowTemplateRequest body
System.String name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.MethodName

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}

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
System.Object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.GetBody()

InitParameters()

Initializes Instantiate parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Dataproc.v1beta2.DataprocBaseServiceRequest<Google.Apis.Dataproc.v1beta2.Data.Operation>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest
In This Article
Back to top