Cluster Director v1beta API - Class DiskName (1.0.0-beta02)

1.0.0-beta02 (latest) 1.0.0-beta01

public sealed class DiskName : IResourceName, IEquatable<DiskName>

Reference documentation and code samples for the Cluster Director v1beta API class DiskName.

Resource name for the Disk resource.

Inheritance

object > DiskName

Implements

IResourceName, IEquatableDiskName

Inherited Members

object.GetType()

Namespace

Google.Cloud.HypercomputeCluster.V1Beta

Assembly

Google.Cloud.HypercomputeCluster.V1Beta.dll

Constructors

DiskName(string, string, string)

public DiskName(string projectId, string zoneId, string diskId)

Constructs a new instance of a DiskName class from the component parts of pattern projects/{project}/zones/{zone}/disks/{disk}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
zoneId	string The Zone ID. Must not be null or empty.
diskId	string The Disk ID. Must not be null or empty.

Properties

DiskId

public string DiskId { get; }

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

Type

public DiskName.ResourceNameType Type { get; }

The DiskName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DiskNameResourceNameType

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 zoneId, string diskId)

Formats the IDs into the string representation of this DiskName with pattern projects/{project}/zones/{zone}/disks/{disk}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
zoneId	string The Zone ID. Must not be null or empty.
diskId	string The Disk ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DiskName with pattern projects/{project}/zones/{zone}/disks/{disk}.

FormatProjectZoneDisk(string, string, string)

public static string FormatProjectZoneDisk(string projectId, string zoneId, string diskId)

Formats the IDs into the string representation of this DiskName with pattern projects/{project}/zones/{zone}/disks/{disk}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
zoneId	string The Zone ID. Must not be null or empty.
diskId	string The Disk ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DiskName with pattern projects/{project}/zones/{zone}/disks/{disk}.

FromProjectZoneDisk(string, string, string)

public static DiskName FromProjectZoneDisk(string projectId, string zoneId, string diskId)

Creates a DiskName with the pattern projects/{project}/zones/{zone}/disks/{disk}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
zoneId	string The Zone ID. Must not be null or empty.
diskId	string The Disk ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static DiskName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DiskName containing an unparsed resource name.

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

Returns
Type	Description
DiskName	A new instance of DiskName 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 DiskName Parse(string diskName)

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

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

Returns
Type	Description
DiskName	The parsed DiskName if successful.

Remarks

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

• projects/{project}/zones/{zone}/disks/{disk}

Parse(string, bool)

public static DiskName Parse(string diskName, bool allowUnparsed)

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

Parameters
Name	Description
diskName	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
DiskName	The parsed DiskName if successful.

Remarks

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

• projects/{project}/zones/{zone}/disks/{disk}

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

public static bool TryParse(string diskName, out DiskName result)

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

Parameters
Name	Description
diskName	string The resource name in string form. Must not be null.
result	DiskName When this method returns, the parsed DiskName, 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}/zones/{zone}/disks/{disk}

TryParse(string, bool, out DiskName)

public static bool TryParse(string diskName, bool allowUnparsed, out DiskName result)

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

Parameters
Name	Description
diskName	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	DiskName When this method returns, the parsed DiskName, 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}/zones/{zone}/disks/{disk}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DiskName, DiskName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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