Telco Automation v1 API - Class OrchestrationClusterName (1.2.0)

public sealed class OrchestrationClusterName : IResourceName, IEquatable<OrchestrationClusterName>

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

Resource name for the OrchestrationCluster resource.

Inheritance

object > OrchestrationClusterName

Implements

IResourceName, IEquatable OrchestrationClusterName

Inherited Members

object.GetType()

Namespace

Google.Cloud.TelcoAutomation.V1

Assembly

Google.Cloud.TelcoAutomation.V1.dll

Constructors

OrchestrationClusterName(string, string, string)

public OrchestrationClusterName(string projectId, string locationId, string orchestrationClusterId)

Constructs a new instance of a OrchestrationClusterName class from the component parts of pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}

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.

Properties

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 OrchestrationClusterName.ResourceNameType Type { get; }

The OrchestrationClusterName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`OrchestrationClusterNameResourceNameType`

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

Formats the IDs into the string representation of this OrchestrationClusterName with pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}.

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.

Returns
Type	Description
`string`	The string representation of this OrchestrationClusterName with pattern `projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}`.

FormatProjectLocationOrchestrationCluster(string, string, string)

public static string FormatProjectLocationOrchestrationCluster(string projectId, string locationId, string orchestrationClusterId)

Formats the IDs into the string representation of this OrchestrationClusterName with pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}.

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.

Returns
Type	Description
`string`	The string representation of this OrchestrationClusterName with pattern `projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}`.

FromProjectLocationOrchestrationCluster(string, string, string)

public static OrchestrationClusterName FromProjectLocationOrchestrationCluster(string projectId, string locationId, string orchestrationClusterId)

Creates a OrchestrationClusterName with the pattern projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}.

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.

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

FromUnparsed(UnparsedResourceName)

public static OrchestrationClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrchestrationClusterName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}

Parse(string, bool)

public static OrchestrationClusterName Parse(string orchestrationClusterName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}

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

public static bool TryParse(string orchestrationClusterName, out OrchestrationClusterName result)

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

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

TryParse(string, bool, out OrchestrationClusterName)

public static bool TryParse(string orchestrationClusterName, bool allowUnparsed, out OrchestrationClusterName result)

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

Parameters
Name	Description
`orchestrationClusterName`	`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`	`OrchestrationClusterName` When this method returns, the parsed OrchestrationClusterName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(OrchestrationClusterName, OrchestrationClusterName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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