Telco Automation v1 API - Class HydratedDeploymentName (1.2.0)

public sealed class HydratedDeploymentName : IResourceName, IEquatable<HydratedDeploymentName>

Reference documentation and code samples for the Telco Automation v1 API class HydratedDeploymentName.

Resource name for the HydratedDeployment resource.

Inheritance

object > HydratedDeploymentName

Implements

IResourceName, IEquatable HydratedDeploymentName

Inherited Members

object.GetType()

Namespace

Google.Cloud.TelcoAutomation.V1

Assembly

Google.Cloud.TelcoAutomation.V1.dll

Constructors

HydratedDeploymentName(string, string, string, string, string)

public HydratedDeploymentName(string projectId, string locationId, string orchestrationClusterId, string deploymentId, string hydratedDeploymentId)

Constructs a new instance of a HydratedDeploymentName class from the component parts of pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment}

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.
`orchestrationClusterId`	`string` The `OrchestrationCluster` ID. Must not be `null` or empty.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.
`hydratedDeploymentId`	`string` The `HydratedDeployment` ID. Must not be `null` or empty.

Properties

DeploymentId

public string DeploymentId { get; }

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

Property Value
Type	Description
`string`

HydratedDeploymentId

public string HydratedDeploymentId { get; }

The HydratedDeployment 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`

OrchestrationClusterId

public string OrchestrationClusterId { get; }

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

The HydratedDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`HydratedDeploymentNameResourceNameType`

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 orchestrationClusterId, string deploymentId, string hydratedDeploymentId)

Formats the IDs into the string representation of this HydratedDeploymentName with pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment} .

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.
`orchestrationClusterId`	`string` The `OrchestrationCluster` ID. Must not be `null` or empty.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.
`hydratedDeploymentId`	`string` The `HydratedDeployment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this HydratedDeploymentName with pattern `projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment}` .

FormatProjectLocationOrchestrationClusterDeploymentHydratedDeployment(string, string, string, string, string)

public static string FormatProjectLocationOrchestrationClusterDeploymentHydratedDeployment(string projectId, string locationId, string orchestrationClusterId, string deploymentId, string hydratedDeploymentId)

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.
`orchestrationClusterId`	`string` The `OrchestrationCluster` ID. Must not be `null` or empty.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.
`hydratedDeploymentId`	`string` The `HydratedDeployment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this HydratedDeploymentName with pattern `projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment}` .

FromProjectLocationOrchestrationClusterDeploymentHydratedDeployment(string, string, string, string, string)

public static HydratedDeploymentName FromProjectLocationOrchestrationClusterDeploymentHydratedDeployment(string projectId, string locationId, string orchestrationClusterId, string deploymentId, string hydratedDeploymentId)

Creates a HydratedDeploymentName with the pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment} .

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.
`orchestrationClusterId`	`string` The `OrchestrationCluster` ID. Must not be `null` or empty.
`deploymentId`	`string` The `Deployment` ID. Must not be `null` or empty.
`hydratedDeploymentId`	`string` The `HydratedDeployment` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static HydratedDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HydratedDeploymentName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment}

Parse(string, bool)

public static HydratedDeploymentName Parse(string hydratedDeploymentName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment}

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

public static bool TryParse(string hydratedDeploymentName, out HydratedDeploymentName result)

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

Parameters
Name	Description
`hydratedDeploymentName`	`string` The resource name in string form. Must not be `null`.
`result`	`HydratedDeploymentName` When this method returns, the parsed HydratedDeploymentName, 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}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment}

TryParse(string, bool, out HydratedDeploymentName)

public static bool TryParse(string hydratedDeploymentName, bool allowUnparsed, out HydratedDeploymentName result)

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

Parameters
Name	Description
`hydratedDeploymentName`	`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`	`HydratedDeploymentName` When this method returns, the parsed HydratedDeploymentName, 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}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(HydratedDeploymentName, HydratedDeploymentName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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