ErrorReason class

Defines the supported values for google.rpc.ErrorInfo.reason for the googleapis.com error domain. This error domain is reserved for Service Infrastructure. For each error info of this domain, the metadata key "service" refers to the logical identifier of an API service, such as "pubsub.googleapis.com". The "consumer" refers to the entity that consumes an API Service. It typically is a Google project that owns the client application or the server resource, such as "projects/123". Other metadata keys are specific to each error reason. For more information, see the definition of the specific error reason.

Inheritance

Object
ProtobufEnum
ErrorReason

Properties

hashCode → int: The hash code for this object.
no setterinherited
name → String: This enum's name, as specified in the .proto file.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
value → int: This enum's integer value, as specified in the .proto file.
finalinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: Returns this enum's name or the value if names are not represented.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

valueOf(int value) → ErrorReason?

Constants

ACCESS_TOKEN_EXPIRED → const ErrorReason: The request is denied because the provided access token has expired.
ACCESS_TOKEN_SCOPE_INSUFFICIENT → const ErrorReason: The request is denied because the provided access token doesn't have at least one of the acceptable scopes required for the API. Please check OAuth 2.0 Scopes for Google APIs for the list of the OAuth 2.0 scopes that you might need to request to access the API.
ACCESS_TOKEN_TYPE_UNSUPPORTED → const ErrorReason: The request is denied because the type of the provided access token is not supported by the API being called.
ACCOUNT_STATE_INVALID → const ErrorReason: The request is denied because the account associated with the provided access token is in an invalid state, such as disabled or deleted. For more information, see https://cloud.google.com/docs/authentication.
API_KEY_ANDROID_APP_BLOCKED → const ErrorReason: The request is denied because it violates API key Android application restrictions.
API_KEY_HTTP_REFERRER_BLOCKED → const ErrorReason: The request is denied because it violates API key HTTP restrictions.
API_KEY_INVALID → const ErrorReason: The request is denied because the provided API key is invalid. It may be in a bad format, cannot be found, or has been expired).
API_KEY_IOS_APP_BLOCKED → const ErrorReason: The request is denied because it violates API key iOS application restrictions.
API_KEY_IP_ADDRESS_BLOCKED → const ErrorReason: The request is denied because it violates API key IP address restrictions.
API_KEY_SERVICE_BLOCKED → const ErrorReason: The request is denied because it violates API key API restrictions.
BILLING_DISABLED → const ErrorReason: The request whose associated billing account is disabled.
CONSUMER_INVALID → const ErrorReason: The request is denied because the associated consumer is invalid. It may be in a bad format, cannot be found, or have been deleted.
CONSUMER_SUSPENDED → const ErrorReason: The request is denied because the consumer "projects/123" is suspended due to Terms of Service(Tos) violations. Check Project suspension guidelines for more information.
CREDENTIALS_MISSING → const ErrorReason: The request is denied because the request doesn't have any authentication credentials. For more information regarding the supported authentication strategies for Google Cloud APIs, see https://cloud.google.com/docs/authentication.
ERROR_REASON_UNSPECIFIED → const ErrorReason: Do not use this default value.
GCP_SUSPENDED → const ErrorReason: The request is related to a project for which GCP access is suspended.
LOCATION_TAX_POLICY_VIOLATED → const ErrorReason: The request whose associated billing account address is in a tax restricted location, violates the local tax restrictions when creating resources in the restricted region.
ORG_RESTRICTION_HEADER_INVALID → const ErrorReason: The request is denied because "X-Goog-Allowed-Resources" header is in a bad format.
ORG_RESTRICTION_VIOLATION → const ErrorReason: The request is denied because it violates Org Restriction: the requested resource does not belong to allowed organizations specified in "X-Goog-Allowed-Resources" header.
RATE_LIMIT_EXCEEDED → const ErrorReason: The request is denied because there is not enough rate quota for the consumer.
RESOURCE_PROJECT_INVALID → const ErrorReason: The request is denied because the provided project owning the resource which acts as the API consumer is invalid. It may be in a bad format or empty.
RESOURCE_QUOTA_EXCEEDED → const ErrorReason: The request is denied because there is not enough resource quota for the consumer.
RESOURCE_USAGE_RESTRICTION_VIOLATED → const ErrorReason: The request is denied because the resource service usage is restricted by administrators according to the organization policy constraint. For more information see https://cloud.google.com/resource-manager/docs/organization-policy/restricting-services.
SECURITY_POLICY_VIOLATED → const ErrorReason: The request is denied because it violates VPC Service Controls. The 'uid' field is a random generated identifier that customer can use it to search the audit log for a request rejected by VPC Service Controls. For more information, please refer VPC Service Controls Troubleshooting
SERVICE_DISABLED → const ErrorReason: The request is calling a disabled service for a consumer.
SERVICE_NOT_VISIBLE → const ErrorReason: Unimplemented. Do not use.
SESSION_COOKIE_INVALID → const ErrorReason: The request is denied because the provided session cookie is missing, invalid or failed to decode.
SYSTEM_PARAMETER_UNSUPPORTED → const ErrorReason: Unimplemented. Do not use.
USER_BLOCKED_BY_ADMIN → const ErrorReason: The request is denied because the user is from a Google Workspace customer that blocks their users from accessing a particular service.
USER_PROJECT_DENIED → const ErrorReason: The request is denied because the caller does not have required permission on the user project "projects/123" or the user project is invalid. For more information, check the userProject System Parameters.
values → const List<ErrorReason>