Bare Metal Solution v2 API - Class ProvisioningQuotaName (1.3.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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

provisioningQuotaIdstring

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

ProvisioningQuotaId

public string ProvisioningQuotaId { get; }

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

Property Value
TypeDescription
string

Type

public ProvisioningQuotaName.ResourceNameType Type { get; }

The ProvisioningQuotaName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProvisioningQuotaNameResourceNameType

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

Formats the IDs into the string representation of this ProvisioningQuotaName with pattern projects/{project}/locations/{location}/provisioningQuotas/{provisioning_quota}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

provisioningQuotaIdstring

The ProvisioningQuota ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

provisioningQuotaIdstring

The ProvisioningQuota ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

provisioningQuotaIdstring

The ProvisioningQuota ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProvisioningQuotaName

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

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

Parameter
NameDescription
provisioningQuotaNamestring

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

Returns
TypeDescription
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
NameDescription
provisioningQuotaNamestring

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
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
TypeDescription
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
NameDescription
provisioningQuotaNamestring

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

resultProvisioningQuotaName

When this method returns, the parsed ProvisioningQuotaName, 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}/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
NameDescription
provisioningQuotaNamestring

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.

resultProvisioningQuotaName

When this method returns, the parsed ProvisioningQuotaName, 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}/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)
Parameters
NameDescription
aProvisioningQuotaName
bProvisioningQuotaName
Returns
TypeDescription
bool

operator !=(ProvisioningQuotaName, ProvisioningQuotaName)

public static bool operator !=(ProvisioningQuotaName a, ProvisioningQuotaName b)
Parameters
NameDescription
aProvisioningQuotaName
bProvisioningQuotaName
Returns
TypeDescription
bool