Google Cloud Dataproc v1 API - Class ClusterRegionName (5.2.0)

public sealed class ClusterRegionName : IResourceName, IEquatable<ClusterRegionName>

Reference documentation and code samples for the Google Cloud Dataproc v1 API class ClusterRegionName.

Resource name for the ClusterRegion resource.

Inheritance

Object > ClusterRegionName

Implements

IResourceName, IEquatable<ClusterRegionName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

ClusterRegionName(String, String, String)

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

Constructs a new instance of a ClusterRegionName class from the component parts of pattern projects/{project}/regions/{region}/clusters/{cluster}

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`regionId`	`String` The `Region` 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`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`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
`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
`String`

Type

public ClusterRegionName.ResourceNameType Type { get; }

The ClusterRegionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ClusterRegionName.ResourceNameType`

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

Formats the IDs into the string representation of this ClusterRegionName with pattern projects/{project}/regions/{region}/clusters/{cluster}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`regionId`	`String` The `Region` 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 ClusterRegionName 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 ClusterRegionName with pattern projects/{project}/regions/{region}/clusters/{cluster}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`regionId`	`String` The `Region` 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 ClusterRegionName with pattern `projects/{project}/regions/{region}/clusters/{cluster}`.

FromProjectRegionCluster(String, String, String)

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

Creates a ClusterRegionName with the pattern projects/{project}/regions/{region}/clusters/{cluster}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`regionId`	`String` The `Region` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ClusterRegionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ClusterRegionName containing an unparsed resource name.

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

Returns
Type	Description
`ClusterRegionName`	A new instance of ClusterRegionName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static ClusterRegionName Parse(string clusterRegionName)

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

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

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

Remarks

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

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

Parse(String, Boolean)

public static ClusterRegionName Parse(string clusterRegionName, bool allowUnparsed)

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

Parameters
Name	Description
`clusterRegionName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`ClusterRegionName`	The parsed ClusterRegionName 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.

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

public static bool TryParse(string clusterRegionName, out ClusterRegionName result)

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

Parameters
Name	Description
`clusterRegionName`	`String` The resource name in string form. Must not be `null`.
`result`	`ClusterRegionName` When this method returns, the parsed ClusterRegionName, or `null` if parsing failed.

Returns
Type	Description
`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}

TryParse(String, Boolean, out ClusterRegionName)

public static bool TryParse(string clusterRegionName, bool allowUnparsed, out ClusterRegionName result)

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

Parameters
Name	Description
`clusterRegionName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`ClusterRegionName` When this method returns, the parsed ClusterRegionName, or `null` if parsing failed.

Returns
Type	Description
`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.

Operators

Equality(ClusterRegionName, ClusterRegionName)

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

Parameters
Name	Description
`a`	`ClusterRegionName`
`b`	`ClusterRegionName`

Returns
Type	Description
`Boolean`

Inequality(ClusterRegionName, ClusterRegionName)

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

Parameters
Name	Description
`a`	`ClusterRegionName`
`b`	`ClusterRegionName`

Returns
Type	Description
`Boolean`