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

public sealed class AwsServerConfigName : IResourceName, IEquatable<AwsServerConfigName>

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

Resource name for the AwsServerConfig resource.

Inheritance

object > AwsServerConfigName

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AwsServerConfigName(string, string)

public AwsServerConfigName(string projectId, string locationId)

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

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

The AwsServerConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AwsServerConfigNameResourceNameType

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 AwsServerConfigName with pattern projects/{project}/locations/{location}/awsServerConfig.

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 AwsServerConfigName with pattern projects/{project}/locations/{location}/awsServerConfig.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

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

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 AwsServerConfigName with pattern projects/{project}/locations/{location}/awsServerConfig.

FromProjectLocation(string, string)

public static AwsServerConfigName FromProjectLocation(string projectId, string locationId)

Creates a AwsServerConfigName with the pattern projects/{project}/locations/{location}/awsServerConfig.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
AwsServerConfigName

A new instance of AwsServerConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AwsServerConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AwsServerConfigName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AwsServerConfigName

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

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

Parameter
NameDescription
awsServerConfigNamestring

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

Returns
TypeDescription
AwsServerConfigName

The parsed AwsServerConfigName if successful.

Remarks

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

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

Parse(string, bool)

public static AwsServerConfigName Parse(string awsServerConfigName, bool allowUnparsed)

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

Parameters
NameDescription
awsServerConfigNamestring

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
AwsServerConfigName

The parsed AwsServerConfigName if successful.

Remarks

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

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

public static bool TryParse(string awsServerConfigName, out AwsServerConfigName result)

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

Parameters
NameDescription
awsServerConfigNamestring

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

resultAwsServerConfigName

When this method returns, the parsed AwsServerConfigName, 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}/awsServerConfig

TryParse(string, bool, out AwsServerConfigName)

public static bool TryParse(string awsServerConfigName, bool allowUnparsed, out AwsServerConfigName result)

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

Parameters
NameDescription
awsServerConfigNamestring

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.

resultAwsServerConfigName

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

Operators

operator ==(AwsServerConfigName, AwsServerConfigName)

public static bool operator ==(AwsServerConfigName a, AwsServerConfigName b)
Parameters
NameDescription
aAwsServerConfigName
bAwsServerConfigName
Returns
TypeDescription
bool

operator !=(AwsServerConfigName, AwsServerConfigName)

public static bool operator !=(AwsServerConfigName a, AwsServerConfigName b)
Parameters
NameDescription
aAwsServerConfigName
bAwsServerConfigName
Returns
TypeDescription
bool