com.google.apphosting.base.protos.Codes Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of appengine-api-1.0-sdk
Show all versions of appengine-api-1.0-sdk
API for Google App Engine standard environment with some of the dependencies shaded (repackaged)
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: codes.proto
package com.google.apphosting.base.protos;
public final class Codes {
private Codes() {}
public static void registerAllExtensions(
com.google.protobuf.ExtensionRegistryLite registry) {
}
public static void registerAllExtensions(
com.google.protobuf.ExtensionRegistry registry) {
registerAllExtensions(
(com.google.protobuf.ExtensionRegistryLite) registry);
}
/**
*
* The canonical error codes for Google3 APIs.
*
*
* Protobuf enum {@code util.error.Code}
*/
public enum Code
implements com.google.protobuf.ProtocolMessageEnum {
/**
*
* Not an error; returned on success
*
*
* OK = 0;
*/
OK(0),
/**
*
* The operation was cancelled, typically by the caller.
*
*
* CANCELLED = 1;
*/
CANCELLED(1),
/**
*
* Unknown error. For example, this error may be returned when
* a Status value received from another address space belongs to
* an error-space that is not known in this address space. Also
* errors raised by APIs that do not return enough error information
* may be converted to this error.
*
*
* UNKNOWN = 2;
*/
UNKNOWN(2),
/**
*
* The client specified an invalid argument. Note that this differs
* from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
* that are problematic regardless of the state of the system
* (e.g., a malformed file name).
*
*
* INVALID_ARGUMENT = 3;
*/
INVALID_ARGUMENT(3),
/**
*
* The deadline expired before the operation could complete. For operations
* that change the state of the system, this error may be returned
* even if the operation has completed successfully. For example, a
* successful response from a server could have been delayed long
* enough for the deadline to expire.
*
*
* DEADLINE_EXCEEDED = 4;
*/
DEADLINE_EXCEEDED(4),
/**
*
* Some requested entity (e.g., file or directory) was not found.
* Note to server developers: if a request is denied for an entire class
* of users, such as gradual feature rollout or undocumented allowlist,
* `NOT_FOUND` may be used. If a request is denied for some users within
* a class of users, such as user-based access control, `PERMISSION_DENIED`
* must be used.
*
*
* NOT_FOUND = 5;
*/
NOT_FOUND(5),
/**
*
* The entity that a client attempted to create (e.g., file or directory)
* already exists.
*
*
* ALREADY_EXISTS = 6;
*/
ALREADY_EXISTS(6),
/**
*
* The caller does not have permission to execute the specified
* operation. `PERMISSION_DENIED` must not be used for rejections
* caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
* instead for those errors). `PERMISSION_DENIED` must not be
* used if the caller can not be identified (use `UNAUTHENTICATED`
* instead for those errors). This error code does not imply the
* request is valid or the requested entity exists or satisfies
* other pre-conditions.
*
*
* PERMISSION_DENIED = 7;
*/
PERMISSION_DENIED(7),
/**
*
* The request does not have valid authentication credentials for the
* operation.
*
*
* UNAUTHENTICATED = 16;
*/
UNAUTHENTICATED(16),
/**
*
* Some resource has been exhausted, perhaps a per-user quota, or
* perhaps the entire file system is out of space.
*
*
* RESOURCE_EXHAUSTED = 8;
*/
RESOURCE_EXHAUSTED(8),
/**
*
* The operation was rejected because the system is not in a state
* required for the operation's execution. For example, the directory
* to be deleted is non-empty, an rmdir operation is applied to
* a non-directory, etc.
* A litmus test that may help a service implementer in deciding
* between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE:
* (a) Use UNAVAILABLE if the client can retry just the failing call.
* (b) Use ABORTED if the client should retry at a higher-level
* (e.g., when a client-specified test-and-set fails, indicating the
* client should restart a read-modify-write sequence).
* (c) Use FAILED_PRECONDITION if the client should not retry until
* the system state has been explicitly fixed. E.g., if an "rmdir"
* fails because the directory is non-empty, FAILED_PRECONDITION
* should be returned since the client should not retry unless
* the files are deleted from the directory.
*
*
* FAILED_PRECONDITION = 9;
*/
FAILED_PRECONDITION(9),
/**
*
* The operation was aborted, typically due to a concurrency issue such as
* a sequencer check failure or transaction abort.
* See litmus test above for deciding between FAILED_PRECONDITION,
* ABORTED, and UNAVAILABLE.
*
*
* ABORTED = 10;
*/
ABORTED(10),
/**
*
* The operation was attempted past the valid range. E.g., seeking or
* reading past end-of-file.
* Unlike INVALID_ARGUMENT, this error indicates a problem that may
* be fixed if the system state changes. For example, a 32-bit file
* system will generate INVALID_ARGUMENT if asked to read at an
* offset that is not in the range [0,2^32-1], but it will generate
* OUT_OF_RANGE if asked to read from an offset past the current
* file size.
* There is a fair bit of overlap between FAILED_PRECONDITION and
* OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific
* error) when it applies so that callers who are iterating through
* a space can easily look for an OUT_OF_RANGE error to detect when
* they are done.
*
*
* OUT_OF_RANGE = 11;
*/
OUT_OF_RANGE(11),
/**
*
* The operation is not implemented or is not supported/enabled in this
* service.
*
*
* UNIMPLEMENTED = 12;
*/
UNIMPLEMENTED(12),
/**
*
* Internal errors. This means that some invariants expected by the
* underlying system have been broken. This error code is reserved
* for serious errors.
*
*
* INTERNAL = 13;
*/
INTERNAL(13),
/**
*
* The service is currently unavailable. This is most likely a
* transient condition, which can be corrected by retrying with
* a backoff. Note that it is not always safe to retry
* non-idempotent operations.
* See litmus test above for deciding between FAILED_PRECONDITION,
* ABORTED, and UNAVAILABLE.
*
*
* UNAVAILABLE = 14;
*/
UNAVAILABLE(14),
/**
*
* Unrecoverable data loss or corruption.
*
*
* DATA_LOSS = 15;
*/
DATA_LOSS(15),
/**
*
* An extra enum entry to prevent people from writing code that
* fails to compile when a new code is added.
* Nobody should ever reference this enumeration entry. In particular,
* if you write C++ code that switches on this enumeration, add a default:
* case instead of a case that mentions this enumeration entry.
* Nobody should rely on the value (currently 20) listed here. It
* may change in the future.
*
*
* DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_ = 20;
*/
DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_(20),
;
/**
*
* Not an error; returned on success
*
*
* OK = 0;
*/
public static final int OK_VALUE = 0;
/**
*
* The operation was cancelled, typically by the caller.
*
*
* CANCELLED = 1;
*/
public static final int CANCELLED_VALUE = 1;
/**
*
* Unknown error. For example, this error may be returned when
* a Status value received from another address space belongs to
* an error-space that is not known in this address space. Also
* errors raised by APIs that do not return enough error information
* may be converted to this error.
*
*
* UNKNOWN = 2;
*/
public static final int UNKNOWN_VALUE = 2;
/**
*
* The client specified an invalid argument. Note that this differs
* from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments
* that are problematic regardless of the state of the system
* (e.g., a malformed file name).
*
*
* INVALID_ARGUMENT = 3;
*/
public static final int INVALID_ARGUMENT_VALUE = 3;
/**
*
* The deadline expired before the operation could complete. For operations
* that change the state of the system, this error may be returned
* even if the operation has completed successfully. For example, a
* successful response from a server could have been delayed long
* enough for the deadline to expire.
*
*
* DEADLINE_EXCEEDED = 4;
*/
public static final int DEADLINE_EXCEEDED_VALUE = 4;
/**
*
* Some requested entity (e.g., file or directory) was not found.
* Note to server developers: if a request is denied for an entire class
* of users, such as gradual feature rollout or undocumented allowlist,
* `NOT_FOUND` may be used. If a request is denied for some users within
* a class of users, such as user-based access control, `PERMISSION_DENIED`
* must be used.
*
*
* NOT_FOUND = 5;
*/
public static final int NOT_FOUND_VALUE = 5;
/**
*
* The entity that a client attempted to create (e.g., file or directory)
* already exists.
*
*
* ALREADY_EXISTS = 6;
*/
public static final int ALREADY_EXISTS_VALUE = 6;
/**
*
* The caller does not have permission to execute the specified
* operation. `PERMISSION_DENIED` must not be used for rejections
* caused by exhausting some resource (use `RESOURCE_EXHAUSTED`
* instead for those errors). `PERMISSION_DENIED` must not be
* used if the caller can not be identified (use `UNAUTHENTICATED`
* instead for those errors). This error code does not imply the
* request is valid or the requested entity exists or satisfies
* other pre-conditions.
*
*
* PERMISSION_DENIED = 7;
*/
public static final int PERMISSION_DENIED_VALUE = 7;
/**
*
* The request does not have valid authentication credentials for the
* operation.
*
*
* UNAUTHENTICATED = 16;
*/
public static final int UNAUTHENTICATED_VALUE = 16;
/**
*
* Some resource has been exhausted, perhaps a per-user quota, or
* perhaps the entire file system is out of space.
*
*
* RESOURCE_EXHAUSTED = 8;
*/
public static final int RESOURCE_EXHAUSTED_VALUE = 8;
/**
*
* The operation was rejected because the system is not in a state
* required for the operation's execution. For example, the directory
* to be deleted is non-empty, an rmdir operation is applied to
* a non-directory, etc.
* A litmus test that may help a service implementer in deciding
* between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE:
* (a) Use UNAVAILABLE if the client can retry just the failing call.
* (b) Use ABORTED if the client should retry at a higher-level
* (e.g., when a client-specified test-and-set fails, indicating the
* client should restart a read-modify-write sequence).
* (c) Use FAILED_PRECONDITION if the client should not retry until
* the system state has been explicitly fixed. E.g., if an "rmdir"
* fails because the directory is non-empty, FAILED_PRECONDITION
* should be returned since the client should not retry unless
* the files are deleted from the directory.
*
*
* FAILED_PRECONDITION = 9;
*/
public static final int FAILED_PRECONDITION_VALUE = 9;
/**
*
* The operation was aborted, typically due to a concurrency issue such as
* a sequencer check failure or transaction abort.
* See litmus test above for deciding between FAILED_PRECONDITION,
* ABORTED, and UNAVAILABLE.
*
*
* ABORTED = 10;
*/
public static final int ABORTED_VALUE = 10;
/**
*
* The operation was attempted past the valid range. E.g., seeking or
* reading past end-of-file.
* Unlike INVALID_ARGUMENT, this error indicates a problem that may
* be fixed if the system state changes. For example, a 32-bit file
* system will generate INVALID_ARGUMENT if asked to read at an
* offset that is not in the range [0,2^32-1], but it will generate
* OUT_OF_RANGE if asked to read from an offset past the current
* file size.
* There is a fair bit of overlap between FAILED_PRECONDITION and
* OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific
* error) when it applies so that callers who are iterating through
* a space can easily look for an OUT_OF_RANGE error to detect when
* they are done.
*
*
* OUT_OF_RANGE = 11;
*/
public static final int OUT_OF_RANGE_VALUE = 11;
/**
*
* The operation is not implemented or is not supported/enabled in this
* service.
*
*
* UNIMPLEMENTED = 12;
*/
public static final int UNIMPLEMENTED_VALUE = 12;
/**
*
* Internal errors. This means that some invariants expected by the
* underlying system have been broken. This error code is reserved
* for serious errors.
*
*
* INTERNAL = 13;
*/
public static final int INTERNAL_VALUE = 13;
/**
*
* The service is currently unavailable. This is most likely a
* transient condition, which can be corrected by retrying with
* a backoff. Note that it is not always safe to retry
* non-idempotent operations.
* See litmus test above for deciding between FAILED_PRECONDITION,
* ABORTED, and UNAVAILABLE.
*
*
* UNAVAILABLE = 14;
*/
public static final int UNAVAILABLE_VALUE = 14;
/**
*
* Unrecoverable data loss or corruption.
*
*
* DATA_LOSS = 15;
*/
public static final int DATA_LOSS_VALUE = 15;
/**
*
* An extra enum entry to prevent people from writing code that
* fails to compile when a new code is added.
* Nobody should ever reference this enumeration entry. In particular,
* if you write C++ code that switches on this enumeration, add a default:
* case instead of a case that mentions this enumeration entry.
* Nobody should rely on the value (currently 20) listed here. It
* may change in the future.
*
*
* DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_ = 20;
*/
public static final int DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD__VALUE = 20;
public final int getNumber() {
return value;
}
/**
* @param value The numeric wire value of the corresponding enum entry.
* @return The enum associated with the given numeric wire value.
* @deprecated Use {@link #forNumber(int)} instead.
*/
@java.lang.Deprecated
public static Code valueOf(int value) {
return forNumber(value);
}
/**
* @param value The numeric wire value of the corresponding enum entry.
* @return The enum associated with the given numeric wire value.
*/
public static Code forNumber(int value) {
switch (value) {
case 0: return OK;
case 1: return CANCELLED;
case 2: return UNKNOWN;
case 3: return INVALID_ARGUMENT;
case 4: return DEADLINE_EXCEEDED;
case 5: return NOT_FOUND;
case 6: return ALREADY_EXISTS;
case 7: return PERMISSION_DENIED;
case 16: return UNAUTHENTICATED;
case 8: return RESOURCE_EXHAUSTED;
case 9: return FAILED_PRECONDITION;
case 10: return ABORTED;
case 11: return OUT_OF_RANGE;
case 12: return UNIMPLEMENTED;
case 13: return INTERNAL;
case 14: return UNAVAILABLE;
case 15: return DATA_LOSS;
case 20: return DO_NOT_USE_RESERVED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_SWITCH_INSTEAD_;
default: return null;
}
}
public static com.google.protobuf.Internal.EnumLiteMap
internalGetValueMap() {
return internalValueMap;
}
private static final com.google.protobuf.Internal.EnumLiteMap<
Code> internalValueMap =
new com.google.protobuf.Internal.EnumLiteMap() {
public Code findValueByNumber(int number) {
return Code.forNumber(number);
}
};
public final com.google.protobuf.Descriptors.EnumValueDescriptor
getValueDescriptor() {
return getDescriptor().getValues().get(ordinal());
}
public final com.google.protobuf.Descriptors.EnumDescriptor
getDescriptorForType() {
return getDescriptor();
}
public static final com.google.protobuf.Descriptors.EnumDescriptor
getDescriptor() {
return com.google.apphosting.base.protos.Codes.getDescriptor().getEnumTypes().get(0);
}
private static final Code[] VALUES = values();
public static Code valueOf(
com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
if (desc.getType() != getDescriptor()) {
throw new java.lang.IllegalArgumentException(
"EnumValueDescriptor is not for this type.");
}
return VALUES[desc.getIndex()];
}
private final int value;
private Code(int value) {
this.value = value;
}
// @@protoc_insertion_point(enum_scope:util.error.Code)
}
public static com.google.protobuf.Descriptors.FileDescriptor
getDescriptor() {
return descriptor;
}
private static com.google.protobuf.Descriptors.FileDescriptor
descriptor;
static {
java.lang.String[] descriptorData = {
"\n\013codes.proto\022\nutil.error*\204\003\n\004Code\022\006\n\002OK" +
"\020\000\022\r\n\tCANCELLED\020\001\022\013\n\007UNKNOWN\020\002\022\024\n\020INVALI" +
"D_ARGUMENT\020\003\022\025\n\021DEADLINE_EXCEEDED\020\004\022\r\n\tN" +
"OT_FOUND\020\005\022\022\n\016ALREADY_EXISTS\020\006\022\025\n\021PERMIS" +
"SION_DENIED\020\007\022\023\n\017UNAUTHENTICATED\020\020\022\026\n\022RE" +
"SOURCE_EXHAUSTED\020\010\022\027\n\023FAILED_PRECONDITIO" +
"N\020\t\022\013\n\007ABORTED\020\n\022\020\n\014OUT_OF_RANGE\020\013\022\021\n\rUN" +
"IMPLEMENTED\020\014\022\014\n\010INTERNAL\020\r\022\017\n\013UNAVAILAB" +
"LE\020\016\022\r\n\tDATA_LOSS\020\017\022K\nGDO_NOT_USE_RESERV" +
"ED_FOR_FUTURE_EXPANSION_USE_DEFAULT_IN_S" +
"WITCH_INSTEAD_\020\024B#\n!com.google.apphostin" +
"g.base.protos"
};
descriptor = com.google.protobuf.Descriptors.FileDescriptor
.internalBuildGeneratedFileFrom(descriptorData,
new com.google.protobuf.Descriptors.FileDescriptor[] {
});
}
// @@protoc_insertion_point(outer_class_scope)
}