Data Lineage v1 API - Class LineageEventName (1.2.0)

public sealed class LineageEventName : IResourceName, IEquatable<LineageEventName>

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

Resource name for the LineageEvent resource.

Inheritance

object > LineageEventName

Namespace

Google.Cloud.DataCatalog.Lineage.V1

Assembly

Google.Cloud.DataCatalog.Lineage.V1.dll

Constructors

LineageEventName(string, string, string, string, string)

public LineageEventName(string projectId, string locationId, string processId, string runId, string lineageEventId)

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

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.

lineageEventIdstring

The LineageEvent 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

LineageEventId

public string LineageEventId { get; }

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

Property Value
TypeDescription
string

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 LineageEventName.ResourceNameType Type { get; }

The LineageEventName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
LineageEventNameResourceNameType

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, string)

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

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

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.

lineageEventIdstring

The LineageEvent ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationProcessRunLineageEvent(string, string, string, string, string)

public static string FormatProjectLocationProcessRunLineageEvent(string projectId, string locationId, string processId, string runId, string lineageEventId)

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

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.

lineageEventIdstring

The LineageEvent ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationProcessRunLineageEvent(string, string, string, string, string)

public static LineageEventName FromProjectLocationProcessRunLineageEvent(string projectId, string locationId, string processId, string runId, string lineageEventId)

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

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.

lineageEventIdstring

The LineageEvent ID. Must not be null or empty.

Returns
TypeDescription
LineageEventName

A new instance of LineageEventName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LineageEventName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LineageEventName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
LineageEventName

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

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

Parameter
NameDescription
lineageEventNamestring

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

Returns
TypeDescription
LineageEventName

The parsed LineageEventName 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}/lineageEvents/{lineage_event}

Parse(string, bool)

public static LineageEventName Parse(string lineageEventName, bool allowUnparsed)

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

Parameters
NameDescription
lineageEventNamestring

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
LineageEventName

The parsed LineageEventName 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}/lineageEvents/{lineage_event}
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 LineageEventName)

public static bool TryParse(string lineageEventName, out LineageEventName result)

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

Parameters
NameDescription
lineageEventNamestring

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

resultLineageEventName

When this method returns, the parsed LineageEventName, 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}/lineageEvents/{lineage_event}

TryParse(string, bool, out LineageEventName)

public static bool TryParse(string lineageEventName, bool allowUnparsed, out LineageEventName result)

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

Parameters
NameDescription
lineageEventNamestring

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.

resultLineageEventName

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

Operators

operator ==(LineageEventName, LineageEventName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aLineageEventName

The first resource name to compare, or null.

bLineageEventName

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

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aLineageEventName

The first resource name to compare, or null.

bLineageEventName

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.