# BigQuery Connection v1 API - Class ClusterName (2.10.0)

<button class="button button-with-icon cloud-select-dropdown__button " aria-haspopup="true">Version latest</button>

- [2.10.0 (latest)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.9.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.9.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.8.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.8.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.7.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.7.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.6.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.6.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.5.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.5.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.4.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.4.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.3.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.2.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.1.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.1.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [2.0.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/2.0.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [1.6.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/1.6.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [1.5.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/1.5.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [1.4.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/1.4.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [1.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/1.3.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)
- [1.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/1.2.0/Google.Cloud.BigQuery.Connection.V1.ClusterName)

    public sealed class ClusterName : IResourceName, IEquatable<ClusterName>

Reference documentation and code samples for the BigQuery Connection v1 API class ClusterName.

Resource name for the `Cluster` resource.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> ClusterName

## Implements

[IResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.html), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName)

## Inherited Members

[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype)

## Namespace

[Google.Cloud.BigQuery.Connection.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1)

## Assembly

Google.Cloud.BigQuery.Connection.V1.dll

## Constructors

### ClusterName(string, string, string)

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

Constructs a new instance of a [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) class from the component parts of pattern
`projects/{project}/regions/{region}/clusters/{cluster}`

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Project` ID. Must not be `null` or empty. |
| `regionId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Region` ID. Must not be `null` or empty. |
| `clusterId` | `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### IsKnownPattern

    public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### ProjectId

    public string ProjectId { get; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### RegionId

    public string RegionId { get; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Type

    public ClusterName.ResourceNameType Type { get; }

The [ClusterName.ResourceNameType](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName.ResourceNameType) of the contained resource name.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterNamehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName.ResourceNameType` |   |

### UnparsedResource

    public UnparsedResourceName UnparsedResource { get; }

The contained [UnparsedResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html). Only non-`null` if this instance contains an
unparsed resource name.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html` |   |

## Methods

### Format(string, string, string)

    public static string Format(string projectId, string regionId, string clusterId)

Formats the IDs into the string representation of this [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) with pattern
`projects/{project}/regions/{region}/clusters/{cluster}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Project` ID. Must not be `null` or empty. |
| `regionId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Region` ID. Must not be `null` or empty. |
| `clusterId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Cluster` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) with pattern `projects/{project}/regions/{region}/clusters/{cluster}`. |

### FormatProjectRegionCluster(string, string, string)

    public static string FormatProjectRegionCluster(string projectId, string regionId, string clusterId)

Formats the IDs into the string representation of this [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) with pattern
`projects/{project}/regions/{region}/clusters/{cluster}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Project` ID. Must not be `null` or empty. |
| `regionId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Region` ID. Must not be `null` or empty. |
| `clusterId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Cluster` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) with pattern `projects/{project}/regions/{region}/clusters/{cluster}`. |

### FromProjectRegionCluster(string, string, string)

    public static ClusterName FromProjectRegionCluster(string projectId, string regionId, string clusterId)

Creates a [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) with the pattern
`projects/{project}/regions/{region}/clusters/{cluster}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Project` ID. Must not be `null` or empty. |
| `regionId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Region` ID. Must not be `null` or empty. |
| `clusterId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Cluster` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` | A new instance of [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) constructed from the provided ids. |

### FromUnparsed(UnparsedResourceName)

    public static ClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) containing an unparsed resource name.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `unparsedResourceName` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html` The unparsed resource name. Must not be `null`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` | A new instance of [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) containing the provided `unparsedResourceName`. |

### GetHashCode()

    public override int GetHashCode()

Returns a hash code for this resource name.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

**Overrides** [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

### Parse(string)

    public static ClusterName Parse(string clusterName)

Parses the given resource name string into a new [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) instance.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `clusterName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` | The parsed [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) if successful. |

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

- `projects/{project}/regions/{region}/clusters/{cluster}`

<br />

### Parse(string, bool)

    public static ClusterName Parse(string clusterName, bool allowUnparsed)

Parses the given resource name string into a new [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) instance; optionally allowing an
unparseable resource name.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `clusterName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `allowUnparsed` | `https://learn.microsoft.com/dotnet/api/system.boolean` If `true` will successfully store an unparseable resource name into the [UnparsedResource](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName#Google_Cloud_BigQuery_Connection_V1_ClusterName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` | The parsed [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) if successful. |

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

- `projects/{project}/regions/{region}/clusters/{cluster}`

Or may be in any format if `allowUnparsed` is `true`.

<br />

### ToString()

    public override string ToString()

The string representation of the resource name.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of the resource name. |

**Overrides** [object.ToString()](https://learn.microsoft.com/dotnet/api/system.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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) instance.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `clusterName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `result` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` When this method returns, the parsed [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName), or `null` if parsing failed. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | `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}/regions/{region}/clusters/{cluster}`

<br />

### 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](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName) instance; optionally
allowing an unparseable resource name.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `clusterName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `allowUnparsed` | `https://learn.microsoft.com/dotnet/api/system.boolean` If `true` will successfully store an unparseable resource name into the [UnparsedResource](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName#Google_Cloud_BigQuery_Connection_V1_ClusterName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |
| `result` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` When this method returns, the parsed [ClusterName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName), or `null` if parsing failed. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | `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}/regions/{region}/clusters/{cluster}`

Or may be in any format if `allowUnparsed` is `true`.

<br />

## Operators

### operator ==(ClusterName, ClusterName)

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

Determines whether two specified resource names have the same value.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `a` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` The first resource name to compare, or null. |
| `b` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` The second resource name to compare, or null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | true if the value of `a` is the same as the value of `b`; otherwise, false. |

### operator !=(ClusterName, ClusterName)

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

Determines whether two specified resource names have different values.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `a` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` The first resource name to compare, or null. |
| `b` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Connection.V1/latest/Google.Cloud.BigQuery.Connection.V1.ClusterName` The second resource name to compare, or null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | true if the value of `a` is different from the value of `b`; otherwise, false. |