Cloud Quotas v1 API - Class QuotaInfoName (1.0.0-beta05)

public sealed class QuotaInfoName : IResourceName, IEquatable<QuotaInfoName>

Reference documentation and code samples for the Cloud Quotas v1 API class QuotaInfoName.

Resource name for the QuotaInfo resource.

Inheritance

object > QuotaInfoName

Implements

IResourceName, IEquatable QuotaInfoName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudQuotas.V1

Assembly

Google.Cloud.CloudQuotas.V1.dll

Constructors

QuotaInfoName(string, string, string, string)

public QuotaInfoName(string projectId, string locationId, string serviceId, string quotaInfoId)

Constructs a new instance of a QuotaInfoName class from the component parts of pattern projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}

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.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.
`quotaInfoId`	`string` The `QuotaInfo` ID. Must not be `null` or empty.

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

QuotaInfoId

public string QuotaInfoId { get; }

The QuotaInfo ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ServiceId

public string ServiceId { get; }

The Service ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public QuotaInfoName.ResourceNameType Type { get; }

The QuotaInfoName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`QuotaInfoNameResourceNameType`

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, string)

public static string Format(string projectId, string locationId, string serviceId, string quotaInfoId)

Formats the IDs into the string representation of this QuotaInfoName with pattern projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}.

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.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.
`quotaInfoId`	`string` The `QuotaInfo` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this QuotaInfoName with pattern `projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}`.

FormatFolderLocationServiceQuotaInfo(string, string, string, string)

public static string FormatFolderLocationServiceQuotaInfo(string folderId, string locationId, string serviceId, string quotaInfoId)

Formats the IDs into the string representation of this QuotaInfoName with pattern folders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.
`quotaInfoId`	`string` The `QuotaInfo` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this QuotaInfoName with pattern `folders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}`.

FormatOrganizationLocationServiceQuotaInfo(string, string, string, string)

public static string FormatOrganizationLocationServiceQuotaInfo(string organizationId, string locationId, string serviceId, string quotaInfoId)

Formats the IDs into the string representation of this QuotaInfoName with pattern organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.
`quotaInfoId`	`string` The `QuotaInfo` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this QuotaInfoName with pattern `organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}`.

FormatProjectLocationServiceQuotaInfo(string, string, string, string)

public static string FormatProjectLocationServiceQuotaInfo(string projectId, string locationId, string serviceId, string quotaInfoId)

Formats the IDs into the string representation of this QuotaInfoName with pattern projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}.

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.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.
`quotaInfoId`	`string` The `QuotaInfo` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this QuotaInfoName with pattern `projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}`.

FromFolderLocationServiceQuotaInfo(string, string, string, string)

public static QuotaInfoName FromFolderLocationServiceQuotaInfo(string folderId, string locationId, string serviceId, string quotaInfoId)

Creates a QuotaInfoName with the pattern folders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.
`quotaInfoId`	`string` The `QuotaInfo` ID. Must not be `null` or empty.

Returns
Type	Description
`QuotaInfoName`	A new instance of QuotaInfoName constructed from the provided ids.

FromOrganizationLocationServiceQuotaInfo(string, string, string, string)

public static QuotaInfoName FromOrganizationLocationServiceQuotaInfo(string organizationId, string locationId, string serviceId, string quotaInfoId)

Creates a QuotaInfoName with the pattern organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.
`quotaInfoId`	`string` The `QuotaInfo` ID. Must not be `null` or empty.

Returns
Type	Description
`QuotaInfoName`	A new instance of QuotaInfoName constructed from the provided ids.

FromProjectLocationServiceQuotaInfo(string, string, string, string)

public static QuotaInfoName FromProjectLocationServiceQuotaInfo(string projectId, string locationId, string serviceId, string quotaInfoId)

Creates a QuotaInfoName with the pattern projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}.

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.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.
`quotaInfoId`	`string` The `QuotaInfo` ID. Must not be `null` or empty.

Returns
Type	Description
`QuotaInfoName`	A new instance of QuotaInfoName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static QuotaInfoName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a QuotaInfoName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`QuotaInfoName`	A new instance of QuotaInfoName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static QuotaInfoName Parse(string quotaInfoName)

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

Parameter
Name	Description
`quotaInfoName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`QuotaInfoName`	The parsed QuotaInfoName if successful.

Remarks

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

projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}
folders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}
organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}

Parse(string, bool)

public static QuotaInfoName Parse(string quotaInfoName, bool allowUnparsed)

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

Parameters
Name	Description
`quotaInfoName`	`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
`QuotaInfoName`	The parsed QuotaInfoName if successful.

Remarks

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

projects/{project}/locations/{location}/services/{service}/quotaInfos/{quota_info}
folders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}
organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}

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

object.ToString()

TryParse(string, out QuotaInfoName)

public static bool TryParse(string quotaInfoName, out QuotaInfoName result)

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

Parameters
Name	Description
`quotaInfoName`	`string` The resource name in string form. Must not be `null`.
`result`	`QuotaInfoName` When this method returns, the parsed QuotaInfoName, 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}/services/{service}/quotaInfos/{quota_info}
folders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}
organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}

TryParse(string, bool, out QuotaInfoName)

public static bool TryParse(string quotaInfoName, bool allowUnparsed, out QuotaInfoName result)

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

Parameters
Name	Description
`quotaInfoName`	`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`	`QuotaInfoName` When this method returns, the parsed QuotaInfoName, 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}/services/{service}/quotaInfos/{quota_info}
folders/{folder}/locations/{location}/services/{service}/quotaInfos/{quota_info}
organizations/{organization}/locations/{location}/services/{service}/quotaInfos/{quota_info}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(QuotaInfoName, QuotaInfoName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`QuotaInfoName` The first resource name to compare, or null.
`b`	`QuotaInfoName` 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 !=(QuotaInfoName, QuotaInfoName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`QuotaInfoName` The first resource name to compare, or null.
`b`	`QuotaInfoName` 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.