Dataform v1 API - Class WorkflowInvocationName (1.0.0-beta02) 

public sealed class WorkflowInvocationName : IResourceName, IEquatable<WorkflowInvocationName>

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

Resource name for the WorkflowInvocation resource.

Inheritance

object > WorkflowInvocationName

Namespace

Google.Cloud.Dataform.V1

Assembly

Google.Cloud.Dataform.V1.dll

Constructors

WorkflowInvocationName(string, string, string, string)

public WorkflowInvocationName(string projectId, string locationId, string repositoryId, string workflowInvocationId)

Constructs a new instance of a WorkflowInvocationName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation}

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

The WorkflowInvocation 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 WorkflowInvocationName.ResourceNameType Type { get; }

The WorkflowInvocationName.ResourceNameType of the contained resource name.

Property Value
Type Description
WorkflowInvocationNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

WorkflowInvocationId

public string WorkflowInvocationId { get; }

The WorkflowInvocation 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 workflowInvocationId)

Formats the IDs into the string representation of this WorkflowInvocationName with pattern projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation} .

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

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

The string representation of this WorkflowInvocationName with pattern projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation} .

FormatProjectLocationRepositoryWorkflowInvocation(string, string, string, string)

public static string FormatProjectLocationRepositoryWorkflowInvocation(string projectId, string locationId, string repositoryId, string workflowInvocationId)

Formats the IDs into the string representation of this WorkflowInvocationName with pattern projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation} .

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

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

The string representation of this WorkflowInvocationName with pattern projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation} .

FromProjectLocationRepositoryWorkflowInvocation(string, string, string, string)

public static WorkflowInvocationName FromProjectLocationRepositoryWorkflowInvocation(string projectId, string locationId, string repositoryId, string workflowInvocationId)

Creates a WorkflowInvocationName with the pattern projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation} .

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

The WorkflowInvocation ID. Must not be null or empty.
Returns
Type Description
WorkflowInvocationName

A new instance of WorkflowInvocationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static WorkflowInvocationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a WorkflowInvocationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of WorkflowInvocationName 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 WorkflowInvocationName Parse(string workflowInvocationName)

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

Parameter
Name Description
workflowInvocationName string

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

The parsed WorkflowInvocationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation}

Parse(string, bool)

public static WorkflowInvocationName Parse(string workflowInvocationName, bool allowUnparsed)

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

Parameters
Name Description
workflowInvocationName 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
WorkflowInvocationName

The parsed WorkflowInvocationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/workflowInvocations/{workflow_invocation}
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 WorkflowInvocationName)

public static bool TryParse(string workflowInvocationName, out WorkflowInvocationName result)

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

Parameters
Name Description
workflowInvocationName string

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

When this method returns, the parsed WorkflowInvocationName, 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}/workflowInvocations/{workflow_invocation}

TryParse(string, bool, out WorkflowInvocationName)

public static bool TryParse(string workflowInvocationName, bool allowUnparsed, out WorkflowInvocationName result)

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

Parameters
Name Description
workflowInvocationName 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 WorkflowInvocationName

When this method returns, the parsed WorkflowInvocationName, 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}/workflowInvocations/{workflow_invocation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(WorkflowInvocationName, WorkflowInvocationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a WorkflowInvocationName

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

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 !=(WorkflowInvocationName, WorkflowInvocationName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a WorkflowInvocationName

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

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.