Cloud Quotas v1 API - Class QuotaPreferenceName (1.1.0)

public sealed class QuotaPreferenceName : IResourceName, IEquatable<QuotaPreferenceName>

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

Resource name for the QuotaPreference resource.

Inheritance

object > QuotaPreferenceName

Implements

IResourceName, IEquatable QuotaPreferenceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.CloudQuotas.V1

Assembly

Google.Cloud.CloudQuotas.V1.dll

Constructors

QuotaPreferenceName(string, string, string)

public QuotaPreferenceName(string projectId, string locationId, string quotaPreferenceId)

Constructs a new instance of a QuotaPreferenceName class from the component parts of pattern projects/{project}/locations/{location}/quotaPreferences/{quota_preference}

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.
`quotaPreferenceId`	`string` The `QuotaPreference` 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`

QuotaPreferenceId

public string QuotaPreferenceId { get; }

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

Property Value
Type	Description
`string`

Type

public QuotaPreferenceName.ResourceNameType Type { get; }

The QuotaPreferenceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`QuotaPreferenceNameResourceNameType`

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

Formats the IDs into the string representation of this QuotaPreferenceName with pattern projects/{project}/locations/{location}/quotaPreferences/{quota_preference}.

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.
`quotaPreferenceId`	`string` The `QuotaPreference` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this QuotaPreferenceName with pattern `projects/{project}/locations/{location}/quotaPreferences/{quota_preference}`.

FormatFolderLocationQuotaPreference(string, string, string)

public static string FormatFolderLocationQuotaPreference(string folderId, string locationId, string quotaPreferenceId)

Formats the IDs into the string representation of this QuotaPreferenceName with pattern folders/{folder}/locations/{location}/quotaPreferences/{quota_preference}.

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.
`quotaPreferenceId`	`string` The `QuotaPreference` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this QuotaPreferenceName with pattern `folders/{folder}/locations/{location}/quotaPreferences/{quota_preference}`.

FormatOrganizationLocationQuotaPreference(string, string, string)

public static string FormatOrganizationLocationQuotaPreference(string organizationId, string locationId, string quotaPreferenceId)

Formats the IDs into the string representation of this QuotaPreferenceName with pattern organizations/{organization}/locations/{location}/quotaPreferences/{quota_preference}.

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.
`quotaPreferenceId`	`string` The `QuotaPreference` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this QuotaPreferenceName with pattern `organizations/{organization}/locations/{location}/quotaPreferences/{quota_preference}`.

FormatProjectLocationQuotaPreference(string, string, string)

public static string FormatProjectLocationQuotaPreference(string projectId, string locationId, string quotaPreferenceId)

Formats the IDs into the string representation of this QuotaPreferenceName with pattern projects/{project}/locations/{location}/quotaPreferences/{quota_preference}.

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.
`quotaPreferenceId`	`string` The `QuotaPreference` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this QuotaPreferenceName with pattern `projects/{project}/locations/{location}/quotaPreferences/{quota_preference}`.

FromFolderLocationQuotaPreference(string, string, string)

public static QuotaPreferenceName FromFolderLocationQuotaPreference(string folderId, string locationId, string quotaPreferenceId)

Creates a QuotaPreferenceName with the pattern folders/{folder}/locations/{location}/quotaPreferences/{quota_preference}.

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.
`quotaPreferenceId`	`string` The `QuotaPreference` ID. Must not be `null` or empty.

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

FromOrganizationLocationQuotaPreference(string, string, string)

public static QuotaPreferenceName FromOrganizationLocationQuotaPreference(string organizationId, string locationId, string quotaPreferenceId)

Creates a QuotaPreferenceName with the pattern organizations/{organization}/locations/{location}/quotaPreferences/{quota_preference}.

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.
`quotaPreferenceId`	`string` The `QuotaPreference` ID. Must not be `null` or empty.

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

FromProjectLocationQuotaPreference(string, string, string)

public static QuotaPreferenceName FromProjectLocationQuotaPreference(string projectId, string locationId, string quotaPreferenceId)

Creates a QuotaPreferenceName with the pattern projects/{project}/locations/{location}/quotaPreferences/{quota_preference}.

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.
`quotaPreferenceId`	`string` The `QuotaPreference` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static QuotaPreferenceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a QuotaPreferenceName containing an unparsed resource name.

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

Returns
Type	Description
`QuotaPreferenceName`	A new instance of QuotaPreferenceName 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 QuotaPreferenceName Parse(string quotaPreferenceName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/quotaPreferences/{quota_preference}
folders/{folder}/locations/{location}/quotaPreferences/{quota_preference}
organizations/{organization}/locations/{location}/quotaPreferences/{quota_preference}

Parse(string, bool)

public static QuotaPreferenceName Parse(string quotaPreferenceName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/quotaPreferences/{quota_preference}
folders/{folder}/locations/{location}/quotaPreferences/{quota_preference}
organizations/{organization}/locations/{location}/quotaPreferences/{quota_preference}

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

public static bool TryParse(string quotaPreferenceName, out QuotaPreferenceName result)

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

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

TryParse(string, bool, out QuotaPreferenceName)

public static bool TryParse(string quotaPreferenceName, bool allowUnparsed, out QuotaPreferenceName result)

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

Parameters
Name	Description
`quotaPreferenceName`	`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`	`QuotaPreferenceName` When this method returns, the parsed QuotaPreferenceName, 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}/quotaPreferences/{quota_preference}
folders/{folder}/locations/{location}/quotaPreferences/{quota_preference}
organizations/{organization}/locations/{location}/quotaPreferences/{quota_preference}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(QuotaPreferenceName, QuotaPreferenceName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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