public enum ErrorReason extends Enum<ErrorReason> implements com.google.protobuf.ProtocolMessageEnum
Defines the supported values for `google.rpc.ErrorInfo.reason` for the `googleapis.com` error domain. This error domain is reserved for [Service Infrastructure](https://cloud.google.com/service-infrastructure/docs/overview). 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.Protobuf enum
google.api.ErrorReason| Enum Constant and Description |
|---|
ACCESS_TOKEN_EXPIRED
The request is denied because the provided access token has expired.
|
ACCESS_TOKEN_SCOPE_INSUFFICIENT
The request is denied because the provided access token doesn't have at
least one of the acceptable scopes required for the API.
|
ACCESS_TOKEN_TYPE_UNSUPPORTED
The request is denied because the type of the provided access token is not
supported by the API being called.
|
ACCOUNT_STATE_INVALID
The request is denied because the account associated with the provided
access token is in an invalid state, such as disabled or deleted.
|
API_KEY_ANDROID_APP_BLOCKED
The request is denied because it violates [API key Android application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
|
API_KEY_HTTP_REFERRER_BLOCKED
The request is denied because it violates [API key HTTP
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_http_restrictions).
|
API_KEY_INVALID
The request is denied because the provided [API
key](https://cloud.google.com/docs/authentication/api-keys) is invalid.
|
API_KEY_IOS_APP_BLOCKED
The request is denied because it violates [API key iOS application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
|
API_KEY_IP_ADDRESS_BLOCKED
The request is denied because it violates [API key IP address
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
|
API_KEY_SERVICE_BLOCKED
The request is denied because it violates [API key API
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_api_restrictions).
|
BILLING_DISABLED
The request whose associated billing account is disabled.
|
CONSUMER_INVALID
The request is denied because the associated consumer is invalid.
|
CONSUMER_SUSPENDED
The request is denied because the consumer "projects/123" is suspended due
to Terms of Service(Tos) violations.
|
CREDENTIALS_MISSING
The request is denied because the request doesn't have any authentication
credentials.
|
ERROR_REASON_UNSPECIFIED
Do not use this default value.
|
LOCATION_TAX_POLICY_VIOLATED
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
The request is denied because "X-Goog-Allowed-Resources" header is in a bad
format.
|
ORG_RESTRICTION_VIOLATION
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
The request is denied because there is not enough rate quota for the
consumer.
|
RESOURCE_PROJECT_INVALID
The request is denied because the provided project owning the resource
which acts as the [API
consumer](https://cloud.google.com/apis/design/glossary#api_consumer) is
invalid.
|
RESOURCE_QUOTA_EXCEEDED
The request is denied because there is not enough resource quota for the
consumer.
|
RESOURCE_USAGE_RESTRICTION_VIOLATED
The request is denied because the resource service usage is restricted
by administrators according to the organization policy constraint.
|
SECURITY_POLICY_VIOLATED
The request is denied because it violates [VPC Service
Controls](https://cloud.google.com/vpc-service-controls/docs/overview).
|
SERVICE_DISABLED
The request is calling a disabled service for a consumer.
|
SESSION_COOKIE_INVALID
The request is denied because the provided session cookie is missing,
invalid or failed to decode.
|
SYSTEM_PARAMETER_UNSUPPORTED
Unimplemented.
|
UNRECOGNIZED |
USER_BLOCKED_BY_ADMIN
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
The request is denied because the caller does not have required permission
on the user project "projects/123" or the user project is invalid.
|
| Modifier and Type | Field and Description |
|---|---|
static int |
ACCESS_TOKEN_EXPIRED_VALUE
The request is denied because the provided access token has expired.
|
static int |
ACCESS_TOKEN_SCOPE_INSUFFICIENT_VALUE
The request is denied because the provided access token doesn't have at
least one of the acceptable scopes required for the API.
|
static int |
ACCESS_TOKEN_TYPE_UNSUPPORTED_VALUE
The request is denied because the type of the provided access token is not
supported by the API being called.
|
static int |
ACCOUNT_STATE_INVALID_VALUE
The request is denied because the account associated with the provided
access token is in an invalid state, such as disabled or deleted.
|
static int |
API_KEY_ANDROID_APP_BLOCKED_VALUE
The request is denied because it violates [API key Android application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
|
static int |
API_KEY_HTTP_REFERRER_BLOCKED_VALUE
The request is denied because it violates [API key HTTP
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_http_restrictions).
|
static int |
API_KEY_INVALID_VALUE
The request is denied because the provided [API
key](https://cloud.google.com/docs/authentication/api-keys) is invalid.
|
static int |
API_KEY_IOS_APP_BLOCKED_VALUE
The request is denied because it violates [API key iOS application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
|
static int |
API_KEY_IP_ADDRESS_BLOCKED_VALUE
The request is denied because it violates [API key IP address
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
|
static int |
API_KEY_SERVICE_BLOCKED_VALUE
The request is denied because it violates [API key API
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_api_restrictions).
|
static int |
BILLING_DISABLED_VALUE
The request whose associated billing account is disabled.
|
static int |
CONSUMER_INVALID_VALUE
The request is denied because the associated consumer is invalid.
|
static int |
CONSUMER_SUSPENDED_VALUE
The request is denied because the consumer "projects/123" is suspended due
to Terms of Service(Tos) violations.
|
static int |
CREDENTIALS_MISSING_VALUE
The request is denied because the request doesn't have any authentication
credentials.
|
static int |
ERROR_REASON_UNSPECIFIED_VALUE
Do not use this default value.
|
static int |
LOCATION_TAX_POLICY_VIOLATED_VALUE
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.
|
static int |
ORG_RESTRICTION_HEADER_INVALID_VALUE
The request is denied because "X-Goog-Allowed-Resources" header is in a bad
format.
|
static int |
ORG_RESTRICTION_VIOLATION_VALUE
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.
|
static int |
RATE_LIMIT_EXCEEDED_VALUE
The request is denied because there is not enough rate quota for the
consumer.
|
static int |
RESOURCE_PROJECT_INVALID_VALUE
The request is denied because the provided project owning the resource
which acts as the [API
consumer](https://cloud.google.com/apis/design/glossary#api_consumer) is
invalid.
|
static int |
RESOURCE_QUOTA_EXCEEDED_VALUE
The request is denied because there is not enough resource quota for the
consumer.
|
static int |
RESOURCE_USAGE_RESTRICTION_VIOLATED_VALUE
The request is denied because the resource service usage is restricted
by administrators according to the organization policy constraint.
|
static int |
SECURITY_POLICY_VIOLATED_VALUE
The request is denied because it violates [VPC Service
Controls](https://cloud.google.com/vpc-service-controls/docs/overview).
|
static int |
SERVICE_DISABLED_VALUE
The request is calling a disabled service for a consumer.
|
static int |
SESSION_COOKIE_INVALID_VALUE
The request is denied because the provided session cookie is missing,
invalid or failed to decode.
|
static int |
SYSTEM_PARAMETER_UNSUPPORTED_VALUE
Unimplemented.
|
static int |
USER_BLOCKED_BY_ADMIN_VALUE
The request is denied because the user is from a Google Workspace customer
that blocks their users from accessing a particular service.
|
static int |
USER_PROJECT_DENIED_VALUE
The request is denied because the caller does not have required permission
on the user project "projects/123" or the user project is invalid.
|
| Modifier and Type | Method and Description |
|---|---|
static ErrorReason |
forNumber(int value) |
static com.google.protobuf.Descriptors.EnumDescriptor |
getDescriptor() |
com.google.protobuf.Descriptors.EnumDescriptor |
getDescriptorForType() |
int |
getNumber() |
com.google.protobuf.Descriptors.EnumValueDescriptor |
getValueDescriptor() |
static com.google.protobuf.Internal.EnumLiteMap<ErrorReason> |
internalGetValueMap() |
static ErrorReason |
valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) |
static ErrorReason |
valueOf(int value)
Deprecated.
Use
forNumber(int) instead. |
static ErrorReason |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static ErrorReason[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final ErrorReason ERROR_REASON_UNSPECIFIED
Do not use this default value.
ERROR_REASON_UNSPECIFIED = 0;public static final ErrorReason SERVICE_DISABLED
The request is calling a disabled service for a consumer.
Example of an ErrorInfo when the consumer "projects/123" contacting
"pubsub.googleapis.com" service which is disabled:
{ "reason": "SERVICE_DISABLED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates the "pubsub.googleapis.com" has been disabled in
"projects/123".
SERVICE_DISABLED = 1;public static final ErrorReason BILLING_DISABLED
The request whose associated billing account is disabled.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"pubsub.googleapis.com" service because the associated billing account is
disabled:
{ "reason": "BILLING_DISABLED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates the billing account associated has been disabled.
BILLING_DISABLED = 2;public static final ErrorReason API_KEY_INVALID
The request is denied because the provided [API
key](https://cloud.google.com/docs/authentication/api-keys) is invalid. It
may be in a bad format, cannot be found, or has been expired).
Example of an ErrorInfo when the request is contacting
"storage.googleapis.com" service with an invalid API key:
{ "reason": "API_KEY_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
}
}
API_KEY_INVALID = 3;public static final ErrorReason API_KEY_SERVICE_BLOCKED
The request is denied because it violates [API key API
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_api_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call the
"storage.googleapis.com" service because this service is restricted in the
API key:
{ "reason": "API_KEY_SERVICE_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
API_KEY_SERVICE_BLOCKED = 4;public static final ErrorReason API_KEY_HTTP_REFERRER_BLOCKED
The request is denied because it violates [API key HTTP
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_http_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the http referrer of the request
violates API key HTTP restrictions:
{ "reason": "API_KEY_HTTP_REFERRER_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
}
}
API_KEY_HTTP_REFERRER_BLOCKED = 7;public static final ErrorReason API_KEY_IP_ADDRESS_BLOCKED
The request is denied because it violates [API key IP address
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the caller IP of the request
violates API key IP address restrictions:
{ "reason": "API_KEY_IP_ADDRESS_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
}
}
API_KEY_IP_ADDRESS_BLOCKED = 8;public static final ErrorReason API_KEY_ANDROID_APP_BLOCKED
The request is denied because it violates [API key Android application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the request from the Android apps
violates the API key Android application restrictions:
{ "reason": "API_KEY_ANDROID_APP_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
API_KEY_ANDROID_APP_BLOCKED = 9;public static final ErrorReason API_KEY_IOS_APP_BLOCKED
The request is denied because it violates [API key iOS application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the request from the iOS apps
violates the API key iOS application restrictions:
{ "reason": "API_KEY_IOS_APP_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
API_KEY_IOS_APP_BLOCKED = 13;public static final ErrorReason RATE_LIMIT_EXCEEDED
The request is denied because there is not enough rate quota for the
consumer.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"pubsub.googleapis.com" service because consumer's rate quota usage has
reached the maximum value set for the quota limit
"ReadsPerMinutePerProject" on the quota metric
"pubsub.googleapis.com/read_requests":
{ "reason": "RATE_LIMIT_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com",
"quota_metric": "pubsub.googleapis.com/read_requests",
"quota_limit": "ReadsPerMinutePerProject"
}
}
Example of an ErrorInfo when the consumer "projects/123" checks quota on
the service "dataflow.googleapis.com" and hits the organization quota
limit "DefaultRequestsPerMinutePerOrganization" on the metric
"dataflow.googleapis.com/default_requests".
{ "reason": "RATE_LIMIT_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "dataflow.googleapis.com",
"quota_metric": "dataflow.googleapis.com/default_requests",
"quota_limit": "DefaultRequestsPerMinutePerOrganization"
}
}
RATE_LIMIT_EXCEEDED = 5;public static final ErrorReason RESOURCE_QUOTA_EXCEEDED
The request is denied because there is not enough resource quota for the
consumer.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"compute.googleapis.com" service because consumer's resource quota usage
has reached the maximum value set for the quota limit "VMsPerProject"
on the quota metric "compute.googleapis.com/vms":
{ "reason": "RESOURCE_QUOTA_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "compute.googleapis.com",
"quota_metric": "compute.googleapis.com/vms",
"quota_limit": "VMsPerProject"
}
}
Example of an ErrorInfo when the consumer "projects/123" checks resource
quota on the service "dataflow.googleapis.com" and hits the organization
quota limit "jobs-per-organization" on the metric
"dataflow.googleapis.com/job_count".
{ "reason": "RESOURCE_QUOTA_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "dataflow.googleapis.com",
"quota_metric": "dataflow.googleapis.com/job_count",
"quota_limit": "jobs-per-organization"
}
}
RESOURCE_QUOTA_EXCEEDED = 6;public static final ErrorReason LOCATION_TAX_POLICY_VIOLATED
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.
Example of an ErrorInfo when creating the Cloud Storage Bucket in the
container "projects/123" under a tax restricted region
"locations/asia-northeast3":
{ "reason": "LOCATION_TAX_POLICY_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
"location": "locations/asia-northeast3"
}
}
This response indicates creating the Cloud Storage Bucket in
"locations/asia-northeast3" violates the location tax restriction.
LOCATION_TAX_POLICY_VIOLATED = 10;public static final ErrorReason USER_PROJECT_DENIED
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](https://cloud.google.com/apis/docs/system-parameters).
Example of an ErrorInfo when the caller is calling Cloud Storage service
with insufficient permissions on the user project:
{ "reason": "USER_PROJECT_DENIED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
USER_PROJECT_DENIED = 11;public static final ErrorReason CONSUMER_SUSPENDED
The request is denied because the consumer "projects/123" is suspended due
to Terms of Service(Tos) violations. Check [Project suspension
guidelines](https://cloud.google.com/resource-manager/docs/project-suspension-guidelines)
for more information.
Example of an ErrorInfo when calling Cloud Storage service with the
suspended consumer "projects/123":
{ "reason": "CONSUMER_SUSPENDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
CONSUMER_SUSPENDED = 12;public static final ErrorReason CONSUMER_INVALID
The request is denied because the associated consumer is invalid. It may be
in a bad format, cannot be found, or have been deleted.
Example of an ErrorInfo when calling Cloud Storage service with the
invalid consumer "projects/123":
{ "reason": "CONSUMER_INVALID",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
CONSUMER_INVALID = 14;public static final ErrorReason SECURITY_POLICY_VIOLATED
The request is denied because it violates [VPC Service
Controls](https://cloud.google.com/vpc-service-controls/docs/overview).
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](https://cloud.google.com/vpc-service-controls/docs/troubleshooting#unique-id)
Example of an ErrorInfo when the consumer "projects/123" fails to call
Cloud Storage service because the request is prohibited by the VPC Service
Controls.
{ "reason": "SECURITY_POLICY_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"uid": "123456789abcde",
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
SECURITY_POLICY_VIOLATED = 15;public static final ErrorReason ACCESS_TOKEN_EXPIRED
The request is denied because the provided access token has expired.
Example of an ErrorInfo when the request is calling Cloud Storage service
with an expired access token:
{ "reason": "ACCESS_TOKEN_EXPIRED",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
ACCESS_TOKEN_EXPIRED = 16;public static final ErrorReason ACCESS_TOKEN_SCOPE_INSUFFICIENT
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](https://developers.google.com/identity/protocols/oauth2/scopes) for
the list of the OAuth 2.0 scopes that you might need to request to access
the API.
Example of an ErrorInfo when the request is calling Cloud Storage service
with an access token that is missing required scopes:
{ "reason": "ACCESS_TOKEN_SCOPE_INSUFFICIENT",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
ACCESS_TOKEN_SCOPE_INSUFFICIENT = 17;public static final ErrorReason ACCOUNT_STATE_INVALID
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.
Warning: For privacy reasons, the server may not be able to disclose the
email address for some accounts. The client MUST NOT depend on the
availability of the `email` attribute.
Example of an ErrorInfo when the request is to the Cloud Storage API with
an access token that is associated with a disabled or deleted [service
account](http://cloud/iam/docs/service-accounts):
{ "reason": "ACCOUNT_STATE_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
"email": "user@123.iam.gserviceaccount.com"
}
}
ACCOUNT_STATE_INVALID = 18;public static final ErrorReason ACCESS_TOKEN_TYPE_UNSUPPORTED
The request is denied because the type of the provided access token is not
supported by the API being called.
Example of an ErrorInfo when the request is to the Cloud Storage API with
an unsupported token type.
{ "reason": "ACCESS_TOKEN_TYPE_UNSUPPORTED",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
ACCESS_TOKEN_TYPE_UNSUPPORTED = 19;public static final ErrorReason CREDENTIALS_MISSING
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.
Example of an ErrorInfo when the request is to the Cloud Storage API
without any authentication credentials.
{ "reason": "CREDENTIALS_MISSING",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
CREDENTIALS_MISSING = 20;public static final ErrorReason RESOURCE_PROJECT_INVALID
The request is denied because the provided project owning the resource
which acts as the [API
consumer](https://cloud.google.com/apis/design/glossary#api_consumer) is
invalid. It may be in a bad format or empty.
Example of an ErrorInfo when the request is to the Cloud Functions API,
but the offered resource project in the request in a bad format which can't
perform the ListFunctions method.
{ "reason": "RESOURCE_PROJECT_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "cloudfunctions.googleapis.com",
"method":
"google.cloud.functions.v1.CloudFunctionsService.ListFunctions"
}
}
RESOURCE_PROJECT_INVALID = 21;public static final ErrorReason SESSION_COOKIE_INVALID
The request is denied because the provided session cookie is missing,
invalid or failed to decode.
Example of an ErrorInfo when the request is calling Cloud Storage service
with a SID cookie which can't be decoded.
{ "reason": "SESSION_COOKIE_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
"cookie": "SID"
}
}
SESSION_COOKIE_INVALID = 23;public static final ErrorReason USER_BLOCKED_BY_ADMIN
The request is denied because the user is from a Google Workspace customer
that blocks their users from accessing a particular service.
Example scenario: https://support.google.com/a/answer/9197205?hl=en
Example of an ErrorInfo when access to Google Cloud Storage service is
blocked by the Google Workspace administrator:
{ "reason": "USER_BLOCKED_BY_ADMIN",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
}
}
USER_BLOCKED_BY_ADMIN = 24;public static final ErrorReason RESOURCE_USAGE_RESTRICTION_VIOLATED
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.
Example of an ErrorInfo when access to Google Cloud Storage service is
restricted by Resource Usage Restriction policy:
{ "reason": "RESOURCE_USAGE_RESTRICTION_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/project-123",
"service": "storage.googleapis.com"
}
}
RESOURCE_USAGE_RESTRICTION_VIOLATED = 25;public static final ErrorReason SYSTEM_PARAMETER_UNSUPPORTED
Unimplemented. Do not use.
The request is denied because it contains unsupported system parameters in
URL query parameters or HTTP headers. For more information,
see https://cloud.google.com/apis/docs/system-parameters
Example of an ErrorInfo when access "pubsub.googleapis.com" service with
a request header of "x-goog-user-ip":
{ "reason": "SYSTEM_PARAMETER_UNSUPPORTED",
"domain": "googleapis.com",
"metadata": {
"service": "pubsub.googleapis.com"
"parameter": "x-goog-user-ip"
}
}
SYSTEM_PARAMETER_UNSUPPORTED = 26;public static final ErrorReason ORG_RESTRICTION_VIOLATION
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.
Example of an ErrorInfo when accessing a GCP resource that is restricted by
Org Restriction for "pubsub.googleapis.com" service.
{
reason: "ORG_RESTRICTION_VIOLATION"
domain: "googleapis.com"
metadata {
"consumer":"projects/123456"
"service": "pubsub.googleapis.com"
}
}
ORG_RESTRICTION_VIOLATION = 27;public static final ErrorReason ORG_RESTRICTION_HEADER_INVALID
The request is denied because "X-Goog-Allowed-Resources" header is in a bad
format.
Example of an ErrorInfo when
accessing "pubsub.googleapis.com" service with an invalid
"X-Goog-Allowed-Resources" request header.
{
reason: "ORG_RESTRICTION_HEADER_INVALID"
domain: "googleapis.com"
metadata {
"consumer":"projects/123456"
"service": "pubsub.googleapis.com"
}
}
ORG_RESTRICTION_HEADER_INVALID = 28;public static final ErrorReason UNRECOGNIZED
public static final int ERROR_REASON_UNSPECIFIED_VALUE
Do not use this default value.
ERROR_REASON_UNSPECIFIED = 0;public static final int SERVICE_DISABLED_VALUE
The request is calling a disabled service for a consumer.
Example of an ErrorInfo when the consumer "projects/123" contacting
"pubsub.googleapis.com" service which is disabled:
{ "reason": "SERVICE_DISABLED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates the "pubsub.googleapis.com" has been disabled in
"projects/123".
SERVICE_DISABLED = 1;public static final int BILLING_DISABLED_VALUE
The request whose associated billing account is disabled.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"pubsub.googleapis.com" service because the associated billing account is
disabled:
{ "reason": "BILLING_DISABLED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com"
}
}
This response indicates the billing account associated has been disabled.
BILLING_DISABLED = 2;public static final int API_KEY_INVALID_VALUE
The request is denied because the provided [API
key](https://cloud.google.com/docs/authentication/api-keys) is invalid. It
may be in a bad format, cannot be found, or has been expired).
Example of an ErrorInfo when the request is contacting
"storage.googleapis.com" service with an invalid API key:
{ "reason": "API_KEY_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
}
}
API_KEY_INVALID = 3;public static final int API_KEY_SERVICE_BLOCKED_VALUE
The request is denied because it violates [API key API
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_api_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call the
"storage.googleapis.com" service because this service is restricted in the
API key:
{ "reason": "API_KEY_SERVICE_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
API_KEY_SERVICE_BLOCKED = 4;public static final int API_KEY_HTTP_REFERRER_BLOCKED_VALUE
The request is denied because it violates [API key HTTP
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_http_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the http referrer of the request
violates API key HTTP restrictions:
{ "reason": "API_KEY_HTTP_REFERRER_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
}
}
API_KEY_HTTP_REFERRER_BLOCKED = 7;public static final int API_KEY_IP_ADDRESS_BLOCKED_VALUE
The request is denied because it violates [API key IP address
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the caller IP of the request
violates API key IP address restrictions:
{ "reason": "API_KEY_IP_ADDRESS_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
}
}
API_KEY_IP_ADDRESS_BLOCKED = 8;public static final int API_KEY_ANDROID_APP_BLOCKED_VALUE
The request is denied because it violates [API key Android application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the request from the Android apps
violates the API key Android application restrictions:
{ "reason": "API_KEY_ANDROID_APP_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
API_KEY_ANDROID_APP_BLOCKED = 9;public static final int API_KEY_IOS_APP_BLOCKED_VALUE
The request is denied because it violates [API key iOS application
restrictions](https://cloud.google.com/docs/authentication/api-keys#adding_application_restrictions).
Example of an ErrorInfo when the consumer "projects/123" fails to call
"storage.googleapis.com" service because the request from the iOS apps
violates the API key iOS application restrictions:
{ "reason": "API_KEY_IOS_APP_BLOCKED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
API_KEY_IOS_APP_BLOCKED = 13;public static final int RATE_LIMIT_EXCEEDED_VALUE
The request is denied because there is not enough rate quota for the
consumer.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"pubsub.googleapis.com" service because consumer's rate quota usage has
reached the maximum value set for the quota limit
"ReadsPerMinutePerProject" on the quota metric
"pubsub.googleapis.com/read_requests":
{ "reason": "RATE_LIMIT_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "pubsub.googleapis.com",
"quota_metric": "pubsub.googleapis.com/read_requests",
"quota_limit": "ReadsPerMinutePerProject"
}
}
Example of an ErrorInfo when the consumer "projects/123" checks quota on
the service "dataflow.googleapis.com" and hits the organization quota
limit "DefaultRequestsPerMinutePerOrganization" on the metric
"dataflow.googleapis.com/default_requests".
{ "reason": "RATE_LIMIT_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "dataflow.googleapis.com",
"quota_metric": "dataflow.googleapis.com/default_requests",
"quota_limit": "DefaultRequestsPerMinutePerOrganization"
}
}
RATE_LIMIT_EXCEEDED = 5;public static final int RESOURCE_QUOTA_EXCEEDED_VALUE
The request is denied because there is not enough resource quota for the
consumer.
Example of an ErrorInfo when the consumer "projects/123" fails to contact
"compute.googleapis.com" service because consumer's resource quota usage
has reached the maximum value set for the quota limit "VMsPerProject"
on the quota metric "compute.googleapis.com/vms":
{ "reason": "RESOURCE_QUOTA_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "compute.googleapis.com",
"quota_metric": "compute.googleapis.com/vms",
"quota_limit": "VMsPerProject"
}
}
Example of an ErrorInfo when the consumer "projects/123" checks resource
quota on the service "dataflow.googleapis.com" and hits the organization
quota limit "jobs-per-organization" on the metric
"dataflow.googleapis.com/job_count".
{ "reason": "RESOURCE_QUOTA_EXCEEDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "dataflow.googleapis.com",
"quota_metric": "dataflow.googleapis.com/job_count",
"quota_limit": "jobs-per-organization"
}
}
RESOURCE_QUOTA_EXCEEDED = 6;public static final int LOCATION_TAX_POLICY_VIOLATED_VALUE
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.
Example of an ErrorInfo when creating the Cloud Storage Bucket in the
container "projects/123" under a tax restricted region
"locations/asia-northeast3":
{ "reason": "LOCATION_TAX_POLICY_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com",
"location": "locations/asia-northeast3"
}
}
This response indicates creating the Cloud Storage Bucket in
"locations/asia-northeast3" violates the location tax restriction.
LOCATION_TAX_POLICY_VIOLATED = 10;public static final int USER_PROJECT_DENIED_VALUE
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](https://cloud.google.com/apis/docs/system-parameters).
Example of an ErrorInfo when the caller is calling Cloud Storage service
with insufficient permissions on the user project:
{ "reason": "USER_PROJECT_DENIED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
USER_PROJECT_DENIED = 11;public static final int CONSUMER_SUSPENDED_VALUE
The request is denied because the consumer "projects/123" is suspended due
to Terms of Service(Tos) violations. Check [Project suspension
guidelines](https://cloud.google.com/resource-manager/docs/project-suspension-guidelines)
for more information.
Example of an ErrorInfo when calling Cloud Storage service with the
suspended consumer "projects/123":
{ "reason": "CONSUMER_SUSPENDED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
CONSUMER_SUSPENDED = 12;public static final int CONSUMER_INVALID_VALUE
The request is denied because the associated consumer is invalid. It may be
in a bad format, cannot be found, or have been deleted.
Example of an ErrorInfo when calling Cloud Storage service with the
invalid consumer "projects/123":
{ "reason": "CONSUMER_INVALID",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
CONSUMER_INVALID = 14;public static final int SECURITY_POLICY_VIOLATED_VALUE
The request is denied because it violates [VPC Service
Controls](https://cloud.google.com/vpc-service-controls/docs/overview).
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](https://cloud.google.com/vpc-service-controls/docs/troubleshooting#unique-id)
Example of an ErrorInfo when the consumer "projects/123" fails to call
Cloud Storage service because the request is prohibited by the VPC Service
Controls.
{ "reason": "SECURITY_POLICY_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"uid": "123456789abcde",
"consumer": "projects/123",
"service": "storage.googleapis.com"
}
}
SECURITY_POLICY_VIOLATED = 15;public static final int ACCESS_TOKEN_EXPIRED_VALUE
The request is denied because the provided access token has expired.
Example of an ErrorInfo when the request is calling Cloud Storage service
with an expired access token:
{ "reason": "ACCESS_TOKEN_EXPIRED",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
ACCESS_TOKEN_EXPIRED = 16;public static final int ACCESS_TOKEN_SCOPE_INSUFFICIENT_VALUE
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](https://developers.google.com/identity/protocols/oauth2/scopes) for
the list of the OAuth 2.0 scopes that you might need to request to access
the API.
Example of an ErrorInfo when the request is calling Cloud Storage service
with an access token that is missing required scopes:
{ "reason": "ACCESS_TOKEN_SCOPE_INSUFFICIENT",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
ACCESS_TOKEN_SCOPE_INSUFFICIENT = 17;public static final int ACCOUNT_STATE_INVALID_VALUE
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.
Warning: For privacy reasons, the server may not be able to disclose the
email address for some accounts. The client MUST NOT depend on the
availability of the `email` attribute.
Example of an ErrorInfo when the request is to the Cloud Storage API with
an access token that is associated with a disabled or deleted [service
account](http://cloud/iam/docs/service-accounts):
{ "reason": "ACCOUNT_STATE_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
"email": "user@123.iam.gserviceaccount.com"
}
}
ACCOUNT_STATE_INVALID = 18;public static final int ACCESS_TOKEN_TYPE_UNSUPPORTED_VALUE
The request is denied because the type of the provided access token is not
supported by the API being called.
Example of an ErrorInfo when the request is to the Cloud Storage API with
an unsupported token type.
{ "reason": "ACCESS_TOKEN_TYPE_UNSUPPORTED",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
ACCESS_TOKEN_TYPE_UNSUPPORTED = 19;public static final int CREDENTIALS_MISSING_VALUE
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.
Example of an ErrorInfo when the request is to the Cloud Storage API
without any authentication credentials.
{ "reason": "CREDENTIALS_MISSING",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject"
}
}
CREDENTIALS_MISSING = 20;public static final int RESOURCE_PROJECT_INVALID_VALUE
The request is denied because the provided project owning the resource
which acts as the [API
consumer](https://cloud.google.com/apis/design/glossary#api_consumer) is
invalid. It may be in a bad format or empty.
Example of an ErrorInfo when the request is to the Cloud Functions API,
but the offered resource project in the request in a bad format which can't
perform the ListFunctions method.
{ "reason": "RESOURCE_PROJECT_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "cloudfunctions.googleapis.com",
"method":
"google.cloud.functions.v1.CloudFunctionsService.ListFunctions"
}
}
RESOURCE_PROJECT_INVALID = 21;public static final int SESSION_COOKIE_INVALID_VALUE
The request is denied because the provided session cookie is missing,
invalid or failed to decode.
Example of an ErrorInfo when the request is calling Cloud Storage service
with a SID cookie which can't be decoded.
{ "reason": "SESSION_COOKIE_INVALID",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
"cookie": "SID"
}
}
SESSION_COOKIE_INVALID = 23;public static final int USER_BLOCKED_BY_ADMIN_VALUE
The request is denied because the user is from a Google Workspace customer
that blocks their users from accessing a particular service.
Example scenario: https://support.google.com/a/answer/9197205?hl=en
Example of an ErrorInfo when access to Google Cloud Storage service is
blocked by the Google Workspace administrator:
{ "reason": "USER_BLOCKED_BY_ADMIN",
"domain": "googleapis.com",
"metadata": {
"service": "storage.googleapis.com",
"method": "google.storage.v1.Storage.GetObject",
}
}
USER_BLOCKED_BY_ADMIN = 24;public static final int RESOURCE_USAGE_RESTRICTION_VIOLATED_VALUE
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.
Example of an ErrorInfo when access to Google Cloud Storage service is
restricted by Resource Usage Restriction policy:
{ "reason": "RESOURCE_USAGE_RESTRICTION_VIOLATED",
"domain": "googleapis.com",
"metadata": {
"consumer": "projects/project-123",
"service": "storage.googleapis.com"
}
}
RESOURCE_USAGE_RESTRICTION_VIOLATED = 25;public static final int SYSTEM_PARAMETER_UNSUPPORTED_VALUE
Unimplemented. Do not use.
The request is denied because it contains unsupported system parameters in
URL query parameters or HTTP headers. For more information,
see https://cloud.google.com/apis/docs/system-parameters
Example of an ErrorInfo when access "pubsub.googleapis.com" service with
a request header of "x-goog-user-ip":
{ "reason": "SYSTEM_PARAMETER_UNSUPPORTED",
"domain": "googleapis.com",
"metadata": {
"service": "pubsub.googleapis.com"
"parameter": "x-goog-user-ip"
}
}
SYSTEM_PARAMETER_UNSUPPORTED = 26;public static final int ORG_RESTRICTION_VIOLATION_VALUE
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.
Example of an ErrorInfo when accessing a GCP resource that is restricted by
Org Restriction for "pubsub.googleapis.com" service.
{
reason: "ORG_RESTRICTION_VIOLATION"
domain: "googleapis.com"
metadata {
"consumer":"projects/123456"
"service": "pubsub.googleapis.com"
}
}
ORG_RESTRICTION_VIOLATION = 27;public static final int ORG_RESTRICTION_HEADER_INVALID_VALUE
The request is denied because "X-Goog-Allowed-Resources" header is in a bad
format.
Example of an ErrorInfo when
accessing "pubsub.googleapis.com" service with an invalid
"X-Goog-Allowed-Resources" request header.
{
reason: "ORG_RESTRICTION_HEADER_INVALID"
domain: "googleapis.com"
metadata {
"consumer":"projects/123456"
"service": "pubsub.googleapis.com"
}
}
ORG_RESTRICTION_HEADER_INVALID = 28;public static ErrorReason[] values()
for (ErrorReason c : ErrorReason.values()) System.out.println(c);
public static ErrorReason valueOf(String name)
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic final int getNumber()
getNumber in interface com.google.protobuf.Internal.EnumLitegetNumber in interface com.google.protobuf.ProtocolMessageEnum@Deprecated public static ErrorReason valueOf(int value)
forNumber(int) instead.value - The numeric wire value of the corresponding enum entry.public static ErrorReason forNumber(int value)
value - The numeric wire value of the corresponding enum entry.public static com.google.protobuf.Internal.EnumLiteMap<ErrorReason> internalGetValueMap()
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnumpublic final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnumpublic static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
public static ErrorReason valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
Copyright © 2022 Google LLC. All rights reserved.