Google Cloud Deploy v1 API - Class ReleaseName (3.7.0) 

public sealed class ReleaseName : IResourceName, IEquatable<ReleaseName>

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

Resource name for the Release resource.

Inheritance

object > ReleaseName

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

ReleaseName(string, string, string, string)

public ReleaseName(string projectId, string locationId, string deliveryPipelineId, string releaseId)

Constructs a new instance of a ReleaseName class from the component parts of pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}

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.
releaseId string

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

ReleaseId

public string ReleaseId { get; }

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

Property Value
Type Description
string

Type

public ReleaseName.ResourceNameType Type { get; }

The ReleaseName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReleaseNameResourceNameType

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

public static string Format(string projectId, string locationId, string deliveryPipelineId, string releaseId)

Formats the IDs into the string representation of this ReleaseName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}.

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.
releaseId string

The Release ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ReleaseName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}.

FormatProjectLocationDeliveryPipelineRelease(string, string, string, string)

public static string FormatProjectLocationDeliveryPipelineRelease(string projectId, string locationId, string deliveryPipelineId, string releaseId)

Formats the IDs into the string representation of this ReleaseName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}.

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.
releaseId string

The Release ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ReleaseName with pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}.

FromProjectLocationDeliveryPipelineRelease(string, string, string, string)

public static ReleaseName FromProjectLocationDeliveryPipelineRelease(string projectId, string locationId, string deliveryPipelineId, string releaseId)

Creates a ReleaseName with the pattern projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}.

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.
releaseId string

The Release ID. Must not be null or empty.
Returns
Type Description
ReleaseName

A new instance of ReleaseName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReleaseName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReleaseName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ReleaseName

A new instance of ReleaseName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ReleaseName Parse(string releaseName)

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

Parameter
Name Description
releaseName string

The resource name in string form. Must not be null.
Returns
Type Description
ReleaseName

The parsed ReleaseName if successful.
Remarks

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

  • projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}

Parse(string, bool)

public static ReleaseName Parse(string releaseName, bool allowUnparsed)

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

Parameters
Name Description
releaseName 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
ReleaseName

The parsed ReleaseName if successful.
Remarks

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

  • projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}
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

TryParse(string, out ReleaseName)

public static bool TryParse(string releaseName, out ReleaseName result)

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

Parameters
Name Description
releaseName string

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

When this method returns, the parsed ReleaseName, 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}/releases/{release}

TryParse(string, bool, out ReleaseName)

public static bool TryParse(string releaseName, bool allowUnparsed, out ReleaseName result)

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

Parameters
Name Description
releaseName 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 ReleaseName

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

Operators

operator ==(ReleaseName, ReleaseName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReleaseName

The first resource name to compare, or null.
b ReleaseName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReleaseName

The first resource name to compare, or null.
b ReleaseName

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.