VMware Engine v1 API - Class NodeTypeName (1.0.0-beta02)

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, IEquatable<NodeTypeName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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

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
`NodeTypeName.ResourceNameType`

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

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

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`	`Boolean` 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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(NodeTypeName, NodeTypeName)

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

Parameters
Name	Description
`a`	`NodeTypeName`
`b`	`NodeTypeName`

Returns
Type	Description
`Boolean`

Inequality(NodeTypeName, NodeTypeName)

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

Parameters
Name	Description
`a`	`NodeTypeName`
`b`	`NodeTypeName`

Returns
Type	Description
`Boolean`