Class ProjectsResource.TemplatesResource.LaunchRequest

Launches a template. To launch a template, we recommend using projects.locations.templates.launch with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<LaunchTemplateResponse>
DataflowBaseServiceRequest<LaunchTemplateResponse>
ProjectsResource.TemplatesResource.LaunchRequest
Implements
Inherited Members
Namespace: Google.Apis.Dataflow.v1b3
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class ProjectsResource.TemplatesResource.LaunchRequest : DataflowBaseServiceRequest<LaunchTemplateResponse>, IClientServiceRequest<LaunchTemplateResponse>, IClientServiceRequest

Constructors

LaunchRequest(IClientService, LaunchTemplateParameters, string)

Constructs a new Launch request.

Declaration
public LaunchRequest(IClientService service, LaunchTemplateParameters body, string projectId)
Parameters
Type Name Description
IClientService service
LaunchTemplateParameters body
string projectId

Properties

DynamicTemplateGcsPath

Path to the dynamic template specification file on Cloud Storage. The file must be a JSON serialized DynamicTemplateFileSpec object.

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

DynamicTemplateStagingLocation

Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with gs://.

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

GcsPath

A Cloud Storage path to the template to use to create the job. Must be valid Cloud Storage URL, beginning with gs://.

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

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

Location

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

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

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

ProjectId

Required. The ID of the Cloud Platform project that the job belongs to.

Declaration
[RequestParameter("projectId", RequestParameterType.Path)]
public virtual string ProjectId { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

ValidateOnly

If true, the request is validated but not actually executed. Defaults to false.

Declaration
[RequestParameter("validateOnly", RequestParameterType.Query)]
public virtual bool? ValidateOnly { get; set; }
Property Value
Type Description
bool?

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes Launch parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements