Anthos Multi-Cloud v1 API - Class AwsNodePoolName (2.9.0) 

public sealed class AwsNodePoolName : IResourceName, IEquatable<AwsNodePoolName>

Reference documentation and code samples for the Anthos Multi-Cloud v1 API class AwsNodePoolName.

Resource name for the AwsNodePool resource.

Inheritance

object > AwsNodePoolName

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AwsNodePoolName(string, string, string, string)

public AwsNodePoolName(string projectId, string locationId, string awsClusterId, string awsNodePoolId)

Constructs a new instance of a AwsNodePoolName class from the component parts of pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_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.
awsClusterId string

The AwsCluster ID. Must not be null or empty.
awsNodePoolId string

The AwsNodePool ID. Must not be null or empty.

Properties

AwsClusterId

public string AwsClusterId { get; }

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

Property Value
Type Description
string

AwsNodePoolId

public string AwsNodePoolId { get; }

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

The AwsNodePoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
AwsNodePoolNameResourceNameType

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)

public static string Format(string projectId, string locationId, string awsClusterId, string awsNodePoolId)

Formats the IDs into the string representation of this AwsNodePoolName with pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_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.
awsClusterId string

The AwsCluster ID. Must not be null or empty.
awsNodePoolId string

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

The string representation of this AwsNodePoolName with pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_pool}.

FormatProjectLocationAwsClusterAwsNodePool(string, string, string, string)

public static string FormatProjectLocationAwsClusterAwsNodePool(string projectId, string locationId, string awsClusterId, string awsNodePoolId)

Formats the IDs into the string representation of this AwsNodePoolName with pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_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.
awsClusterId string

The AwsCluster ID. Must not be null or empty.
awsNodePoolId string

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

The string representation of this AwsNodePoolName with pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_pool}.

FromProjectLocationAwsClusterAwsNodePool(string, string, string, string)

public static AwsNodePoolName FromProjectLocationAwsClusterAwsNodePool(string projectId, string locationId, string awsClusterId, string awsNodePoolId)

Creates a AwsNodePoolName with the pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_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.
awsClusterId string

The AwsCluster ID. Must not be null or empty.
awsNodePoolId string

The AwsNodePool ID. Must not be null or empty.
Returns
Type Description
AwsNodePoolName

A new instance of AwsNodePoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AwsNodePoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AwsNodePoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
awsNodePoolName string

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

The parsed AwsNodePoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_pool}

Parse(string, bool)

public static AwsNodePoolName Parse(string awsNodePoolName, bool allowUnparsed)

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

Parameters
Name Description
awsNodePoolName 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
AwsNodePoolName

The parsed AwsNodePoolName if successful.
Remarks

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

  • projects/{project}/locations/{location}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_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 AwsNodePoolName)

public static bool TryParse(string awsNodePoolName, out AwsNodePoolName result)

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

Parameters
Name Description
awsNodePoolName string

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

When this method returns, the parsed AwsNodePoolName, 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}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_pool}

TryParse(string, bool, out AwsNodePoolName)

public static bool TryParse(string awsNodePoolName, bool allowUnparsed, out AwsNodePoolName result)

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

Parameters
Name Description
awsNodePoolName 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 AwsNodePoolName

When this method returns, the parsed AwsNodePoolName, 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}/awsClusters/{aws_cluster}/awsNodePools/{aws_node_pool}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AwsNodePoolName, AwsNodePoolName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AwsNodePoolName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AwsNodePoolName

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

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.