Google Cloud Deploy v1 API - Class RolloutName (3.4.0)

public sealed class RolloutName : IResourceName, IEquatable<RolloutName>

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

Resource name for the Rollout resource.

Inheritance

object > RolloutName

Implements

IResourceName, IEquatable RolloutName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Deploy.V1

Assembly

Google.Cloud.Deploy.V1.dll

Constructors

RolloutName(string, string, string, string, string)

public RolloutName(string projectId, string locationId, string deliveryPipelineId, string releaseId, string rolloutId)

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

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.
`rolloutId`	`string` The `Rollout` 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`

RolloutId

public string RolloutId { get; }

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

Property Value
Type	Description
`string`

Type

public RolloutName.ResourceNameType Type { get; }

The RolloutName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`RolloutNameResourceNameType`

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

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

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

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

Returns
Type	Description
`string`	The string representation of this RolloutName with pattern `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}` .

FormatProjectLocationDeliveryPipelineReleaseRollout(string, string, string, string, string)

public static string FormatProjectLocationDeliveryPipelineReleaseRollout(string projectId, string locationId, string deliveryPipelineId, string releaseId, string rolloutId)

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

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

Returns
Type	Description
`string`	The string representation of this RolloutName with pattern `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/releases/{release}/rollouts/{rollout}` .

FromProjectLocationDeliveryPipelineReleaseRollout(string, string, string, string, string)

public static RolloutName FromProjectLocationDeliveryPipelineReleaseRollout(string projectId, string locationId, string deliveryPipelineId, string releaseId, string rolloutId)

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

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

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

FromUnparsed(UnparsedResourceName)

public static RolloutName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RolloutName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
`RolloutName`	The parsed RolloutName 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}/rollouts/{rollout}

Parse(string, bool)

public static RolloutName Parse(string rolloutName, bool allowUnparsed)

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

Parameters
Name	Description
`rolloutName`	`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
`RolloutName`	The parsed RolloutName 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}/rollouts/{rollout}

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

public static bool TryParse(string rolloutName, out RolloutName result)

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

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

TryParse(string, bool, out RolloutName)

public static bool TryParse(string rolloutName, bool allowUnparsed, out RolloutName result)

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

Parameters
Name	Description
`rolloutName`	`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`	`RolloutName` When this method returns, the parsed RolloutName, 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}/rollouts/{rollout}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RolloutName, RolloutName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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