Google Cloud Deploy v1 API - Class DeliveryPipelineName (2.11.0)

public sealed class DeliveryPipelineName : IResourceName, IEquatable<DeliveryPipelineName>

Reference documentation and code samples for the Google Cloud Deploy v1 API class DeliveryPipelineName.

Resource name for the DeliveryPipeline resource.

Inheritance

object > DeliveryPipelineName

Implements

IResourceName, IEquatable DeliveryPipelineName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

DeliveryPipelineName(string, string, string)

public DeliveryPipelineName(string projectId, string locationId, string deliveryPipelineId)

Constructs a new instance of a DeliveryPipelineName class from the component parts of pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_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.
`deliveryPipelineId`	`string` The `DeliveryPipeline` ID. Must not be `null` or empty.

Properties

DeliveryPipelineId

public string DeliveryPipelineId { get; }

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

Property Value
Type	Description
`string`

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`

Type

public DeliveryPipelineName.ResourceNameType Type { get; }

The DeliveryPipelineName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`DeliveryPipelineNameResourceNameType`

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

Formats the IDs into the string representation of this DeliveryPipelineName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_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.
`deliveryPipelineId`	`string` The `DeliveryPipeline` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DeliveryPipelineName with pattern `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.

FormatProjectLocationDeliveryPipeline(string, string, string)

public static string FormatProjectLocationDeliveryPipeline(string projectId, string locationId, string deliveryPipelineId)

Formats the IDs into the string representation of this DeliveryPipelineName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_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.
`deliveryPipelineId`	`string` The `DeliveryPipeline` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DeliveryPipelineName with pattern `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.

FromProjectLocationDeliveryPipeline(string, string, string)

public static DeliveryPipelineName FromProjectLocationDeliveryPipeline(string projectId, string locationId, string deliveryPipelineId)

Creates a DeliveryPipelineName with the pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_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.
`deliveryPipelineId`	`string` The `DeliveryPipeline` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static DeliveryPipelineName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DeliveryPipelineName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}

Parse(string, bool)

public static DeliveryPipelineName Parse(string deliveryPipelineName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/deliveryPipelines/{delivery_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 DeliveryPipelineName)

public static bool TryParse(string deliveryPipelineName, out DeliveryPipelineName result)

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

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

TryParse(string, bool, out DeliveryPipelineName)

public static bool TryParse(string deliveryPipelineName, bool allowUnparsed, out DeliveryPipelineName result)

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

Parameters
Name	Description
`deliveryPipelineName`	`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`	`DeliveryPipelineName` When this method returns, the parsed DeliveryPipelineName, 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}/deliveryPipelines/{delivery_pipeline}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DeliveryPipelineName, DeliveryPipelineName)

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

Parameters
Name	Description
`a`	`DeliveryPipelineName`
`b`	`DeliveryPipelineName`

Returns
Type	Description
`bool`

operator !=(DeliveryPipelineName, DeliveryPipelineName)

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

Parameters
Name	Description
`a`	`DeliveryPipelineName`
`b`	`DeliveryPipelineName`

Returns
Type	Description
`bool`