Bare Metal Solution v2 API - Class LunName (1.8.0)

Version latest

• 1.8.0 (latest)
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class LunName : IResourceName, IEquatable<LunName>

Reference documentation and code samples for the Bare Metal Solution v2 API class LunName.

Resource name for the Lun resource.

Inheritance

object > LunName

Implements

IResourceName, IEquatableLunName

Inherited Members

object.GetType()

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

LunName(string, string, string, string)

public LunName(string projectId, string locationId, string volumeId, string lunId)

Constructs a new instance of a LunName class from the component parts of pattern projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}

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.
volumeId	string The Volume ID. Must not be null or empty.
lunId	string The Lun ID. Must not be null or empty.

Properties

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

LunId

public string LunId { get; }

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

The LunName.ResourceNameType of the contained resource name.

Property Value
Type	Description
LunNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
UnparsedResourceName

VolumeId

public string VolumeId { get; }

The Volume ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string volumeId, string lunId)

Formats the IDs into the string representation of this LunName with pattern projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}.

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.
volumeId	string The Volume ID. Must not be null or empty.
lunId	string The Lun ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this LunName with pattern projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}.

FormatProjectLocationVolumeLun(string, string, string, string)

public static string FormatProjectLocationVolumeLun(string projectId, string locationId, string volumeId, string lunId)

Formats the IDs into the string representation of this LunName with pattern projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}.

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.
volumeId	string The Volume ID. Must not be null or empty.
lunId	string The Lun ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this LunName with pattern projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}.

FromProjectLocationVolumeLun(string, string, string, string)

public static LunName FromProjectLocationVolumeLun(string projectId, string locationId, string volumeId, string lunId)

Creates a LunName with the pattern projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}.

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.
volumeId	string The Volume ID. Must not be null or empty.
lunId	string The Lun ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static LunName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LunName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
LunName	The parsed LunName if successful.

Remarks

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

• projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}

Parse(string, bool)

public static LunName Parse(string lunName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/volumes/{volume}/luns/{lun}

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

public static bool TryParse(string lunName, out LunName result)

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

Parameters
Name	Description
lunName	string The resource name in string form. Must not be null.
result	LunName When this method returns, the parsed LunName, 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}/volumes/{volume}/luns/{lun}

TryParse(string, bool, out LunName)

public static bool TryParse(string lunName, bool allowUnparsed, out LunName result)

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

Parameters
Name	Description
lunName	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	LunName When this method returns, the parsed LunName, 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}/volumes/{volume}/luns/{lun}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LunName, LunName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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