Google Cloud Managed Lustre v1 API - Class MirrorName (1.1.0) 

public sealed class MirrorName : IResourceName, IEquatable<MirrorName>

Reference documentation and code samples for the Google Cloud Managed Lustre v1 API class MirrorName.

Resource name for the Mirror resource.

Inheritance

object > MirrorName

Namespace

Google.Cloud.Lustre.V1

Assembly

Google.Cloud.Lustre.V1.dll

Constructors

MirrorName(string, string, string, string)

public MirrorName(string projectId, string locationId, string instanceId, string mirrorId)

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

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

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

MirrorId

public string MirrorId { get; }

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

The MirrorName.ResourceNameType of the contained resource name.

Property Value
Type Description
MirrorNameResourceNameType

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

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

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

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

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

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

FormatProjectLocationInstanceMirror(string, string, string, string)

public static string FormatProjectLocationInstanceMirror(string projectId, string locationId, string instanceId, string mirrorId)

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

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

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

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

FromProjectLocationInstanceMirror(string, string, string, string)

public static MirrorName FromProjectLocationInstanceMirror(string projectId, string locationId, string instanceId, string mirrorId)

Creates a MirrorName with the pattern projects/{project}/locations/{location}/instances/{instance}/mirrors/{mirror}.

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

The Mirror ID. Must not be null or empty.
Returns
Type Description
MirrorName

A new instance of MirrorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MirrorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MirrorName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
mirrorName string

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

The parsed MirrorName if successful.
Remarks

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

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

Parse(string, bool)

public static MirrorName Parse(string mirrorName, bool allowUnparsed)

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

Parameters
Name Description
mirrorName 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
MirrorName

The parsed MirrorName if successful.
Remarks

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

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

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

public static bool TryParse(string mirrorName, out MirrorName result)

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

Parameters
Name Description
mirrorName string

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

When this method returns, the parsed MirrorName, 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}/mirrors/{mirror}

TryParse(string, bool, out MirrorName)

public static bool TryParse(string mirrorName, bool allowUnparsed, out MirrorName result)

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

Parameters
Name Description
mirrorName 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 MirrorName

When this method returns, the parsed MirrorName, 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}/mirrors/{mirror}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MirrorName, MirrorName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MirrorName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MirrorName

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

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.