| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181-google-v7) on Fri Oct 04 15:32:50 PDT 2019 --> |
| <title>Code (java API)</title> |
| <meta name="date" content="2019-10-04"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Code (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":41,"i8":9,"i9":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../com/google/rpc/BadRequestOrBuilder.html" title="interface in com.google.rpc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/rpc/CodeProto.html" title="class in com.google.rpc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/rpc/Code.html" target="_top">Frames</a></li> |
| <li><a href="Code.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.google.rpc</div> |
| <h2 title="Enum Code" class="title">Enum Code</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>java.lang.Enum<<a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.google.rpc.Code</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Internal.EnumLite.html?is-external=true" title="class or interface in com.google.protobuf">Internal.EnumLite</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ProtocolMessageEnum.html?is-external=true" title="class or interface in com.google.protobuf">ProtocolMessageEnum</a>, java.io.Serializable, java.lang.Comparable<<a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public enum <span class="typeNameLabel">Code</span> |
| extends java.lang.Enum<<a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a>> |
| implements <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ProtocolMessageEnum.html?is-external=true" title="class or interface in com.google.protobuf">ProtocolMessageEnum</a></pre> |
| <div class="block"><pre> |
| The canonical error codes for Google APIs. |
| Sometimes multiple error codes may apply. Services should return |
| the most specific error code that applies. For example, prefer |
| `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply. |
| Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`. |
| </pre> |
| |
| Protobuf enum <code>google.rpc.Code</code></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Enum Constant and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#ABORTED">ABORTED</a></span></code> |
| <div class="block"> |
| The operation was aborted, typically due to a concurrency issue such as |
| a sequencer check failure or transaction abort.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#ALREADY_EXISTS">ALREADY_EXISTS</a></span></code> |
| <div class="block"> |
| The entity that a client attempted to create (e.g., file or directory) |
| already exists.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#CANCELLED">CANCELLED</a></span></code> |
| <div class="block"> |
| The operation was cancelled, typically by the caller.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#DATA_LOSS">DATA_LOSS</a></span></code> |
| <div class="block"> |
| Unrecoverable data loss or corruption.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#DEADLINE_EXCEEDED">DEADLINE_EXCEEDED</a></span></code> |
| <div class="block"> |
| The deadline expired before the operation could complete.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#FAILED_PRECONDITION">FAILED_PRECONDITION</a></span></code> |
| <div class="block"> |
| The operation was rejected because the system is not in a state |
| required for the operation's execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#INTERNAL">INTERNAL</a></span></code> |
| <div class="block"> |
| Internal errors.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#INVALID_ARGUMENT">INVALID_ARGUMENT</a></span></code> |
| <div class="block"> |
| The client specified an invalid argument.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#NOT_FOUND">NOT_FOUND</a></span></code> |
| <div class="block"> |
| Some requested entity (e.g., file or directory) was not found.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#OK">OK</a></span></code> |
| <div class="block"> |
| Not an error; returned on success |
| HTTP Mapping: 200 OK</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#OUT_OF_RANGE">OUT_OF_RANGE</a></span></code> |
| <div class="block"> |
| The operation was attempted past the valid range.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#PERMISSION_DENIED">PERMISSION_DENIED</a></span></code> |
| <div class="block"> |
| The caller does not have permission to execute the specified |
| operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#RESOURCE_EXHAUSTED">RESOURCE_EXHAUSTED</a></span></code> |
| <div class="block"> |
| Some resource has been exhausted, perhaps a per-user quota, or |
| perhaps the entire file system is out of space.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNAUTHENTICATED">UNAUTHENTICATED</a></span></code> |
| <div class="block"> |
| The request does not have valid authentication credentials for the |
| operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNAVAILABLE">UNAVAILABLE</a></span></code> |
| <div class="block"> |
| The service is currently unavailable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNIMPLEMENTED">UNIMPLEMENTED</a></span></code> |
| <div class="block"> |
| The operation is not implemented or is not supported/enabled in this |
| service.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNKNOWN">UNKNOWN</a></span></code> |
| <div class="block"> |
| Unknown error.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNRECOGNIZED">UNRECOGNIZED</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#ABORTED_VALUE">ABORTED_VALUE</a></span></code> |
| <div class="block"> |
| The operation was aborted, typically due to a concurrency issue such as |
| a sequencer check failure or transaction abort.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#ALREADY_EXISTS_VALUE">ALREADY_EXISTS_VALUE</a></span></code> |
| <div class="block"> |
| The entity that a client attempted to create (e.g., file or directory) |
| already exists.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#CANCELLED_VALUE">CANCELLED_VALUE</a></span></code> |
| <div class="block"> |
| The operation was cancelled, typically by the caller.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#DATA_LOSS_VALUE">DATA_LOSS_VALUE</a></span></code> |
| <div class="block"> |
| Unrecoverable data loss or corruption.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#DEADLINE_EXCEEDED_VALUE">DEADLINE_EXCEEDED_VALUE</a></span></code> |
| <div class="block"> |
| The deadline expired before the operation could complete.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#FAILED_PRECONDITION_VALUE">FAILED_PRECONDITION_VALUE</a></span></code> |
| <div class="block"> |
| The operation was rejected because the system is not in a state |
| required for the operation's execution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#INTERNAL_VALUE">INTERNAL_VALUE</a></span></code> |
| <div class="block"> |
| Internal errors.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#INVALID_ARGUMENT_VALUE">INVALID_ARGUMENT_VALUE</a></span></code> |
| <div class="block"> |
| The client specified an invalid argument.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#NOT_FOUND_VALUE">NOT_FOUND_VALUE</a></span></code> |
| <div class="block"> |
| Some requested entity (e.g., file or directory) was not found.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#OK_VALUE">OK_VALUE</a></span></code> |
| <div class="block"> |
| Not an error; returned on success |
| HTTP Mapping: 200 OK</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#OUT_OF_RANGE_VALUE">OUT_OF_RANGE_VALUE</a></span></code> |
| <div class="block"> |
| The operation was attempted past the valid range.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#PERMISSION_DENIED_VALUE">PERMISSION_DENIED_VALUE</a></span></code> |
| <div class="block"> |
| The caller does not have permission to execute the specified |
| operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#RESOURCE_EXHAUSTED_VALUE">RESOURCE_EXHAUSTED_VALUE</a></span></code> |
| <div class="block"> |
| Some resource has been exhausted, perhaps a per-user quota, or |
| perhaps the entire file system is out of space.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNAUTHENTICATED_VALUE">UNAUTHENTICATED_VALUE</a></span></code> |
| <div class="block"> |
| The request does not have valid authentication credentials for the |
| operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNAVAILABLE_VALUE">UNAVAILABLE_VALUE</a></span></code> |
| <div class="block"> |
| The service is currently unavailable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNIMPLEMENTED_VALUE">UNIMPLEMENTED_VALUE</a></span></code> |
| <div class="block"> |
| The operation is not implemented or is not supported/enabled in this |
| service.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#UNKNOWN_VALUE">UNKNOWN_VALUE</a></span></code> |
| <div class="block"> |
| Unknown error.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#forNumber-int-">forNumber</a></span>(int value)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.EnumDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.EnumDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#getDescriptor--">getDescriptor</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.EnumDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.EnumDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#getDescriptorForType--">getDescriptorForType</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#getNumber--">getNumber</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.EnumValueDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.EnumValueDescriptor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#getValueDescriptor--">getValueDescriptor</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Internal.EnumLiteMap.html?is-external=true" title="class or interface in com.google.protobuf">Internal.EnumLiteMap</a><<a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#internalGetValueMap--">internalGetValueMap</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#valueOf-com.google.protobuf.Descriptors.EnumValueDescriptor-">valueOf</a></span>(<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.EnumValueDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.EnumValueDescriptor</a> desc)</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#valueOf-int-">valueOf</a></span>(int value)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../com/google/rpc/Code.html#forNumber-int-"><code>forNumber(int)</code></a> instead.</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String name)</code> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/rpc/Code.html#values--">values</a></span>()</code> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Enum</h3> |
| <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>getClass, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a name="OK"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OK</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> OK</pre> |
| <div class="block"><pre> |
| Not an error; returned on success |
| HTTP Mapping: 200 OK |
| </pre> |
| |
| <code>OK = 0;</code></div> |
| </li> |
| </ul> |
| <a name="CANCELLED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CANCELLED</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> CANCELLED</pre> |
| <div class="block"><pre> |
| The operation was cancelled, typically by the caller. |
| HTTP Mapping: 499 Client Closed Request |
| </pre> |
| |
| <code>CANCELLED = 1;</code></div> |
| </li> |
| </ul> |
| <a name="UNKNOWN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNKNOWN</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> UNKNOWN</pre> |
| <div class="block"><pre> |
| 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. |
| HTTP Mapping: 500 Internal Server Error |
| </pre> |
| |
| <code>UNKNOWN = 2;</code></div> |
| </li> |
| </ul> |
| <a name="INVALID_ARGUMENT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INVALID_ARGUMENT</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> INVALID_ARGUMENT</pre> |
| <div class="block"><pre> |
| 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). |
| HTTP Mapping: 400 Bad Request |
| </pre> |
| |
| <code>INVALID_ARGUMENT = 3;</code></div> |
| </li> |
| </ul> |
| <a name="DEADLINE_EXCEEDED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEADLINE_EXCEEDED</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> DEADLINE_EXCEEDED</pre> |
| <div class="block"><pre> |
| 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. |
| HTTP Mapping: 504 Gateway Timeout |
| </pre> |
| |
| <code>DEADLINE_EXCEEDED = 4;</code></div> |
| </li> |
| </ul> |
| <a name="NOT_FOUND"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NOT_FOUND</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> NOT_FOUND</pre> |
| <div class="block"><pre> |
| 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 whitelist, |
| `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. |
| HTTP Mapping: 404 Not Found |
| </pre> |
| |
| <code>NOT_FOUND = 5;</code></div> |
| </li> |
| </ul> |
| <a name="ALREADY_EXISTS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ALREADY_EXISTS</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> ALREADY_EXISTS</pre> |
| <div class="block"><pre> |
| The entity that a client attempted to create (e.g., file or directory) |
| already exists. |
| HTTP Mapping: 409 Conflict |
| </pre> |
| |
| <code>ALREADY_EXISTS = 6;</code></div> |
| </li> |
| </ul> |
| <a name="PERMISSION_DENIED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PERMISSION_DENIED</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> PERMISSION_DENIED</pre> |
| <div class="block"><pre> |
| 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. |
| HTTP Mapping: 403 Forbidden |
| </pre> |
| |
| <code>PERMISSION_DENIED = 7;</code></div> |
| </li> |
| </ul> |
| <a name="UNAUTHENTICATED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNAUTHENTICATED</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> UNAUTHENTICATED</pre> |
| <div class="block"><pre> |
| The request does not have valid authentication credentials for the |
| operation. |
| HTTP Mapping: 401 Unauthorized |
| </pre> |
| |
| <code>UNAUTHENTICATED = 16;</code></div> |
| </li> |
| </ul> |
| <a name="RESOURCE_EXHAUSTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESOURCE_EXHAUSTED</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> RESOURCE_EXHAUSTED</pre> |
| <div class="block"><pre> |
| Some resource has been exhausted, perhaps a per-user quota, or |
| perhaps the entire file system is out of space. |
| HTTP Mapping: 429 Too Many Requests |
| </pre> |
| |
| <code>RESOURCE_EXHAUSTED = 8;</code></div> |
| </li> |
| </ul> |
| <a name="FAILED_PRECONDITION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FAILED_PRECONDITION</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> FAILED_PRECONDITION</pre> |
| <div class="block"><pre> |
| 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. |
| Service implementors can use the following guidelines to decide |
| 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. |
| HTTP Mapping: 400 Bad Request |
| </pre> |
| |
| <code>FAILED_PRECONDITION = 9;</code></div> |
| </li> |
| </ul> |
| <a name="ABORTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ABORTED</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> ABORTED</pre> |
| <div class="block"><pre> |
| The operation was aborted, typically due to a concurrency issue such as |
| a sequencer check failure or transaction abort. |
| See the guidelines above for deciding between `FAILED_PRECONDITION`, |
| `ABORTED`, and `UNAVAILABLE`. |
| HTTP Mapping: 409 Conflict |
| </pre> |
| |
| <code>ABORTED = 10;</code></div> |
| </li> |
| </ul> |
| <a name="OUT_OF_RANGE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OUT_OF_RANGE</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> OUT_OF_RANGE</pre> |
| <div class="block"><pre> |
| 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. |
| HTTP Mapping: 400 Bad Request |
| </pre> |
| |
| <code>OUT_OF_RANGE = 11;</code></div> |
| </li> |
| </ul> |
| <a name="UNIMPLEMENTED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNIMPLEMENTED</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> UNIMPLEMENTED</pre> |
| <div class="block"><pre> |
| The operation is not implemented or is not supported/enabled in this |
| service. |
| HTTP Mapping: 501 Not Implemented |
| </pre> |
| |
| <code>UNIMPLEMENTED = 12;</code></div> |
| </li> |
| </ul> |
| <a name="INTERNAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INTERNAL</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> INTERNAL</pre> |
| <div class="block"><pre> |
| Internal errors. This means that some invariants expected by the |
| underlying system have been broken. This error code is reserved |
| for serious errors. |
| HTTP Mapping: 500 Internal Server Error |
| </pre> |
| |
| <code>INTERNAL = 13;</code></div> |
| </li> |
| </ul> |
| <a name="UNAVAILABLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNAVAILABLE</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> UNAVAILABLE</pre> |
| <div class="block"><pre> |
| The service is currently unavailable. This is most likely a |
| transient condition, which can be corrected by retrying with |
| a backoff. |
| See the guidelines above for deciding between `FAILED_PRECONDITION`, |
| `ABORTED`, and `UNAVAILABLE`. |
| HTTP Mapping: 503 Service Unavailable |
| </pre> |
| |
| <code>UNAVAILABLE = 14;</code></div> |
| </li> |
| </ul> |
| <a name="DATA_LOSS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DATA_LOSS</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> DATA_LOSS</pre> |
| <div class="block"><pre> |
| Unrecoverable data loss or corruption. |
| HTTP Mapping: 500 Internal Server Error |
| </pre> |
| |
| <code>DATA_LOSS = 15;</code></div> |
| </li> |
| </ul> |
| <a name="UNRECOGNIZED"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>UNRECOGNIZED</h4> |
| <pre>public static final <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> UNRECOGNIZED</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="OK_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OK_VALUE</h4> |
| <pre>public static final int OK_VALUE</pre> |
| <div class="block"><pre> |
| Not an error; returned on success |
| HTTP Mapping: 200 OK |
| </pre> |
| |
| <code>OK = 0;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.OK_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CANCELLED_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CANCELLED_VALUE</h4> |
| <pre>public static final int CANCELLED_VALUE</pre> |
| <div class="block"><pre> |
| The operation was cancelled, typically by the caller. |
| HTTP Mapping: 499 Client Closed Request |
| </pre> |
| |
| <code>CANCELLED = 1;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.CANCELLED_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="UNKNOWN_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNKNOWN_VALUE</h4> |
| <pre>public static final int UNKNOWN_VALUE</pre> |
| <div class="block"><pre> |
| 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. |
| HTTP Mapping: 500 Internal Server Error |
| </pre> |
| |
| <code>UNKNOWN = 2;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.UNKNOWN_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="INVALID_ARGUMENT_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INVALID_ARGUMENT_VALUE</h4> |
| <pre>public static final int INVALID_ARGUMENT_VALUE</pre> |
| <div class="block"><pre> |
| 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). |
| HTTP Mapping: 400 Bad Request |
| </pre> |
| |
| <code>INVALID_ARGUMENT = 3;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.INVALID_ARGUMENT_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEADLINE_EXCEEDED_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEADLINE_EXCEEDED_VALUE</h4> |
| <pre>public static final int DEADLINE_EXCEEDED_VALUE</pre> |
| <div class="block"><pre> |
| 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. |
| HTTP Mapping: 504 Gateway Timeout |
| </pre> |
| |
| <code>DEADLINE_EXCEEDED = 4;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.DEADLINE_EXCEEDED_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="NOT_FOUND_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NOT_FOUND_VALUE</h4> |
| <pre>public static final int NOT_FOUND_VALUE</pre> |
| <div class="block"><pre> |
| 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 whitelist, |
| `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. |
| HTTP Mapping: 404 Not Found |
| </pre> |
| |
| <code>NOT_FOUND = 5;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.NOT_FOUND_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ALREADY_EXISTS_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ALREADY_EXISTS_VALUE</h4> |
| <pre>public static final int ALREADY_EXISTS_VALUE</pre> |
| <div class="block"><pre> |
| The entity that a client attempted to create (e.g., file or directory) |
| already exists. |
| HTTP Mapping: 409 Conflict |
| </pre> |
| |
| <code>ALREADY_EXISTS = 6;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.ALREADY_EXISTS_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="PERMISSION_DENIED_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PERMISSION_DENIED_VALUE</h4> |
| <pre>public static final int PERMISSION_DENIED_VALUE</pre> |
| <div class="block"><pre> |
| 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. |
| HTTP Mapping: 403 Forbidden |
| </pre> |
| |
| <code>PERMISSION_DENIED = 7;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.PERMISSION_DENIED_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="UNAUTHENTICATED_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNAUTHENTICATED_VALUE</h4> |
| <pre>public static final int UNAUTHENTICATED_VALUE</pre> |
| <div class="block"><pre> |
| The request does not have valid authentication credentials for the |
| operation. |
| HTTP Mapping: 401 Unauthorized |
| </pre> |
| |
| <code>UNAUTHENTICATED = 16;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.UNAUTHENTICATED_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="RESOURCE_EXHAUSTED_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESOURCE_EXHAUSTED_VALUE</h4> |
| <pre>public static final int RESOURCE_EXHAUSTED_VALUE</pre> |
| <div class="block"><pre> |
| Some resource has been exhausted, perhaps a per-user quota, or |
| perhaps the entire file system is out of space. |
| HTTP Mapping: 429 Too Many Requests |
| </pre> |
| |
| <code>RESOURCE_EXHAUSTED = 8;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.RESOURCE_EXHAUSTED_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FAILED_PRECONDITION_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FAILED_PRECONDITION_VALUE</h4> |
| <pre>public static final int FAILED_PRECONDITION_VALUE</pre> |
| <div class="block"><pre> |
| 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. |
| Service implementors can use the following guidelines to decide |
| 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. |
| HTTP Mapping: 400 Bad Request |
| </pre> |
| |
| <code>FAILED_PRECONDITION = 9;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.FAILED_PRECONDITION_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ABORTED_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ABORTED_VALUE</h4> |
| <pre>public static final int ABORTED_VALUE</pre> |
| <div class="block"><pre> |
| The operation was aborted, typically due to a concurrency issue such as |
| a sequencer check failure or transaction abort. |
| See the guidelines above for deciding between `FAILED_PRECONDITION`, |
| `ABORTED`, and `UNAVAILABLE`. |
| HTTP Mapping: 409 Conflict |
| </pre> |
| |
| <code>ABORTED = 10;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.ABORTED_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="OUT_OF_RANGE_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OUT_OF_RANGE_VALUE</h4> |
| <pre>public static final int OUT_OF_RANGE_VALUE</pre> |
| <div class="block"><pre> |
| 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. |
| HTTP Mapping: 400 Bad Request |
| </pre> |
| |
| <code>OUT_OF_RANGE = 11;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.OUT_OF_RANGE_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="UNIMPLEMENTED_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNIMPLEMENTED_VALUE</h4> |
| <pre>public static final int UNIMPLEMENTED_VALUE</pre> |
| <div class="block"><pre> |
| The operation is not implemented or is not supported/enabled in this |
| service. |
| HTTP Mapping: 501 Not Implemented |
| </pre> |
| |
| <code>UNIMPLEMENTED = 12;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.UNIMPLEMENTED_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="INTERNAL_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INTERNAL_VALUE</h4> |
| <pre>public static final int INTERNAL_VALUE</pre> |
| <div class="block"><pre> |
| Internal errors. This means that some invariants expected by the |
| underlying system have been broken. This error code is reserved |
| for serious errors. |
| HTTP Mapping: 500 Internal Server Error |
| </pre> |
| |
| <code>INTERNAL = 13;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.INTERNAL_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="UNAVAILABLE_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNAVAILABLE_VALUE</h4> |
| <pre>public static final int UNAVAILABLE_VALUE</pre> |
| <div class="block"><pre> |
| The service is currently unavailable. This is most likely a |
| transient condition, which can be corrected by retrying with |
| a backoff. |
| See the guidelines above for deciding between `FAILED_PRECONDITION`, |
| `ABORTED`, and `UNAVAILABLE`. |
| HTTP Mapping: 503 Service Unavailable |
| </pre> |
| |
| <code>UNAVAILABLE = 14;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.UNAVAILABLE_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DATA_LOSS_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DATA_LOSS_VALUE</h4> |
| <pre>public static final int DATA_LOSS_VALUE</pre> |
| <div class="block"><pre> |
| Unrecoverable data loss or corruption. |
| HTTP Mapping: 500 Internal Server Error |
| </pre> |
| |
| <code>DATA_LOSS = 15;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.rpc.Code.DATA_LOSS_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="values--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (Code c : Code.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>public static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> valueOf(java.lang.String name)</pre> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> |
| <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNumber--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumber</h4> |
| <pre>public final int getNumber()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Internal.EnumLite.html?is-external=true#getNumber--" title="class or interface in com.google.protobuf">getNumber</a></code> in interface <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Internal.EnumLite.html?is-external=true" title="class or interface in com.google.protobuf">Internal.EnumLite</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ProtocolMessageEnum.html?is-external=true#getNumber--" title="class or interface in com.google.protobuf">getNumber</a></code> in interface <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ProtocolMessageEnum.html?is-external=true" title="class or interface in com.google.protobuf">ProtocolMessageEnum</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueOf-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>@Deprecated |
| public static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> valueOf(int value)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../com/google/rpc/Code.html#forNumber-int-"><code>forNumber(int)</code></a> instead.</span></div> |
| </li> |
| </ul> |
| <a name="forNumber-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forNumber</h4> |
| <pre>public static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> forNumber(int value)</pre> |
| </li> |
| </ul> |
| <a name="internalGetValueMap--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>internalGetValueMap</h4> |
| <pre>public static <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Internal.EnumLiteMap.html?is-external=true" title="class or interface in com.google.protobuf">Internal.EnumLiteMap</a><<a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a>> internalGetValueMap()</pre> |
| </li> |
| </ul> |
| <a name="getValueDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueDescriptor</h4> |
| <pre>public final <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.EnumValueDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.EnumValueDescriptor</a> getValueDescriptor()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ProtocolMessageEnum.html?is-external=true#getValueDescriptor--" title="class or interface in com.google.protobuf">getValueDescriptor</a></code> in interface <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ProtocolMessageEnum.html?is-external=true" title="class or interface in com.google.protobuf">ProtocolMessageEnum</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDescriptorForType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptorForType</h4> |
| <pre>public final <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.EnumDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.EnumDescriptor</a> getDescriptorForType()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ProtocolMessageEnum.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf">getDescriptorForType</a></code> in interface <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ProtocolMessageEnum.html?is-external=true" title="class or interface in com.google.protobuf">ProtocolMessageEnum</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDescriptor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptor</h4> |
| <pre>public static final <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.EnumDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.EnumDescriptor</a> getDescriptor()</pre> |
| </li> |
| </ul> |
| <a name="valueOf-com.google.protobuf.Descriptors.EnumValueDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>public static <a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a> valueOf(<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Descriptors.EnumValueDescriptor.html?is-external=true" title="class or interface in com.google.protobuf">Descriptors.EnumValueDescriptor</a> desc)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../com/google/rpc/BadRequestOrBuilder.html" title="interface in com.google.rpc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/rpc/CodeProto.html" title="class in com.google.rpc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/rpc/Code.html" target="_top">Frames</a></li> |
| <li><a href="Code.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
