Google Cloud Dataproc v1 API - Class WorkflowTemplateName (5.7.0)

public sealed class WorkflowTemplateName : IResourceName, IEquatable<WorkflowTemplateName>

Reference documentation and code samples for the Google Cloud Dataproc v1 API class WorkflowTemplateName.

Resource name for the WorkflowTemplate resource.

Inheritance

object > WorkflowTemplateName

Implements

IResourceName, IEquatable WorkflowTemplateName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

WorkflowTemplateName(string, string, string)

public WorkflowTemplateName(string projectId, string regionId, string workflowTemplateId)

Constructs a new instance of a WorkflowTemplateName class from the component parts of pattern projects/{project}/regions/{region}/workflowTemplates/{workflow_template}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`workflowTemplateId`	`string` The `WorkflowTemplate` ID. Must not be `null` or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`bool`

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

RegionId

public string RegionId { get; }

The Region ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public WorkflowTemplateName.ResourceNameType Type { get; }

The WorkflowTemplateName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`WorkflowTemplateNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

WorkflowTemplateId

public string WorkflowTemplateId { get; }

The WorkflowTemplate ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Methods

Format(string, string, string)

public static string Format(string projectId, string regionId, string workflowTemplateId)

Formats the IDs into the string representation of this WorkflowTemplateName with pattern projects/{project}/regions/{region}/workflowTemplates/{workflow_template}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`workflowTemplateId`	`string` The `WorkflowTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this WorkflowTemplateName with pattern `projects/{project}/regions/{region}/workflowTemplates/{workflow_template}`.

FormatProjectLocationWorkflowTemplate(string, string, string)

public static string FormatProjectLocationWorkflowTemplate(string projectId, string locationId, string workflowTemplateId)

Formats the IDs into the string representation of this WorkflowTemplateName with pattern projects/{project}/locations/{location}/workflowTemplates/{workflow_template}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`workflowTemplateId`	`string` The `WorkflowTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this WorkflowTemplateName with pattern `projects/{project}/locations/{location}/workflowTemplates/{workflow_template}`.

FormatProjectRegionWorkflowTemplate(string, string, string)

public static string FormatProjectRegionWorkflowTemplate(string projectId, string regionId, string workflowTemplateId)

Formats the IDs into the string representation of this WorkflowTemplateName with pattern projects/{project}/regions/{region}/workflowTemplates/{workflow_template}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`workflowTemplateId`	`string` The `WorkflowTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this WorkflowTemplateName with pattern `projects/{project}/regions/{region}/workflowTemplates/{workflow_template}`.

FromProjectLocationWorkflowTemplate(string, string, string)

public static WorkflowTemplateName FromProjectLocationWorkflowTemplate(string projectId, string locationId, string workflowTemplateId)

Creates a WorkflowTemplateName with the pattern projects/{project}/locations/{location}/workflowTemplates/{workflow_template}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`workflowTemplateId`	`string` The `WorkflowTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`WorkflowTemplateName`	A new instance of WorkflowTemplateName constructed from the provided ids.

FromProjectRegionWorkflowTemplate(string, string, string)

public static WorkflowTemplateName FromProjectRegionWorkflowTemplate(string projectId, string regionId, string workflowTemplateId)

Creates a WorkflowTemplateName with the pattern projects/{project}/regions/{region}/workflowTemplates/{workflow_template}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`workflowTemplateId`	`string` The `WorkflowTemplate` ID. Must not be `null` or empty.

Returns
Type	Description
`WorkflowTemplateName`	A new instance of WorkflowTemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkflowTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkflowTemplateName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`WorkflowTemplateName`	A new instance of WorkflowTemplateName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static WorkflowTemplateName Parse(string workflowTemplateName)

Parses the given resource name string into a new WorkflowTemplateName instance.

Parameter
Name	Description
`workflowTemplateName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`WorkflowTemplateName`	The parsed WorkflowTemplateName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/regions/{region}/workflowTemplates/{workflow_template}
projects/{project}/locations/{location}/workflowTemplates/{workflow_template}

Parse(string, bool)

public static WorkflowTemplateName Parse(string workflowTemplateName, bool allowUnparsed)

Parses the given resource name string into a new WorkflowTemplateName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`workflowTemplateName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
`WorkflowTemplateName`	The parsed WorkflowTemplateName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/regions/{region}/workflowTemplates/{workflow_template}
projects/{project}/locations/{location}/workflowTemplates/{workflow_template}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

TryParse(string, out WorkflowTemplateName)

public static bool TryParse(string workflowTemplateName, out WorkflowTemplateName result)

Tries to parse the given resource name string into a new WorkflowTemplateName instance.

Parameters
Name	Description
`workflowTemplateName`	`string` The resource name in string form. Must not be `null`.
`result`	`WorkflowTemplateName` When this method returns, the parsed WorkflowTemplateName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/regions/{region}/workflowTemplates/{workflow_template}
projects/{project}/locations/{location}/workflowTemplates/{workflow_template}

TryParse(string, bool, out WorkflowTemplateName)

public static bool TryParse(string workflowTemplateName, bool allowUnparsed, out WorkflowTemplateName result)

Tries to parse the given resource name string into a new WorkflowTemplateName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`workflowTemplateName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
`result`	`WorkflowTemplateName` When this method returns, the parsed WorkflowTemplateName, or `null` if parsing failed.

Returns
Type	Description
`bool`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/regions/{region}/workflowTemplates/{workflow_template}
projects/{project}/locations/{location}/workflowTemplates/{workflow_template}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(WorkflowTemplateName, WorkflowTemplateName)

public static bool operator ==(WorkflowTemplateName a, WorkflowTemplateName b)

Parameters
Name	Description
`a`	`WorkflowTemplateName`
`b`	`WorkflowTemplateName`

Returns
Type	Description
`bool`

operator !=(WorkflowTemplateName, WorkflowTemplateName)

public static bool operator !=(WorkflowTemplateName a, WorkflowTemplateName b)

Parameters
Name	Description
`a`	`WorkflowTemplateName`
`b`	`WorkflowTemplateName`

Returns
Type	Description
`bool`