Anthos Multi-Cloud v1 API - Class AwsClusterName (2.9.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

Implements

IResourceName, IEquatable AwsClusterName

Inherited Members

object.GetType()

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
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.

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`

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 AwsClusterName.ResourceNameType Type { get; }

The AwsClusterName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AwsClusterNameResourceNameType`

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

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

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.

Returns
Type	Description
`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
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.

Returns
Type	Description
`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
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.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

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

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

Returns
Type	Description
`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
Name	Description
`awsClusterName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`awsClusterName`	`string` The resource name in string form. Must not be `null`.
`result`	`AwsClusterName` When this method returns, the parsed AwsClusterName, 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}

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
Name	Description
`awsClusterName`	`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`	`AwsClusterName` When this method returns, the parsed AwsClusterName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AwsClusterName, AwsClusterName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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

Anthos Multi-Cloud v1 API - Class AwsClusterName (2.9.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Namespace

Assembly

Constructors

AwsClusterName(string, string, string)

Properties

AwsClusterId

IsKnownPattern

LocationId

ProjectId

Type

UnparsedResource

Methods

Format(string, string, string)

FormatProjectLocationAwsCluster(string, string, string)

FromProjectLocationAwsCluster(string, string, string)

FromUnparsed(UnparsedResourceName)

GetHashCode()

Parse(string)

Parse(string, bool)

ToString()

TryParse(string, out AwsClusterName)

TryParse(string, bool, out AwsClusterName)

Operators

operator ==(AwsClusterName, AwsClusterName)

operator !=(AwsClusterName, AwsClusterName)

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