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

public sealed class LustreInstanceName : IResourceName, IEquatable<LustreInstanceName>

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

Resource name for the LustreInstance resource.

Inheritance

object > LustreInstanceName

Namespace

Google.Cloud.HypercomputeCluster.V1Beta

Assembly

Google.Cloud.HypercomputeCluster.V1Beta.dll

Constructors

LustreInstanceName(string, string, string)

public LustreInstanceName(string projectId, string locationId, string instanceId)

Constructs a new instance of a LustreInstanceName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}

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

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

The LustreInstanceName.ResourceNameType of the contained resource name.

Property Value
Type Description
LustreInstanceNameResourceNameType

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

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

Formats the IDs into the string representation of this LustreInstanceName with pattern projects/{project}/locations/{location}/instances/{instance}.

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

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

The string representation of this LustreInstanceName with pattern projects/{project}/locations/{location}/instances/{instance}.

FormatProjectLocationInstance(string, string, string)

public static string FormatProjectLocationInstance(string projectId, string locationId, string instanceId)

Formats the IDs into the string representation of this LustreInstanceName with pattern projects/{project}/locations/{location}/instances/{instance}.

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

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

The string representation of this LustreInstanceName with pattern projects/{project}/locations/{location}/instances/{instance}.

FromProjectLocationInstance(string, string, string)

public static LustreInstanceName FromProjectLocationInstance(string projectId, string locationId, string instanceId)

Creates a LustreInstanceName with the pattern projects/{project}/locations/{location}/instances/{instance}.

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

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

A new instance of LustreInstanceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LustreInstanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LustreInstanceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
lustreInstanceName string

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

The parsed LustreInstanceName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}

Parse(string, bool)

public static LustreInstanceName Parse(string lustreInstanceName, bool allowUnparsed)

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

Parameters
Name Description
lustreInstanceName 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
LustreInstanceName

The parsed LustreInstanceName if successful.
Remarks

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

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

public static bool TryParse(string lustreInstanceName, out LustreInstanceName result)

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

Parameters
Name Description
lustreInstanceName string

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

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

TryParse(string, bool, out LustreInstanceName)

public static bool TryParse(string lustreInstanceName, bool allowUnparsed, out LustreInstanceName result)

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

Parameters
Name Description
lustreInstanceName 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 LustreInstanceName

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

Operators

operator ==(LustreInstanceName, LustreInstanceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LustreInstanceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LustreInstanceName

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

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.