NetApp v1 API - Class StoragePoolName (1.11.0) 

public sealed class StoragePoolName : IResourceName, IEquatable<StoragePoolName>

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

Resource name for the StoragePool resource.

Inheritance

object > StoragePoolName

Namespace

Google.Cloud.NetApp.V1

Assembly

Google.Cloud.NetApp.V1.dll

Constructors

StoragePoolName(string, string, string)

public StoragePoolName(string projectId, string locationId, string storagePoolId)

Constructs a new instance of a StoragePoolName class from the component parts of pattern projects/{project}/locations/{location}/storagePools/{storage_pool}

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

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

StoragePoolId

public string StoragePoolId { get; }

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

Property Value
Type Description
string

Type

public StoragePoolName.ResourceNameType Type { get; }

The StoragePoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
StoragePoolNameResourceNameType

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)

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

Formats the IDs into the string representation of this StoragePoolName with pattern projects/{project}/locations/{location}/storagePools/{storage_pool}.

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

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

The string representation of this StoragePoolName with pattern projects/{project}/locations/{location}/storagePools/{storage_pool}.

FormatProjectLocationStoragePool(string, string, string)

public static string FormatProjectLocationStoragePool(string projectId, string locationId, string storagePoolId)

Formats the IDs into the string representation of this StoragePoolName with pattern projects/{project}/locations/{location}/storagePools/{storage_pool}.

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

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

The string representation of this StoragePoolName with pattern projects/{project}/locations/{location}/storagePools/{storage_pool}.

FromProjectLocationStoragePool(string, string, string)

public static StoragePoolName FromProjectLocationStoragePool(string projectId, string locationId, string storagePoolId)

Creates a StoragePoolName with the pattern projects/{project}/locations/{location}/storagePools/{storage_pool}.

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

The StoragePool ID. Must not be null or empty.
Returns
Type Description
StoragePoolName

A new instance of StoragePoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static StoragePoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StoragePoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
storagePoolName string

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

The parsed StoragePoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/storagePools/{storage_pool}

Parse(string, bool)

public static StoragePoolName Parse(string storagePoolName, bool allowUnparsed)

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

Parameters
Name Description
storagePoolName 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
StoragePoolName

The parsed StoragePoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/storagePools/{storage_pool}
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 StoragePoolName)

public static bool TryParse(string storagePoolName, out StoragePoolName result)

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

Parameters
Name Description
storagePoolName string

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

When this method returns, the parsed StoragePoolName, 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}/storagePools/{storage_pool}

TryParse(string, bool, out StoragePoolName)

public static bool TryParse(string storagePoolName, bool allowUnparsed, out StoragePoolName result)

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

Parameters
Name Description
storagePoolName 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 StoragePoolName

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

Operators

operator ==(StoragePoolName, StoragePoolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a StoragePoolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a StoragePoolName

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

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.