Dataform v1 API - Class WorkflowConfigName (1.0.0-beta02) 

public sealed class WorkflowConfigName : IResourceName, IEquatable<WorkflowConfigName>

Reference documentation and code samples for the Dataform v1 API class WorkflowConfigName.

Resource name for the WorkflowConfig resource.

Inheritance

object > WorkflowConfigName

Namespace

Google.Cloud.Dataform.V1

Assembly

Google.Cloud.Dataform.V1.dll

Constructors

WorkflowConfigName(string, string, string, string)

public WorkflowConfigName(string projectId, string locationId, string repositoryId, string workflowConfigId)

Constructs a new instance of a WorkflowConfigName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}

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.
repositoryId string

The Repository ID. Must not be null or empty.
workflowConfigId string

The WorkflowConfig 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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

RepositoryId

public string RepositoryId { get; }

The Repository ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public WorkflowConfigName.ResourceNameType Type { get; }

The WorkflowConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
WorkflowConfigNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

WorkflowConfigId

public string WorkflowConfigId { get; }

The WorkflowConfig ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string repositoryId, string workflowConfigId)

Formats the IDs into the string representation of this WorkflowConfigName with pattern projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}.

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.
repositoryId string

The Repository ID. Must not be null or empty.
workflowConfigId string

The WorkflowConfig ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this WorkflowConfigName with pattern projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}.

FormatProjectLocationRepositoryWorkflowConfig(string, string, string, string)

public static string FormatProjectLocationRepositoryWorkflowConfig(string projectId, string locationId, string repositoryId, string workflowConfigId)

Formats the IDs into the string representation of this WorkflowConfigName with pattern projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}.

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.
repositoryId string

The Repository ID. Must not be null or empty.
workflowConfigId string

The WorkflowConfig ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this WorkflowConfigName with pattern projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}.

FromProjectLocationRepositoryWorkflowConfig(string, string, string, string)

public static WorkflowConfigName FromProjectLocationRepositoryWorkflowConfig(string projectId, string locationId, string repositoryId, string workflowConfigId)

Creates a WorkflowConfigName with the pattern projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}.

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.
repositoryId string

The Repository ID. Must not be null or empty.
workflowConfigId string

The WorkflowConfig ID. Must not be null or empty.
Returns
Type Description
WorkflowConfigName

A new instance of WorkflowConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkflowConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkflowConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
WorkflowConfigName

A new instance of WorkflowConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static WorkflowConfigName Parse(string workflowConfigName)

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

Parameter
Name Description
workflowConfigName string

The resource name in string form. Must not be null.
Returns
Type Description
WorkflowConfigName

The parsed WorkflowConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}

Parse(string, bool)

public static WorkflowConfigName Parse(string workflowConfigName, bool allowUnparsed)

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

Parameters
Name Description
workflowConfigName 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
WorkflowConfigName

The parsed WorkflowConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}
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

TryParse(string, out WorkflowConfigName)

public static bool TryParse(string workflowConfigName, out WorkflowConfigName result)

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

Parameters
Name Description
workflowConfigName string

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

When this method returns, the parsed WorkflowConfigName, 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}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}

TryParse(string, bool, out WorkflowConfigName)

public static bool TryParse(string workflowConfigName, bool allowUnparsed, out WorkflowConfigName result)

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

Parameters
Name Description
workflowConfigName 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 WorkflowConfigName

When this method returns, the parsed WorkflowConfigName, 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}/locations/{location}/repositories/{repository}/workflowConfigs/{workflow_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(WorkflowConfigName, WorkflowConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WorkflowConfigName

The first resource name to compare, or null.
b WorkflowConfigName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(WorkflowConfigName, WorkflowConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a WorkflowConfigName

The first resource name to compare, or null.
b WorkflowConfigName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.