Data Lineage v1 API - Class RunName (1.2.0)

public sealed class RunName : IResourceName, IEquatable<RunName>

Reference documentation and code samples for the Data Lineage v1 API class RunName.

Resource name for the Run resource.

Inheritance

object > RunName

Namespace

Google.Cloud.DataCatalog.Lineage.V1

Assembly

Google.Cloud.DataCatalog.Lineage.V1.dll

Constructors

RunName(string, string, string, string)

public RunName(string projectId, string locationId, string processId, string runId)

Constructs a new instance of a RunName class from the component parts of pattern projects/{project}/locations/{location}/processes/{process}/runs/{run}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

processIdstring

The Process ID. Must not be null or empty.

runIdstring

The Run 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
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProcessId

public string ProcessId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

RunId

public string RunId { get; }

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

Property Value
TypeDescription
string

Type

public RunName.ResourceNameType Type { get; }

The RunName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RunNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string processId, string runId)

Formats the IDs into the string representation of this RunName with pattern projects/{project}/locations/{location}/processes/{process}/runs/{run}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

processIdstring

The Process ID. Must not be null or empty.

runIdstring

The Run ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this RunName with pattern projects/{project}/locations/{location}/processes/{process}/runs/{run}.

FormatProjectLocationProcessRun(string, string, string, string)

public static string FormatProjectLocationProcessRun(string projectId, string locationId, string processId, string runId)

Formats the IDs into the string representation of this RunName with pattern projects/{project}/locations/{location}/processes/{process}/runs/{run}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

processIdstring

The Process ID. Must not be null or empty.

runIdstring

The Run ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this RunName with pattern projects/{project}/locations/{location}/processes/{process}/runs/{run}.

FromProjectLocationProcessRun(string, string, string, string)

public static RunName FromProjectLocationProcessRun(string projectId, string locationId, string processId, string runId)

Creates a RunName with the pattern projects/{project}/locations/{location}/processes/{process}/runs/{run}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

processIdstring

The Process ID. Must not be null or empty.

runIdstring

The Run ID. Must not be null or empty.

Returns
TypeDescription
RunName

A new instance of RunName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RunName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RunName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RunName

A new instance of RunName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static RunName Parse(string runName)

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

Parameter
NameDescription
runNamestring

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

Returns
TypeDescription
RunName

The parsed RunName if successful.

Remarks

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

  • projects/{project}/locations/{location}/processes/{process}/runs/{run}

Parse(string, bool)

public static RunName Parse(string runName, bool allowUnparsed)

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

Parameters
NameDescription
runNamestring

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

allowUnparsedbool

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
RunName

The parsed RunName if successful.

Remarks

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

  • projects/{project}/locations/{location}/processes/{process}/runs/{run}
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 RunName)

public static bool TryParse(string runName, out RunName result)

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

Parameters
NameDescription
runNamestring

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

resultRunName

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

Returns
TypeDescription
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}/processes/{process}/runs/{run}

TryParse(string, bool, out RunName)

public static bool TryParse(string runName, bool allowUnparsed, out RunName result)

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

Parameters
NameDescription
runNamestring

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

allowUnparsedbool

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.

resultRunName

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

Returns
TypeDescription
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}/processes/{process}/runs/{run}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RunName, RunName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aRunName

The first resource name to compare, or null.

bRunName

The second resource name to compare, or null.

Returns
TypeDescription
bool

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

operator !=(RunName, RunName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aRunName

The first resource name to compare, or null.

bRunName

The second resource name to compare, or null.

Returns
TypeDescription
bool

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