Google Cloud Bigtable Administration v2 API - Class ClusterName (3.4.0)

public sealed class ClusterName : IResourceName, IEquatable<ClusterName>

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class ClusterName.

Resource name for the Cluster resource.

Inheritance

object > ClusterName

Implements

IResourceName, IEquatable ClusterName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Bigtable.Admin.V2

Assembly

Google.Cloud.Bigtable.Admin.V2.dll

Constructors

ClusterName(string, string, string)

public ClusterName(string projectId, string instanceId, string clusterId)

Constructs a new instance of a ClusterName class from the component parts of pattern projects/{project}/instances/{instance}/clusters/{cluster}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.

Properties

ClusterId

public string ClusterId { get; }

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

Property Value
Type	Description
`string`

InstanceId

public string InstanceId { get; }

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

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

The ClusterName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ClusterNameResourceNameType`

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

Formats the IDs into the string representation of this ClusterName with pattern projects/{project}/instances/{instance}/clusters/{cluster}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ClusterName with pattern `projects/{project}/instances/{instance}/clusters/{cluster}`.

FormatProjectInstanceCluster(string, string, string)

public static string FormatProjectInstanceCluster(string projectId, string instanceId, string clusterId)

Formats the IDs into the string representation of this ClusterName with pattern projects/{project}/instances/{instance}/clusters/{cluster}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ClusterName with pattern `projects/{project}/instances/{instance}/clusters/{cluster}`.

FromProjectInstanceCluster(string, string, string)

public static ClusterName FromProjectInstanceCluster(string projectId, string instanceId, string clusterId)

Creates a ClusterName with the pattern projects/{project}/instances/{instance}/clusters/{cluster}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ClusterName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/instances/{instance}/clusters/{cluster}

Parse(string, bool)

public static ClusterName Parse(string clusterName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/instances/{instance}/clusters/{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 ClusterName)

public static bool TryParse(string clusterName, out ClusterName result)

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

Parameters
Name	Description
`clusterName`	`string` The resource name in string form. Must not be `null`.
`result`	`ClusterName` When this method returns, the parsed ClusterName, 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}/instances/{instance}/clusters/{cluster}

TryParse(string, bool, out ClusterName)

public static bool TryParse(string clusterName, bool allowUnparsed, out ClusterName result)

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

Parameters
Name	Description
`clusterName`	`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`	`ClusterName` When this method returns, the parsed ClusterName, 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}/instances/{instance}/clusters/{cluster}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ClusterName, ClusterName)

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

Parameters
Name	Description
`a`	`ClusterName`
`b`	`ClusterName`

Returns
Type	Description
`bool`

operator !=(ClusterName, ClusterName)

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

Parameters
Name	Description
`a`	`ClusterName`
`b`	`ClusterName`

Returns
Type	Description
`bool`