GDC Hardware Management v1alpha API - Class ZoneName (1.0.0-alpha02) 

public sealed class ZoneName : IResourceName, IEquatable<ZoneName>

Reference documentation and code samples for the GDC Hardware Management v1alpha API class ZoneName.

Resource name for the Zone resource.

Inheritance

object > ZoneName

Namespace

Google.Cloud.GdcHardwareManagement.V1Alpha

Assembly

Google.Cloud.GdcHardwareManagement.V1Alpha.dll

Constructors

ZoneName(string, string, string)

public ZoneName(string projectId, string locationId, string zoneId)

Constructs a new instance of a ZoneName class from the component parts of pattern projects/{project}/locations/{location}/zones/{zone}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
zoneId string

The Zone 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

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

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

The ZoneName.ResourceNameType of the contained resource name.

Property Value
Type Description
ZoneNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

ZoneId

public string ZoneId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string locationId, string zoneId)

Formats the IDs into the string representation of this ZoneName with pattern projects/{project}/locations/{location}/zones/{zone}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
zoneId string

The Zone ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ZoneName with pattern projects/{project}/locations/{location}/zones/{zone}.

FormatProjectLocationZone(string, string, string)

public static string FormatProjectLocationZone(string projectId, string locationId, string zoneId)

Formats the IDs into the string representation of this ZoneName with pattern projects/{project}/locations/{location}/zones/{zone}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
zoneId string

The Zone ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ZoneName with pattern projects/{project}/locations/{location}/zones/{zone}.

FromProjectLocationZone(string, string, string)

public static ZoneName FromProjectLocationZone(string projectId, string locationId, string zoneId)

Creates a ZoneName with the pattern projects/{project}/locations/{location}/zones/{zone} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
zoneId string

The Zone ID. Must not be null or empty.
Returns
Type Description
ZoneName

A new instance of ZoneName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ZoneName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ZoneName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ZoneName

A new instance of ZoneName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ZoneName Parse(string zoneName)

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

Parameter
Name Description
zoneName string

The resource name in string form. Must not be null.
Returns
Type Description
ZoneName

The parsed ZoneName if successful.
Remarks

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

  • projects/{project}/locations/{location}/zones/{zone}

Parse(string, bool)

public static ZoneName Parse(string zoneName, bool allowUnparsed)

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

Parameters
Name Description
zoneName 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
ZoneName

The parsed ZoneName if successful.
Remarks

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

  • projects/{project}/locations/{location}/zones/{zone}
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

TryParse(string, out ZoneName)

public static bool TryParse(string zoneName, out ZoneName result)

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

Parameters
Name Description
zoneName string

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

When this method returns, the parsed ZoneName, 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}/locations/{location}/zones/{zone}

TryParse(string, bool, out ZoneName)

public static bool TryParse(string zoneName, bool allowUnparsed, out ZoneName result)

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

Parameters
Name Description
zoneName 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 ZoneName

When this method returns, the parsed ZoneName, 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}/locations/{location}/zones/{zone}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ZoneName, ZoneName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ZoneName

The first resource name to compare, or null.
b ZoneName

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 !=(ZoneName, ZoneName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ZoneName

The first resource name to compare, or null.
b ZoneName

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.