VMware Engine v1 API - Class NodeTypeName (1.6.0)

Version latest

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class NodeTypeName : IResourceName, IEquatable<NodeTypeName>

Reference documentation and code samples for the VMware Engine v1 API class NodeTypeName.

Resource name for the NodeType resource.

Inheritance

object > NodeTypeName

Implements

IResourceName, IEquatableNodeTypeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

NodeTypeName(string, string, string)

public NodeTypeName(string projectId, string locationId, string nodeTypeId)

Constructs a new instance of a NodeTypeName class from the component parts of pattern projects/{project}/locations/{location}/nodeTypes/{node_type}

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.
nodeTypeId	string The NodeType 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

NodeTypeId

public string NodeTypeId { get; }

The NodeType 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 NodeTypeName.ResourceNameType Type { get; }

The NodeTypeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
NodeTypeNameResourceNameType

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

Formats the IDs into the string representation of this NodeTypeName with pattern projects/{project}/locations/{location}/nodeTypes/{node_type}.

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

Returns
Type	Description
string	The string representation of this NodeTypeName with pattern projects/{project}/locations/{location}/nodeTypes/{node_type}.

FormatProjectLocationNodeType(string, string, string)

public static string FormatProjectLocationNodeType(string projectId, string locationId, string nodeTypeId)

Formats the IDs into the string representation of this NodeTypeName with pattern projects/{project}/locations/{location}/nodeTypes/{node_type}.

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

Returns
Type	Description
string	The string representation of this NodeTypeName with pattern projects/{project}/locations/{location}/nodeTypes/{node_type}.

FromProjectLocationNodeType(string, string, string)

public static NodeTypeName FromProjectLocationNodeType(string projectId, string locationId, string nodeTypeId)

Creates a NodeTypeName with the pattern projects/{project}/locations/{location}/nodeTypes/{node_type}.

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

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

FromUnparsed(UnparsedResourceName)

public static NodeTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NodeTypeName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
NodeTypeName	The parsed NodeTypeName if successful.

Remarks

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

• projects/{project}/locations/{location}/nodeTypes/{node_type}

Parse(string, bool)

public static NodeTypeName Parse(string nodeTypeName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/nodeTypes/{node_type}

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

public static bool TryParse(string nodeTypeName, out NodeTypeName result)

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

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

TryParse(string, bool, out NodeTypeName)

public static bool TryParse(string nodeTypeName, bool allowUnparsed, out NodeTypeName result)

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

Parameters
Name	Description
nodeTypeName	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	NodeTypeName When this method returns, the parsed NodeTypeName, 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}/nodeTypes/{node_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NodeTypeName, NodeTypeName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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