Anthos Multi-Cloud v1 API - Class AttachedClusterName (2.7.0)

public sealed class AttachedClusterName : IResourceName, IEquatable<AttachedClusterName>

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

Resource name for the AttachedCluster resource.

Inheritance

object > AttachedClusterName

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AttachedClusterName(string, string, string)

public AttachedClusterName(string projectId, string locationId, string attachedClusterId)

Constructs a new instance of a AttachedClusterName class from the component parts of pattern projects/{project}/locations/{location}/attachedClusters/{attached_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.

attachedClusterId string

The AttachedCluster ID. Must not be null or empty.

Properties

AttachedClusterId

public string AttachedClusterId { get; }

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

The AttachedClusterName.ResourceNameType of the contained resource name.

Property Value
Type Description
AttachedClusterNameResourceNameType

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

Formats the IDs into the string representation of this AttachedClusterName with pattern projects/{project}/locations/{location}/attachedClusters/{attached_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.

attachedClusterId string

The AttachedCluster ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AttachedClusterName with pattern projects/{project}/locations/{location}/attachedClusters/{attached_cluster}.

FormatProjectLocationAttachedCluster(string, string, string)

public static string FormatProjectLocationAttachedCluster(string projectId, string locationId, string attachedClusterId)

Formats the IDs into the string representation of this AttachedClusterName with pattern projects/{project}/locations/{location}/attachedClusters/{attached_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.

attachedClusterId string

The AttachedCluster ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this AttachedClusterName with pattern projects/{project}/locations/{location}/attachedClusters/{attached_cluster}.

FromProjectLocationAttachedCluster(string, string, string)

public static AttachedClusterName FromProjectLocationAttachedCluster(string projectId, string locationId, string attachedClusterId)

Creates a AttachedClusterName with the pattern projects/{project}/locations/{location}/attachedClusters/{attached_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.

attachedClusterId string

The AttachedCluster ID. Must not be null or empty.

Returns
Type Description
AttachedClusterName

A new instance of AttachedClusterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AttachedClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AttachedClusterName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
AttachedClusterName

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

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

Parameter
Name Description
attachedClusterName string

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

Returns
Type Description
AttachedClusterName

The parsed AttachedClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/attachedClusters/{attached_cluster}

Parse(string, bool)

public static AttachedClusterName Parse(string attachedClusterName, bool allowUnparsed)

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

Parameters
Name Description
attachedClusterName 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
AttachedClusterName

The parsed AttachedClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/attachedClusters/{attached_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

TryParse(string, out AttachedClusterName)

public static bool TryParse(string attachedClusterName, out AttachedClusterName result)

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

Parameters
Name Description
attachedClusterName string

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

result AttachedClusterName

When this method returns, the parsed AttachedClusterName, 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}/attachedClusters/{attached_cluster}

TryParse(string, bool, out AttachedClusterName)

public static bool TryParse(string attachedClusterName, bool allowUnparsed, out AttachedClusterName result)

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

Parameters
Name Description
attachedClusterName 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 AttachedClusterName

When this method returns, the parsed AttachedClusterName, 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}/attachedClusters/{attached_cluster}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AttachedClusterName, AttachedClusterName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AttachedClusterName

The first resource name to compare, or null.

b AttachedClusterName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AttachedClusterName

The first resource name to compare, or null.

b AttachedClusterName

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.