Class RegionName

public sealed class RegionName : IResourceName, IEquatable<RegionName>

Resource name for the Region resource.

Inheritance

Object > RegionName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

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
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

RegionId

public string RegionId { get; }

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

Property Value
TypeDescription
String

Type

public RegionName.ResourceNameType Type { get; }

The RegionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
RegionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

regionIdString

The Region ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
RegionName

A new instance of RegionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static RegionName Parse(string regionName)

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

Parameter
NameDescription
regionNameString

The resource name in string form. Must not be null.

Returns
TypeDescription
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, Boolean)

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
NameDescription
regionNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
regionNameString

The resource name in string form. Must not be null.

resultRegionName

When this method returns, the parsed RegionName, or null if parsing failed.

Returns
TypeDescription
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}

TryParse(String, Boolean, 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
NameDescription
regionNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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.

resultRegionName

When this method returns, the parsed RegionName, or null if parsing failed.

Returns
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

Operators

Equality(RegionName, RegionName)

public static bool operator ==(RegionName a, RegionName b)
Parameters
NameDescription
aRegionName
bRegionName
Returns
TypeDescription
Boolean

Inequality(RegionName, RegionName)

public static bool operator !=(RegionName a, RegionName b)
Parameters
NameDescription
aRegionName
bRegionName
Returns
TypeDescription
Boolean