Bare Metal Solution v2 API - Class InstanceQuotaName (1.6.0)

public sealed class InstanceQuotaName : IResourceName, IEquatable<InstanceQuotaName>

Reference documentation and code samples for the Bare Metal Solution v2 API class InstanceQuotaName.

Resource name for the InstanceQuota resource.

Inheritance

object > InstanceQuotaName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

InstanceQuotaName(string, string, string)

public InstanceQuotaName(string projectId, string locationId, string instanceQuotaId)

Constructs a new instance of a InstanceQuotaName class from the component parts of pattern projects/{project}/locations/{location}/instanceQuotas/{instance_quota}

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.

instanceQuotaId string

The InstanceQuota ID. Must not be null or empty.

Properties

InstanceQuotaId

public string InstanceQuotaId { get; }

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

The InstanceQuotaName.ResourceNameType of the contained resource name.

Property Value
Type Description
InstanceQuotaNameResourceNameType

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

Formats the IDs into the string representation of this InstanceQuotaName with pattern projects/{project}/locations/{location}/instanceQuotas/{instance_quota}.

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.

instanceQuotaId string

The InstanceQuota ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this InstanceQuotaName with pattern projects/{project}/locations/{location}/instanceQuotas/{instance_quota}.

FormatProjectLocationInstanceQuota(string, string, string)

public static string FormatProjectLocationInstanceQuota(string projectId, string locationId, string instanceQuotaId)

Formats the IDs into the string representation of this InstanceQuotaName with pattern projects/{project}/locations/{location}/instanceQuotas/{instance_quota}.

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.

instanceQuotaId string

The InstanceQuota ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this InstanceQuotaName with pattern projects/{project}/locations/{location}/instanceQuotas/{instance_quota}.

FromProjectLocationInstanceQuota(string, string, string)

public static InstanceQuotaName FromProjectLocationInstanceQuota(string projectId, string locationId, string instanceQuotaId)

Creates a InstanceQuotaName with the pattern projects/{project}/locations/{location}/instanceQuotas/{instance_quota}.

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.

instanceQuotaId string

The InstanceQuota ID. Must not be null or empty.

Returns
Type Description
InstanceQuotaName

A new instance of InstanceQuotaName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InstanceQuotaName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstanceQuotaName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
InstanceQuotaName

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

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

Parameter
Name Description
instanceQuotaName string

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

Returns
Type Description
InstanceQuotaName

The parsed InstanceQuotaName if successful.

Remarks

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

  • projects/{project}/locations/{location}/instanceQuotas/{instance_quota}

Parse(string, bool)

public static InstanceQuotaName Parse(string instanceQuotaName, bool allowUnparsed)

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

Parameters
Name Description
instanceQuotaName 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
InstanceQuotaName

The parsed InstanceQuotaName if successful.

Remarks

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

  • projects/{project}/locations/{location}/instanceQuotas/{instance_quota}
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 InstanceQuotaName)

public static bool TryParse(string instanceQuotaName, out InstanceQuotaName result)

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

Parameters
Name Description
instanceQuotaName string

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

result InstanceQuotaName

When this method returns, the parsed InstanceQuotaName, 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}/instanceQuotas/{instance_quota}

TryParse(string, bool, out InstanceQuotaName)

public static bool TryParse(string instanceQuotaName, bool allowUnparsed, out InstanceQuotaName result)

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

Parameters
Name Description
instanceQuotaName 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 InstanceQuotaName

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

Operators

operator ==(InstanceQuotaName, InstanceQuotaName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a InstanceQuotaName

The first resource name to compare, or null.

b InstanceQuotaName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a InstanceQuotaName

The first resource name to compare, or null.

b InstanceQuotaName

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.