Class WorkflowTemplateName

public sealed class WorkflowTemplateName : IResourceName, IEquatable<WorkflowTemplateName>

Resource name for the WorkflowTemplate resource.

Inheritance

Object > WorkflowTemplateName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

workflowTemplateIdString

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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

RegionId

public string RegionId { get; }

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

Property Value
TypeDescription
String

Type

public WorkflowTemplateName.ResourceNameType Type { get; }

The WorkflowTemplateName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
WorkflowTemplateName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

WorkflowTemplateId

public string WorkflowTemplateId { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

workflowTemplateIdString

The WorkflowTemplate ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

workflowTemplateIdString

The WorkflowTemplate ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

workflowTemplateIdString

The WorkflowTemplate ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

workflowTemplateIdString

The WorkflowTemplate ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

workflowTemplateIdString

The WorkflowTemplate ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
WorkflowTemplateName

A new instance of WorkflowTemplateName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static WorkflowTemplateName Parse(string workflowTemplateName)

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

Parameter
NameDescription
workflowTemplateNameString

The resource name in string form. Must not be null.

Returns
TypeDescription
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, Boolean)

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
NameDescription
workflowTemplateNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
workflowTemplateNameString

The resource name in string form. Must not be null.

resultWorkflowTemplateName

When this method returns, the parsed WorkflowTemplateName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
workflowTemplateNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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.

resultWorkflowTemplateName

When this method returns, the parsed WorkflowTemplateName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(WorkflowTemplateName, WorkflowTemplateName)

public static bool operator ==(WorkflowTemplateName a, WorkflowTemplateName b)
Parameters
NameDescription
aWorkflowTemplateName
bWorkflowTemplateName
Returns
TypeDescription
Boolean

Inequality(WorkflowTemplateName, WorkflowTemplateName)

public static bool operator !=(WorkflowTemplateName a, WorkflowTemplateName b)
Parameters
NameDescription
aWorkflowTemplateName
bWorkflowTemplateName
Returns
TypeDescription
Boolean