Package com.google.api

Enum Class ErrorReason

java.lang.Object
java.lang.Enum<ErrorReason>
com.google.api.ErrorReason
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<ErrorReason>, Constable
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

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    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.
    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.
    RATE_LIMIT_EXCEEDED
    The request is denied because there is not enough rate quota for the consumer.
    RESOURCE_QUOTA_EXCEEDED
    The request is denied because there is not enough resource quota for the consumer.
    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.
    UNRECOGNIZED
     
    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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACCESS_TOKEN_EXPIRED_VALUE
    The request is denied because the provided access token has expired.
    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.
    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.
    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.
    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).
    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).
    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.
    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).
    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).
    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).
    static final int
    BILLING_DISABLED_VALUE
    The request whose associated billing account is disabled.
    static final int
    CONSUMER_INVALID_VALUE
    The request is denied because the associated consumer is invalid.
    static final int
    CONSUMER_SUSPENDED_VALUE
    The request is denied because the consumer "projects/123" is suspended due to Terms of Service(Tos) violations.
    static final int
    ERROR_REASON_UNSPECIFIED_VALUE
    Do not use this default value.
    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.
    static final int
    RATE_LIMIT_EXCEEDED_VALUE
    The request is denied because there is not enough rate quota for the consumer.
    static final int
    RESOURCE_QUOTA_EXCEEDED_VALUE
    The request is denied because there is not enough resource quota for the consumer.
    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).
    static final int
    SERVICE_DISABLED_VALUE
    The request is calling a disabled service for a consumer.
    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.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ErrorReason
    forNumber(int value)
     
    static final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptor()
     
    final com.google.protobuf.Descriptors.EnumDescriptor
    getDescriptorForType()
     
    final int
    getNumber()
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
    getValueDescriptor()
     
    static com.google.protobuf.Internal.EnumLiteMap<ErrorReason>
    internalGetValueMap()
     
    static ErrorReason
    valueOf(int value)
    Deprecated.
    static ErrorReason
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this class with the specified name.
    static ErrorReason
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ErrorReason[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ERROR_REASON_UNSPECIFIED

      public static final ErrorReason ERROR_REASON_UNSPECIFIED
       Do not use this default value.
      ERROR_REASON_UNSPECIFIED = 0;

    • SERVICE_DISABLED

      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;

    • BILLING_DISABLED

      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;

    • API_KEY_INVALID

      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;

    • API_KEY_SERVICE_BLOCKED

      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;

    • API_KEY_HTTP_REFERRER_BLOCKED

      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;

    • API_KEY_IP_ADDRESS_BLOCKED

      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;

    • API_KEY_ANDROID_APP_BLOCKED

      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;

    • API_KEY_IOS_APP_BLOCKED

      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;

    • RATE_LIMIT_EXCEEDED

      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;

    • RESOURCE_QUOTA_EXCEEDED

      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;

    • LOCATION_TAX_POLICY_VIOLATED

      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;

    • USER_PROJECT_DENIED

      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;

    • CONSUMER_SUSPENDED

      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;

    • CONSUMER_INVALID

      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;

    • SECURITY_POLICY_VIOLATED

      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;

    • ACCESS_TOKEN_EXPIRED

      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;

    • ACCESS_TOKEN_SCOPE_INSUFFICIENT

      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;

    • ACCOUNT_STATE_INVALID

      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;

    • ACCESS_TOKEN_TYPE_UNSUPPORTED

      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;

    • UNRECOGNIZED

      public static final ErrorReason UNRECOGNIZED

  • Field Details

    • ERROR_REASON_UNSPECIFIED_VALUE

      public static final int ERROR_REASON_UNSPECIFIED_VALUE
       Do not use this default value.
      ERROR_REASON_UNSPECIFIED = 0;
      See Also:

    • SERVICE_DISABLED_VALUE

      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;
      See Also:

    • BILLING_DISABLED_VALUE

      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;
      See Also:

    • API_KEY_INVALID_VALUE

      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;
      See Also:

    • API_KEY_SERVICE_BLOCKED_VALUE

      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;
      See Also:

    • API_KEY_HTTP_REFERRER_BLOCKED_VALUE

      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;
      See Also:

    • API_KEY_IP_ADDRESS_BLOCKED_VALUE

      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;
      See Also:

    • API_KEY_ANDROID_APP_BLOCKED_VALUE

      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;
      See Also:

    • API_KEY_IOS_APP_BLOCKED_VALUE

      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;
      See Also:

    • RATE_LIMIT_EXCEEDED_VALUE

      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;
      See Also:

    • RESOURCE_QUOTA_EXCEEDED_VALUE

      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;
      See Also:

    • LOCATION_TAX_POLICY_VIOLATED_VALUE

      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;
      See Also:

    • USER_PROJECT_DENIED_VALUE

      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;
      See Also:

    • CONSUMER_SUSPENDED_VALUE

      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;
      See Also:

    • CONSUMER_INVALID_VALUE

      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;
      See Also:

    • SECURITY_POLICY_VIOLATED_VALUE

      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;
      See Also:

    • ACCESS_TOKEN_EXPIRED_VALUE

      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;
      See Also:

    • ACCESS_TOKEN_SCOPE_INSUFFICIENT_VALUE

      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;
      See Also:

    • ACCOUNT_STATE_INVALID_VALUE

      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;
      See Also:

    • ACCESS_TOKEN_TYPE_UNSUPPORTED_VALUE

      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;
      See Also:

  • Method Details

    • values

      public static ErrorReason[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ErrorReason valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static ErrorReason valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static ErrorReason forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<ErrorReason> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static ErrorReason valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null