NetApp v1 API - Class HostGroupName (1.14.0)

Version latest

• 1.14.0 (latest)
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 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 HostGroupName : IResourceName, IEquatable<HostGroupName>

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

Resource name for the HostGroup resource.

Inheritance

object > HostGroupName

Implements

IResourceName, IEquatableHostGroupName

Inherited Members

object.GetType()

Namespace

Google.Cloud.NetApp.V1

Assembly

Google.Cloud.NetApp.V1.dll

Constructors

HostGroupName(string, string, string)

public HostGroupName(string projectId, string locationId, string hostGroupId)

Constructs a new instance of a HostGroupName class from the component parts of pattern projects/{project}/locations/{location}/hostGroups/{host_group}

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.
hostGroupId	string The HostGroup ID. Must not be null or empty.

Properties

HostGroupId

public string HostGroupId { get; }

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

Property Value
Type	Description
string

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

The HostGroupName.ResourceNameType of the contained resource name.

Property Value
Type	Description
HostGroupNameResourceNameType

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

Formats the IDs into the string representation of this HostGroupName with pattern projects/{project}/locations/{location}/hostGroups/{host_group}.

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.
hostGroupId	string The HostGroup ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this HostGroupName with pattern projects/{project}/locations/{location}/hostGroups/{host_group}.

FormatProjectLocationHostGroup(string, string, string)

public static string FormatProjectLocationHostGroup(string projectId, string locationId, string hostGroupId)

Formats the IDs into the string representation of this HostGroupName with pattern projects/{project}/locations/{location}/hostGroups/{host_group}.

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.
hostGroupId	string The HostGroup ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this HostGroupName with pattern projects/{project}/locations/{location}/hostGroups/{host_group}.

FromProjectLocationHostGroup(string, string, string)

public static HostGroupName FromProjectLocationHostGroup(string projectId, string locationId, string hostGroupId)

Creates a HostGroupName with the pattern projects/{project}/locations/{location}/hostGroups/{host_group}.

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.
hostGroupId	string The HostGroup ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static HostGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HostGroupName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
HostGroupName	The parsed HostGroupName if successful.

Remarks

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

• projects/{project}/locations/{location}/hostGroups/{host_group}

Parse(string, bool)

public static HostGroupName Parse(string hostGroupName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/hostGroups/{host_group}

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

public static bool TryParse(string hostGroupName, out HostGroupName result)

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

Parameters
Name	Description
hostGroupName	string The resource name in string form. Must not be null.
result	HostGroupName When this method returns, the parsed HostGroupName, 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}/hostGroups/{host_group}

TryParse(string, bool, out HostGroupName)

public static bool TryParse(string hostGroupName, bool allowUnparsed, out HostGroupName result)

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

Parameters
Name	Description
hostGroupName	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	HostGroupName When this method returns, the parsed HostGroupName, 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}/hostGroups/{host_group}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(HostGroupName, HostGroupName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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