Bare Metal Solution v2 API - Class VolumeName (1.0.0)

public sealed class VolumeName : IResourceName, IEquatable<VolumeName>

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

Resource name for the Volume resource.

Inheritance

Object > VolumeName

Implements

IResourceName, IEquatable<VolumeName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

VolumeName(String, String, String)

public VolumeName(string projectId, string locationId, string volumeId)

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

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.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`Boolean`

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

The VolumeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`VolumeName.ResourceNameType`

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)

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

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

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.

Returns
Type	Description
`String`	The string representation of this VolumeName with pattern `projects/{project}/locations/{location}/volumes/{volume}`.

FormatProjectLocationVolume(String, String, String)

public static string FormatProjectLocationVolume(string projectId, string locationId, string volumeId)

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

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.

Returns
Type	Description
`String`	The string representation of this VolumeName with pattern `projects/{project}/locations/{location}/volumes/{volume}`.

FromProjectLocationVolume(String, String, String)

public static VolumeName FromProjectLocationVolume(string projectId, string locationId, string volumeId)

Creates a VolumeName with the pattern projects/{project}/locations/{location}/volumes/{volume}.

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.

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

FromUnparsed(UnparsedResourceName)

public static VolumeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VolumeName containing an unparsed resource name.

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

Returns
Type	Description
`VolumeName`	A new instance of VolumeName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static VolumeName Parse(string volumeName)

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

Parameter
Name	Description
`volumeName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`VolumeName`	The parsed VolumeName if successful.

Remarks

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

projects/{project}/locations/{location}/volumes/{volume}

Parse(String, Boolean)

public static VolumeName Parse(string volumeName, bool allowUnparsed)

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

Parameters
Name	Description
`volumeName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`VolumeName`	The parsed VolumeName if successful.

Remarks

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

projects/{project}/locations/{location}/volumes/{volume}

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

public static bool TryParse(string volumeName, out VolumeName result)

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

Parameters
Name	Description
`volumeName`	`String` The resource name in string form. Must not be `null`.
`result`	`VolumeName` When this method returns, the parsed VolumeName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}

TryParse(String, Boolean, out VolumeName)

public static bool TryParse(string volumeName, bool allowUnparsed, out VolumeName result)

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

Parameters
Name	Description
`volumeName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`VolumeName` When this method returns, the parsed VolumeName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(VolumeName, VolumeName)

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

Parameters
Name	Description
`a`	`VolumeName`
`b`	`VolumeName`

Returns
Type	Description
`Boolean`

Inequality(VolumeName, VolumeName)

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

Parameters
Name	Description
`a`	`VolumeName`
`b`	`VolumeName`

Returns
Type	Description
`Boolean`