Google Cloud Dataproc v1 API - Class RegionName (5.11.0)

public sealed class RegionName : IResourceName, IEquatable<RegionName>

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

Resource name for the Region resource.

Inheritance

object > RegionName

Implements

IResourceName, IEquatable RegionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

RegionName(string, string)

public RegionName(string projectId, string regionId)

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

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.

Properties

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`

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

The RegionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`RegionNameResourceNameType`

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)

public static string Format(string projectId, string regionId)

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

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.

Returns
Type	Description
`string`	The string representation of this RegionName with pattern `projects/{project}/regions/{region}`.

FormatProjectRegion(string, string)

public static string FormatProjectRegion(string projectId, string regionId)

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

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.

Returns
Type	Description
`string`	The string representation of this RegionName with pattern `projects/{project}/regions/{region}`.

FromProjectRegion(string, string)

public static RegionName FromProjectRegion(string projectId, string regionId)

Creates a RegionName with the pattern projects/{project}/regions/{region}.

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.

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

FromUnparsed(UnparsedResourceName)

public static RegionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RegionName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/regions/{region}

Parse(string, bool)

public static RegionName Parse(string regionName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/regions/{region}

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

public static bool TryParse(string regionName, out RegionName result)

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

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

TryParse(string, bool, out RegionName)

public static bool TryParse(string regionName, bool allowUnparsed, out RegionName result)

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

Parameters
Name	Description
`regionName`	`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`	`RegionName` When this method returns, the parsed RegionName, 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}/regions/{region}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RegionName, RegionName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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