Data Lineage v1 API - Class ProcessName (1.5.0)

Version latest

• 1.5.0 (latest)
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ProcessName : IResourceName, IEquatable<ProcessName>

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

Resource name for the Process resource.

Inheritance

object > ProcessName

Implements

IResourceName, IEquatableProcessName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DataCatalog.Lineage.V1

Assembly

Google.Cloud.DataCatalog.Lineage.V1.dll

Constructors

ProcessName(string, string, string)

public ProcessName(string projectId, string locationId, string processId)

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

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.
processId	string The Process 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

ProcessId

public string ProcessId { get; }

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

Type

public ProcessName.ResourceNameType Type { get; }

The ProcessName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ProcessNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
UnparsedResourceName

Methods

Format(string, string, string)

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

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

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.
processId	string The Process ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ProcessName with pattern projects/{project}/locations/{location}/processes/{process}.

FormatProjectLocationProcess(string, string, string)

public static string FormatProjectLocationProcess(string projectId, string locationId, string processId)

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

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.
processId	string The Process ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ProcessName with pattern projects/{project}/locations/{location}/processes/{process}.

FromProjectLocationProcess(string, string, string)

public static ProcessName FromProjectLocationProcess(string projectId, string locationId, string processId)

Creates a ProcessName with the pattern projects/{project}/locations/{location}/processes/{process}.

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.
processId	string The Process ID. Must not be null or empty.

Returns
Type	Description
ProcessName	A new instance of ProcessName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProcessName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProcessName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
ProcessName	A new instance of ProcessName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static ProcessName Parse(string processName)

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

Parameter
Name	Description
processName	string The resource name in string form. Must not be null.

Returns
Type	Description
ProcessName	The parsed ProcessName if successful.

Remarks

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

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

Parse(string, bool)

public static ProcessName Parse(string processName, bool allowUnparsed)

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

Parameters
Name	Description
processName	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
ProcessName	The parsed ProcessName if successful.

Remarks

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

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

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

object.ToString()

TryParse(string, out ProcessName)

public static bool TryParse(string processName, out ProcessName result)

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

Parameters
Name	Description
processName	string The resource name in string form. Must not be null.
result	ProcessName When this method returns, the parsed ProcessName, 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}/processes/{process}

TryParse(string, bool, out ProcessName)

public static bool TryParse(string processName, bool allowUnparsed, out ProcessName result)

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

Parameters
Name	Description
processName	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	ProcessName When this method returns, the parsed ProcessName, 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}/processes/{process}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProcessName, ProcessName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	ProcessName The first resource name to compare, or null.
b	ProcessName 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 !=(ProcessName, ProcessName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	ProcessName The first resource name to compare, or null.
b	ProcessName 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.