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

public sealed class FileInstanceName : IResourceName, IEquatable<FileInstanceName>

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

Resource name for the FileInstance resource.

Inheritance

object > FileInstanceName

Namespace

Google.Cloud.HypercomputeCluster.V1Beta

Assembly

Google.Cloud.HypercomputeCluster.V1Beta.dll

Constructors

FileInstanceName(string, string, string)

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

Constructs a new instance of a FileInstanceName 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 FileInstanceName.ResourceNameType Type { get; }

The FileInstanceName.ResourceNameType of the contained resource name.

Property Value
Type Description
FileInstanceNameResourceNameType

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 FileInstanceName 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 FileInstanceName 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 FileInstanceName 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 FileInstanceName with pattern projects/{project}/locations/{location}/instances/{instance}.

FromProjectLocationInstance(string, string, string)

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

Creates a FileInstanceName 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
FileInstanceName

A new instance of FileInstanceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FileInstanceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FileInstanceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
fileInstanceName string

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

The parsed FileInstanceName 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 FileInstanceName Parse(string fileInstanceName, bool allowUnparsed)

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

Parameters
Name Description
fileInstanceName 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
FileInstanceName

The parsed FileInstanceName 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 FileInstanceName)

public static bool TryParse(string fileInstanceName, out FileInstanceName result)

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

Parameters
Name Description
fileInstanceName string

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

When this method returns, the parsed FileInstanceName, 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 FileInstanceName)

public static bool TryParse(string fileInstanceName, bool allowUnparsed, out FileInstanceName result)

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

Parameters
Name Description
fileInstanceName 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 FileInstanceName

When this method returns, the parsed FileInstanceName, 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 ==(FileInstanceName, FileInstanceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FileInstanceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FileInstanceName

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

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.