Eventarc v1 API - Class PipelineName (2.6.0)

public sealed class PipelineName : IResourceName, IEquatable<PipelineName>

Reference documentation and code samples for the Eventarc v1 API class PipelineName.

Resource name for the Pipeline resource.

Inheritance

object > PipelineName

Implements

IResourceName, IEquatable PipelineName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Eventarc.V1

Assembly

Google.Cloud.Eventarc.V1.dll

Constructors

PipelineName(string, string, string)

public PipelineName(string projectId, string locationId, string pipelineId)

Constructs a new instance of a PipelineName class from the component parts of pattern projects/{project}/locations/{location}/pipelines/{pipeline}

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.
`pipelineId`	`string` The `Pipeline` 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`

PipelineId

public string PipelineId { get; }

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

The PipelineName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`PipelineNameResourceNameType`

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 pipelineId)

Formats the IDs into the string representation of this PipelineName with pattern projects/{project}/locations/{location}/pipelines/{pipeline}.

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.
`pipelineId`	`string` The `Pipeline` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this PipelineName with pattern `projects/{project}/locations/{location}/pipelines/{pipeline}`.

FormatProjectLocationPipeline(string, string, string)

public static string FormatProjectLocationPipeline(string projectId, string locationId, string pipelineId)

Formats the IDs into the string representation of this PipelineName with pattern projects/{project}/locations/{location}/pipelines/{pipeline}.

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.
`pipelineId`	`string` The `Pipeline` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this PipelineName with pattern `projects/{project}/locations/{location}/pipelines/{pipeline}`.

FromProjectLocationPipeline(string, string, string)

public static PipelineName FromProjectLocationPipeline(string projectId, string locationId, string pipelineId)

Creates a PipelineName with the pattern projects/{project}/locations/{location}/pipelines/{pipeline}.

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.
`pipelineId`	`string` The `Pipeline` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static PipelineName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PipelineName containing an unparsed resource name.

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

Returns
Type	Description
`PipelineName`	A new instance of PipelineName 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 PipelineName Parse(string pipelineName)

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

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

Returns
Type	Description
`PipelineName`	The parsed PipelineName if successful.

Remarks

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

projects/{project}/locations/{location}/pipelines/{pipeline}

Parse(string, bool)

public static PipelineName Parse(string pipelineName, bool allowUnparsed)

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

Parameters
Name	Description
`pipelineName`	`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
`PipelineName`	The parsed PipelineName if successful.

Remarks

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

projects/{project}/locations/{location}/pipelines/{pipeline}

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 PipelineName)

public static bool TryParse(string pipelineName, out PipelineName result)

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

Parameters
Name	Description
`pipelineName`	`string` The resource name in string form. Must not be `null`.
`result`	`PipelineName` When this method returns, the parsed PipelineName, 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}/pipelines/{pipeline}

TryParse(string, bool, out PipelineName)

public static bool TryParse(string pipelineName, bool allowUnparsed, out PipelineName result)

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

Parameters
Name	Description
`pipelineName`	`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`	`PipelineName` When this method returns, the parsed PipelineName, 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}/pipelines/{pipeline}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PipelineName, PipelineName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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