Anthos Multi-Cloud v1 API - Class AzureClusterName (2.4.0)

public sealed class AzureClusterName : IResourceName, IEquatable<AzureClusterName>

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

Resource name for the AzureCluster resource.

Inheritance

object > AzureClusterName

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AzureClusterName(string, string, string)

public AzureClusterName(string projectId, string locationId, string azureClusterId)

Constructs a new instance of a AzureClusterName class from the component parts of pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

azureClusterIdstring

The AzureCluster ID. Must not be null or empty.

Properties

AzureClusterId

public string AzureClusterId { get; }

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

The AzureClusterName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AzureClusterNameResourceNameType

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

Formats the IDs into the string representation of this AzureClusterName with pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

azureClusterIdstring

The AzureCluster ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AzureClusterName with pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}.

FormatProjectLocationAzureCluster(string, string, string)

public static string FormatProjectLocationAzureCluster(string projectId, string locationId, string azureClusterId)

Formats the IDs into the string representation of this AzureClusterName with pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

azureClusterIdstring

The AzureCluster ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AzureClusterName with pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}.

FromProjectLocationAzureCluster(string, string, string)

public static AzureClusterName FromProjectLocationAzureCluster(string projectId, string locationId, string azureClusterId)

Creates a AzureClusterName with the pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

azureClusterIdstring

The AzureCluster ID. Must not be null or empty.

Returns
TypeDescription
AzureClusterName

A new instance of AzureClusterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AzureClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AzureClusterName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AzureClusterName

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

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

Parameter
NameDescription
azureClusterNamestring

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

Returns
TypeDescription
AzureClusterName

The parsed AzureClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/azureClusters/{azure_cluster}

Parse(string, bool)

public static AzureClusterName Parse(string azureClusterName, bool allowUnparsed)

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

Parameters
NameDescription
azureClusterNamestring

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
AzureClusterName

The parsed AzureClusterName if successful.

Remarks

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

  • projects/{project}/locations/{location}/azureClusters/{azure_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 AzureClusterName)

public static bool TryParse(string azureClusterName, out AzureClusterName result)

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

Parameters
NameDescription
azureClusterNamestring

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

resultAzureClusterName

When this method returns, the parsed AzureClusterName, 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}/azureClusters/{azure_cluster}

TryParse(string, bool, out AzureClusterName)

public static bool TryParse(string azureClusterName, bool allowUnparsed, out AzureClusterName result)

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

Parameters
NameDescription
azureClusterNamestring

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.

resultAzureClusterName

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

Operators

operator ==(AzureClusterName, AzureClusterName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aAzureClusterName

The first resource name to compare, or null.

bAzureClusterName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(AzureClusterName, AzureClusterName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aAzureClusterName

The first resource name to compare, or null.

bAzureClusterName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.