Class DeliveryPipelineName

public sealed class DeliveryPipelineName : IResourceName, IEquatable<DeliveryPipelineName>

Resource name for the DeliveryPipeline resource.

Inheritance

Object > DeliveryPipelineName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

deliveryPipelineIdString

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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Type

public DeliveryPipelineName.ResourceNameType Type { get; }

The DeliveryPipelineName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DeliveryPipelineName.ResourceNameType

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)

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

deliveryPipelineIdString

The DeliveryPipeline ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

deliveryPipelineIdString

The DeliveryPipeline ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

deliveryPipelineIdString

The DeliveryPipeline ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DeliveryPipelineName

A new instance of DeliveryPipelineName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static DeliveryPipelineName Parse(string deliveryPipelineName)

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

Parameter
NameDescription
deliveryPipelineNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
deliveryPipelineNameString

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

allowUnparsedBoolean

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
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
deliveryPipelineNameString

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

resultDeliveryPipelineName

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

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
deliveryPipelineNameString

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

allowUnparsedBoolean

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.

resultDeliveryPipelineName

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

Returns
TypeDescription
Boolean

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

Equality(DeliveryPipelineName, DeliveryPipelineName)

public static bool operator ==(DeliveryPipelineName a, DeliveryPipelineName b)
Parameters
NameDescription
aDeliveryPipelineName
bDeliveryPipelineName
Returns
TypeDescription
Boolean

Inequality(DeliveryPipelineName, DeliveryPipelineName)

public static bool operator !=(DeliveryPipelineName a, DeliveryPipelineName b)
Parameters
NameDescription
aDeliveryPipelineName
bDeliveryPipelineName
Returns
TypeDescription
Boolean