VMware Engine v1 API - Class NodeName (1.5.0)

public sealed class NodeName : IResourceName, IEquatable<NodeName>

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

Resource name for the Node resource.

Inheritance

object > NodeName

Implements

IResourceName, IEquatable NodeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.VmwareEngine.V1

Assembly

Google.Cloud.VmwareEngine.V1.dll

Constructors

NodeName(string, string, string, string, string)

public NodeName(string projectId, string locationId, string privateCloudId, string clusterId, string nodeId)

Constructs a new instance of a NodeName class from the component parts of pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

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.
`privateCloudId`	`string` The `PrivateCloud` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`nodeId`	`string` The `Node` ID. Must not be `null` or empty.

Properties

ClusterId

public string ClusterId { get; }

The Cluster 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`

NodeId

public string NodeId { get; }

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

Property Value
Type	Description
`string`

PrivateCloudId

public string PrivateCloudId { get; }

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

The NodeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NodeNameResourceNameType`

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

public static string Format(string projectId, string locationId, string privateCloudId, string clusterId, string nodeId)

Formats the IDs into the string representation of this NodeName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node} .

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.
`privateCloudId`	`string` The `PrivateCloud` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`nodeId`	`string` The `Node` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NodeName with pattern `projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}` .

FormatProjectLocationPrivateCloudClusterNode(string, string, string, string, string)

public static string FormatProjectLocationPrivateCloudClusterNode(string projectId, string locationId, string privateCloudId, string clusterId, string nodeId)

Formats the IDs into the string representation of this NodeName with pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node} .

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.
`privateCloudId`	`string` The `PrivateCloud` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`nodeId`	`string` The `Node` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NodeName with pattern `projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}` .

FromProjectLocationPrivateCloudClusterNode(string, string, string, string, string)

public static NodeName FromProjectLocationPrivateCloudClusterNode(string projectId, string locationId, string privateCloudId, string clusterId, string nodeId)

Creates a NodeName with the pattern projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node} .

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.
`privateCloudId`	`string` The `PrivateCloud` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`nodeId`	`string` The `Node` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static NodeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NodeName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

Parse(string, bool)

public static NodeName Parse(string nodeName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

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

public static bool TryParse(string nodeName, out NodeName result)

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

Parameters
Name	Description
`nodeName`	`string` The resource name in string form. Must not be `null`.
`result`	`NodeName` When this method returns, the parsed NodeName, 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}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

TryParse(string, bool, out NodeName)

public static bool TryParse(string nodeName, bool allowUnparsed, out NodeName result)

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

Parameters
Name	Description
`nodeName`	`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`	`NodeName` When this method returns, the parsed NodeName, 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}/privateClouds/{private_cloud}/clusters/{cluster}/nodes/{node}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NodeName, NodeName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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