Anthos Multi-Cloud v1 API - Class AttachedServerConfigName (2.1.0)

public sealed class AttachedServerConfigName : IResourceName, IEquatable<AttachedServerConfigName>

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

Resource name for the AttachedServerConfig resource.

Inheritance

Object > AttachedServerConfigName

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AttachedServerConfigName(String, String)

public AttachedServerConfigName(string projectId, string locationId)

Constructs a new instance of a AttachedServerConfigName class from the component parts of pattern projects/{project}/locations/{location}/attachedServerConfig

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

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

The AttachedServerConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AttachedServerConfigName.ResourceNameType

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)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this AttachedServerConfigName with pattern projects/{project}/locations/{location}/attachedServerConfig.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AttachedServerConfigName with pattern projects/{project}/locations/{location}/attachedServerConfig.

FormatProjectLocation(String, String)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this AttachedServerConfigName with pattern projects/{project}/locations/{location}/attachedServerConfig.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AttachedServerConfigName with pattern projects/{project}/locations/{location}/attachedServerConfig.

FromProjectLocation(String, String)

public static AttachedServerConfigName FromProjectLocation(string projectId, string locationId)

Creates a AttachedServerConfigName with the pattern projects/{project}/locations/{location}/attachedServerConfig.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

Returns
TypeDescription
AttachedServerConfigName

A new instance of AttachedServerConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AttachedServerConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AttachedServerConfigName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AttachedServerConfigName

A new instance of AttachedServerConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static AttachedServerConfigName Parse(string attachedServerConfigName)

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

Parameter
NameDescription
attachedServerConfigNameString

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

Returns
TypeDescription
AttachedServerConfigName

The parsed AttachedServerConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/attachedServerConfig

Parse(String, Boolean)

public static AttachedServerConfigName Parse(string attachedServerConfigName, bool allowUnparsed)

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

Parameters
NameDescription
attachedServerConfigNameString

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

allowUnparsedBoolean

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
AttachedServerConfigName

The parsed AttachedServerConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/attachedServerConfig
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 AttachedServerConfigName)

public static bool TryParse(string attachedServerConfigName, out AttachedServerConfigName result)

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

Parameters
NameDescription
attachedServerConfigNameString

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

resultAttachedServerConfigName

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

Returns
TypeDescription
Boolean

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}/attachedServerConfig

TryParse(String, Boolean, out AttachedServerConfigName)

public static bool TryParse(string attachedServerConfigName, bool allowUnparsed, out AttachedServerConfigName result)

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

Parameters
NameDescription
attachedServerConfigNameString

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

allowUnparsedBoolean

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.

resultAttachedServerConfigName

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

Returns
TypeDescription
Boolean

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

Operators

Equality(AttachedServerConfigName, AttachedServerConfigName)

public static bool operator ==(AttachedServerConfigName a, AttachedServerConfigName b)
Parameters
NameDescription
aAttachedServerConfigName
bAttachedServerConfigName
Returns
TypeDescription
Boolean

Inequality(AttachedServerConfigName, AttachedServerConfigName)

public static bool operator !=(AttachedServerConfigName a, AttachedServerConfigName b)
Parameters
NameDescription
aAttachedServerConfigName
bAttachedServerConfigName
Returns
TypeDescription
Boolean