Cluster Director v1beta API - Class ComputeInstanceName (1.0.0-beta01) 

public sealed class ComputeInstanceName : IResourceName, IEquatable<ComputeInstanceName>

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

Resource name for the ComputeInstance resource.

Inheritance

object > ComputeInstanceName

Namespace

Google.Cloud.HypercomputeCluster.V1Beta

Assembly

Google.Cloud.HypercomputeCluster.V1Beta.dll

Constructors

ComputeInstanceName(string, string, string)

public ComputeInstanceName(string projectId, string zoneId, string instanceId)

Constructs a new instance of a ComputeInstanceName class from the component parts of pattern projects/{project}/zones/{zone}/instances/{instance}

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.
instanceId string

The Instance ID. Must not be null or empty.

Properties

InstanceId

public string InstanceId { get; }

The Instance 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 ComputeInstanceName.ResourceNameType Type { get; }

The ComputeInstanceName.ResourceNameType of the contained resource name.

Property Value
Type Description
ComputeInstanceNameResourceNameType

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

Formats the IDs into the string representation of this ComputeInstanceName with pattern projects/{project}/zones/{zone}/instances/{instance}.

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.
instanceId string

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

The string representation of this ComputeInstanceName with pattern projects/{project}/zones/{zone}/instances/{instance}.

FormatProjectZoneInstance(string, string, string)

public static string FormatProjectZoneInstance(string projectId, string zoneId, string instanceId)

Formats the IDs into the string representation of this ComputeInstanceName with pattern projects/{project}/zones/{zone}/instances/{instance}.

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.
instanceId string

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

The string representation of this ComputeInstanceName with pattern projects/{project}/zones/{zone}/instances/{instance}.

FromProjectZoneInstance(string, string, string)

public static ComputeInstanceName FromProjectZoneInstance(string projectId, string zoneId, string instanceId)

Creates a ComputeInstanceName with the pattern projects/{project}/zones/{zone}/instances/{instance}.

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.
instanceId string

The Instance ID. Must not be null or empty.
Returns
Type Description
ComputeInstanceName

A new instance of ComputeInstanceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ComputeInstanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ComputeInstanceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of ComputeInstanceName 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 ComputeInstanceName Parse(string computeInstanceName)

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

Parameter
Name Description
computeInstanceName string

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

The parsed ComputeInstanceName if successful.
Remarks

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

  • projects/{project}/zones/{zone}/instances/{instance}

Parse(string, bool)

public static ComputeInstanceName Parse(string computeInstanceName, bool allowUnparsed)

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

Parameters
Name Description
computeInstanceName 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
ComputeInstanceName

The parsed ComputeInstanceName if successful.
Remarks

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

  • projects/{project}/zones/{zone}/instances/{instance}
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 ComputeInstanceName)

public static bool TryParse(string computeInstanceName, out ComputeInstanceName result)

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

Parameters
Name Description
computeInstanceName string

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

When this method returns, the parsed ComputeInstanceName, 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}/instances/{instance}

TryParse(string, bool, out ComputeInstanceName)

public static bool TryParse(string computeInstanceName, bool allowUnparsed, out ComputeInstanceName result)

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

Parameters
Name Description
computeInstanceName 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 ComputeInstanceName

When this method returns, the parsed ComputeInstanceName, 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}/instances/{instance}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ComputeInstanceName, ComputeInstanceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ComputeInstanceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ComputeInstanceName

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

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.