Bare Metal Solution v2 API - Class VolumeSnapshotName (1.4.0)

public sealed class VolumeSnapshotName : IResourceName, IEquatable<VolumeSnapshotName>

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

Resource name for the VolumeSnapshot resource.

Inheritance

object > VolumeSnapshotName

Implements

IResourceName, IEquatable VolumeSnapshotName

Inherited Members

object.GetType()

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

VolumeSnapshotName(string, string, string, string)

public VolumeSnapshotName(string projectId, string locationId, string volumeId, string snapshotId)

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

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.
`snapshotId`	`string` The `Snapshot` 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`

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`

SnapshotId

public string SnapshotId { get; }

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

Property Value
Type	Description
`string`

Type

public VolumeSnapshotName.ResourceNameType Type { get; }

The VolumeSnapshotName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`VolumeSnapshotNameResourceNameType`

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

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

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.
`snapshotId`	`string` The `Snapshot` ID. Must not be `null` or empty.

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

FormatProjectLocationVolumeSnapshot(string, string, string, string)

public static string FormatProjectLocationVolumeSnapshot(string projectId, string locationId, string volumeId, string snapshotId)

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

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.
`snapshotId`	`string` The `Snapshot` ID. Must not be `null` or empty.

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

FromProjectLocationVolumeSnapshot(string, string, string, string)

public static VolumeSnapshotName FromProjectLocationVolumeSnapshot(string projectId, string locationId, string volumeId, string snapshotId)

Creates a VolumeSnapshotName with the pattern projects/{project}/locations/{location}/volumes/{volume}/snapshots/{snapshot}.

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.
`snapshotId`	`string` The `Snapshot` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static VolumeSnapshotName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VolumeSnapshotName containing an unparsed resource name.

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

Returns
Type	Description
`VolumeSnapshotName`	A new instance of VolumeSnapshotName 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 VolumeSnapshotName Parse(string volumeSnapshotName)

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

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

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

Remarks

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

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

Parse(string, bool)

public static VolumeSnapshotName Parse(string volumeSnapshotName, bool allowUnparsed)

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

Parameters
Name	Description
`volumeSnapshotName`	`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
`VolumeSnapshotName`	The parsed VolumeSnapshotName if successful.

Remarks

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

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

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

public static bool TryParse(string volumeSnapshotName, out VolumeSnapshotName result)

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

Parameters
Name	Description
`volumeSnapshotName`	`string` The resource name in string form. Must not be `null`.
`result`	`VolumeSnapshotName` When this method returns, the parsed VolumeSnapshotName, 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}/snapshots/{snapshot}

TryParse(string, bool, out VolumeSnapshotName)

public static bool TryParse(string volumeSnapshotName, bool allowUnparsed, out VolumeSnapshotName result)

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

Parameters
Name	Description
`volumeSnapshotName`	`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`	`VolumeSnapshotName` When this method returns, the parsed VolumeSnapshotName, 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}/snapshots/{snapshot}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(VolumeSnapshotName, VolumeSnapshotName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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