NetApp v1 API - Class VolumeName (1.3.0)

public sealed class VolumeName : IResourceName, IEquatable<VolumeName>

Reference documentation and code samples for the NetApp v1 API class VolumeName.

Resource name for the Volume resource.

Inheritance

object > VolumeName

Namespace

Google.Cloud.NetApp.V1

Assembly

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

The VolumeName.ResourceNameType of the contained resource name.

Property Value
Type Description
VolumeNameResourceNameType

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
int
Overrides

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

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

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
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}

TryParse(string, bool, 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 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 VolumeName

When this method returns, the parsed VolumeName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(VolumeName, VolumeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a VolumeName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a VolumeName

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

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.