Anthos Multi-Cloud v1 API - Class AwsClusterName (2.3.0)

public sealed class AwsClusterName : IResourceName, IEquatable<AwsClusterName>

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

Resource name for the AwsCluster resource.

Inheritance

object > AwsClusterName

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AwsClusterName(string, string, string)

public AwsClusterName(string projectId, string locationId, string awsClusterId)

Constructs a new instance of a AwsClusterName class from the component parts of pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

awsClusterIdstring

The AwsCluster 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
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public AwsClusterName.ResourceNameType Type { get; }

The AwsClusterName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AwsClusterNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this AwsClusterName with pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

awsClusterIdstring

The AwsCluster ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationAwsCluster(string, string, string)

public static string FormatProjectLocationAwsCluster(string projectId, string locationId, string awsClusterId)

Formats the IDs into the string representation of this AwsClusterName with pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

awsClusterIdstring

The AwsCluster ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationAwsCluster(string, string, string)

public static AwsClusterName FromProjectLocationAwsCluster(string projectId, string locationId, string awsClusterId)

Creates a AwsClusterName with the pattern projects/{project}/locations/{location}/awsClusters/{aws_cluster}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

awsClusterIdstring

The AwsCluster ID. Must not be null or empty.

Returns
TypeDescription
AwsClusterName

A new instance of AwsClusterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AwsClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AwsClusterName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AwsClusterName

A new instance of AwsClusterName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static AwsClusterName Parse(string awsClusterName)

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

Parameter
NameDescription
awsClusterNamestring

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

Returns
TypeDescription
AwsClusterName

The parsed AwsClusterName if successful.

Remarks

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

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

Parse(string, bool)

public static AwsClusterName Parse(string awsClusterName, bool allowUnparsed)

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

Parameters
NameDescription
awsClusterNamestring

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

allowUnparsedbool

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
TypeDescription
AwsClusterName

The parsed AwsClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/awsClusters/{aws_cluster}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out AwsClusterName)

public static bool TryParse(string awsClusterName, out AwsClusterName result)

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

Parameters
NameDescription
awsClusterNamestring

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

resultAwsClusterName

When this method returns, the parsed AwsClusterName, or null if parsing failed.

Returns
TypeDescription
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}

TryParse(string, bool, out AwsClusterName)

public static bool TryParse(string awsClusterName, bool allowUnparsed, out AwsClusterName result)

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

Parameters
NameDescription
awsClusterNamestring

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

allowUnparsedbool

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.

resultAwsClusterName

When this method returns, the parsed AwsClusterName, or null if parsing failed.

Returns
TypeDescription
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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AwsClusterName, AwsClusterName)

public static bool operator ==(AwsClusterName a, AwsClusterName b)
Parameters
NameDescription
aAwsClusterName
bAwsClusterName
Returns
TypeDescription
bool

operator !=(AwsClusterName, AwsClusterName)

public static bool operator !=(AwsClusterName a, AwsClusterName b)
Parameters
NameDescription
aAwsClusterName
bAwsClusterName
Returns
TypeDescription
bool