| <!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:56 PDT 2019 --> |
| <title>com.google.rpc (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="com.google.rpc (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/longrunning/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../com/google/type/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/rpc/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package com.google.rpc</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/BadRequest.FieldViolationOrBuilder.html" title="interface in com.google.rpc">BadRequest.FieldViolationOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/BadRequestOrBuilder.html" title="interface in com.google.rpc">BadRequestOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/DebugInfoOrBuilder.html" title="interface in com.google.rpc">DebugInfoOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/Help.LinkOrBuilder.html" title="interface in com.google.rpc">Help.LinkOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/HelpOrBuilder.html" title="interface in com.google.rpc">HelpOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/LocalizedMessageOrBuilder.html" title="interface in com.google.rpc">LocalizedMessageOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/PreconditionFailure.ViolationOrBuilder.html" title="interface in com.google.rpc">PreconditionFailure.ViolationOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/PreconditionFailureOrBuilder.html" title="interface in com.google.rpc">PreconditionFailureOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/QuotaFailure.ViolationOrBuilder.html" title="interface in com.google.rpc">QuotaFailure.ViolationOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/QuotaFailureOrBuilder.html" title="interface in com.google.rpc">QuotaFailureOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/RequestInfoOrBuilder.html" title="interface in com.google.rpc">RequestInfoOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/ResourceInfoOrBuilder.html" title="interface in com.google.rpc">ResourceInfoOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/RetryInfoOrBuilder.html" title="interface in com.google.rpc">RetryInfoOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/StatusOrBuilder.html" title="interface in com.google.rpc">StatusOrBuilder</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/BadRequest.html" title="class in com.google.rpc">BadRequest</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes violations in a client request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/BadRequest.Builder.html" title="class in com.google.rpc">BadRequest.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes violations in a client request.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/BadRequest.FieldViolation.html" title="class in com.google.rpc">BadRequest.FieldViolation</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| A message type used to describe a single bad request field.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/BadRequest.FieldViolation.Builder.html" title="class in com.google.rpc">BadRequest.FieldViolation.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| A message type used to describe a single bad request field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/CodeProto.html" title="class in com.google.rpc">CodeProto</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/DebugInfo.html" title="class in com.google.rpc">DebugInfo</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes additional debugging info.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/DebugInfo.Builder.html" title="class in com.google.rpc">DebugInfo.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes additional debugging info.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/ErrorDetailsProto.html" title="class in com.google.rpc">ErrorDetailsProto</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/Help.html" title="class in com.google.rpc">Help</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Provides links to documentation or for performing an out of band action.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/Help.Builder.html" title="class in com.google.rpc">Help.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Provides links to documentation or for performing an out of band action.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/Help.Link.html" title="class in com.google.rpc">Help.Link</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes a URL link.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/Help.Link.Builder.html" title="class in com.google.rpc">Help.Link.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes a URL link.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/LocalizedMessage.html" title="class in com.google.rpc">LocalizedMessage</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Provides a localized error message that is safe to return to the user |
| which can be attached to an RPC error.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/LocalizedMessage.Builder.html" title="class in com.google.rpc">LocalizedMessage.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Provides a localized error message that is safe to return to the user |
| which can be attached to an RPC error.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/PreconditionFailure.html" title="class in com.google.rpc">PreconditionFailure</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes what preconditions have failed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/PreconditionFailure.Builder.html" title="class in com.google.rpc">PreconditionFailure.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes what preconditions have failed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/PreconditionFailure.Violation.html" title="class in com.google.rpc">PreconditionFailure.Violation</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| A message type used to describe a single precondition failure.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/PreconditionFailure.Violation.Builder.html" title="class in com.google.rpc">PreconditionFailure.Violation.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| A message type used to describe a single precondition failure.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/QuotaFailure.html" title="class in com.google.rpc">QuotaFailure</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes how a quota check failed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/QuotaFailure.Builder.html" title="class in com.google.rpc">QuotaFailure.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes how a quota check failed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/QuotaFailure.Violation.html" title="class in com.google.rpc">QuotaFailure.Violation</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| A message type used to describe a single quota violation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/QuotaFailure.Violation.Builder.html" title="class in com.google.rpc">QuotaFailure.Violation.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| A message type used to describe a single quota violation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/RequestInfo.html" title="class in com.google.rpc">RequestInfo</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Contains metadata about the request that clients can attach when filing a bug |
| or providing other forms of feedback.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/RequestInfo.Builder.html" title="class in com.google.rpc">RequestInfo.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Contains metadata about the request that clients can attach when filing a bug |
| or providing other forms of feedback.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/ResourceInfo.html" title="class in com.google.rpc">ResourceInfo</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes the resource that is being accessed.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/ResourceInfo.Builder.html" title="class in com.google.rpc">ResourceInfo.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes the resource that is being accessed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/RetryInfo.html" title="class in com.google.rpc">RetryInfo</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes when the clients can retry a failed request.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/RetryInfo.Builder.html" title="class in com.google.rpc">RetryInfo.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| Describes when the clients can retry a failed request.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/Status.html" title="class in com.google.rpc">Status</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| The `Status` type defines a logical error model that is suitable for |
| different programming environments, including REST APIs and RPC APIs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/Status.Builder.html" title="class in com.google.rpc">Status.Builder</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| The `Status` type defines a logical error model that is suitable for |
| different programming environments, including REST APIs and RPC APIs.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/StatusProto.html" title="class in com.google.rpc">StatusProto</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/google/rpc/Code.html" title="enum in com.google.rpc">Code</a></td> |
| <td class="colLast"> |
| <div class="block"> |
| The canonical error codes for Google APIs.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/longrunning/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../com/google/type/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/rpc/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
