Bare Metal Solution v2 API - Class ProvisioningQuotaName (1.5.0)

public sealed class ProvisioningQuotaName : IResourceName, IEquatable<ProvisioningQuotaName>

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

Resource name for the ProvisioningQuota resource.

Inheritance

object > ProvisioningQuotaName

Namespace

Google.Cloud.BareMetalSolution.V2

Assembly

Google.Cloud.BareMetalSolution.V2.dll

Constructors

ProvisioningQuotaName(string, string, string)

public ProvisioningQuotaName(string projectId, string locationId, string provisioningQuotaId)

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

provisioningQuotaId string

The ProvisioningQuota 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
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

ProvisioningQuotaId

public string ProvisioningQuotaId { get; }

The ProvisioningQuota ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public ProvisioningQuotaName.ResourceNameType Type { get; }

The ProvisioningQuotaName.ResourceNameType of the contained resource name.

Property Value
Type Description
ProvisioningQuotaNameResourceNameType

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

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

provisioningQuotaId string

The ProvisioningQuota ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ProvisioningQuotaName with pattern projects/{project}/locations/{location}/provisioningQuotas/{provisioning_quota}.

FormatProjectLocationProvisioningQuota(string, string, string)

public static string FormatProjectLocationProvisioningQuota(string projectId, string locationId, string provisioningQuotaId)

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

provisioningQuotaId string

The ProvisioningQuota ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ProvisioningQuotaName with pattern projects/{project}/locations/{location}/provisioningQuotas/{provisioning_quota}.

FromProjectLocationProvisioningQuota(string, string, string)

public static ProvisioningQuotaName FromProjectLocationProvisioningQuota(string projectId, string locationId, string provisioningQuotaId)

Creates a ProvisioningQuotaName with the pattern projects/{project}/locations/{location}/provisioningQuotas/{provisioning_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.

provisioningQuotaId string

The ProvisioningQuota ID. Must not be null or empty.

Returns
Type Description
ProvisioningQuotaName

A new instance of ProvisioningQuotaName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProvisioningQuotaName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProvisioningQuotaName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ProvisioningQuotaName

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

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

Parameter
Name Description
provisioningQuotaName string

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

Returns
Type Description
ProvisioningQuotaName

The parsed ProvisioningQuotaName if successful.

Remarks

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

  • projects/{project}/locations/{location}/provisioningQuotas/{provisioning_quota}

Parse(string, bool)

public static ProvisioningQuotaName Parse(string provisioningQuotaName, bool allowUnparsed)

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

Parameters
Name Description
provisioningQuotaName 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
ProvisioningQuotaName

The parsed ProvisioningQuotaName if successful.

Remarks

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

  • projects/{project}/locations/{location}/provisioningQuotas/{provisioning_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 ProvisioningQuotaName)

public static bool TryParse(string provisioningQuotaName, out ProvisioningQuotaName result)

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

Parameters
Name Description
provisioningQuotaName string

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

result ProvisioningQuotaName

When this method returns, the parsed ProvisioningQuotaName, 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}/provisioningQuotas/{provisioning_quota}

TryParse(string, bool, out ProvisioningQuotaName)

public static bool TryParse(string provisioningQuotaName, bool allowUnparsed, out ProvisioningQuotaName result)

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

Parameters
Name Description
provisioningQuotaName 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 ProvisioningQuotaName

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

Operators

operator ==(ProvisioningQuotaName, ProvisioningQuotaName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ProvisioningQuotaName

The first resource name to compare, or null.

b ProvisioningQuotaName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ProvisioningQuotaName

The first resource name to compare, or null.

b ProvisioningQuotaName

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.