| <!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:53 PDT 2019 --> |
| <title>BackendRule.PathTranslation (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="BackendRule.PathTranslation (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/api/BackendRule.Builder.html" title="class in com.google.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/api/BackendRuleOrBuilder.html" title="interface in com.google.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/api/BackendRule.PathTranslation.html" target="_top">Frames</a></li> |
| <li><a href="BackendRule.PathTranslation.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.api</div> |
| <h2 title="Enum BackendRule.PathTranslation" class="title">Enum BackendRule.PathTranslation</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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.google.api.BackendRule.PathTranslation</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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a>></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../com/google/api/BackendRule.html" title="class in com.google.api">BackendRule</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static enum <span class="typeNameLabel">BackendRule.PathTranslation</span> |
| extends java.lang.Enum<<a href="../../../com/google/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</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> |
| Path Translation specifies how to combine the backend address with the |
| request path in order to produce the appropriate forwarding URL for the |
| request. |
| Path Translation is applicable only to HTTP-based backends. Backends which |
| do not accept requests over HTTP/HTTPS should leave `path_translation` |
| unspecified. |
| </pre> |
| |
| Protobuf enum <code>google.api.BackendRule.PathTranslation</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/api/BackendRule.PathTranslation.html#APPEND_PATH_TO_ADDRESS">APPEND_PATH_TO_ADDRESS</a></span></code> |
| <div class="block"> |
| The request path will be appended to the backend address.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.html#CONSTANT_ADDRESS">CONSTANT_ADDRESS</a></span></code> |
| <div class="block"> |
| Use the backend address as-is, with no modification to the path.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.html#PATH_TRANSLATION_UNSPECIFIED">PATH_TRANSLATION_UNSPECIFIED</a></span></code> |
| <div class="block"><code>PATH_TRANSLATION_UNSPECIFIED = 0;</code></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.html#APPEND_PATH_TO_ADDRESS_VALUE">APPEND_PATH_TO_ADDRESS_VALUE</a></span></code> |
| <div class="block"> |
| The request path will be appended to the backend address.</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/api/BackendRule.PathTranslation.html#CONSTANT_ADDRESS_VALUE">CONSTANT_ADDRESS_VALUE</a></span></code> |
| <div class="block"> |
| Use the backend address as-is, with no modification to the path.</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/api/BackendRule.PathTranslation.html#PATH_TRANSLATION_UNSPECIFIED_VALUE">PATH_TRANSLATION_UNSPECIFIED_VALUE</a></span></code> |
| <div class="block"><code>PATH_TRANSLATION_UNSPECIFIED = 0;</code></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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.html#internalGetValueMap--">internalGetValueMap</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../com/google/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/BackendRule.PathTranslation.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="PATH_TRANSLATION_UNSPECIFIED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PATH_TRANSLATION_UNSPECIFIED</h4> |
| <pre>public static final <a href="../../../com/google/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a> PATH_TRANSLATION_UNSPECIFIED</pre> |
| <div class="block"><code>PATH_TRANSLATION_UNSPECIFIED = 0;</code></div> |
| </li> |
| </ul> |
| <a name="CONSTANT_ADDRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONSTANT_ADDRESS</h4> |
| <pre>public static final <a href="../../../com/google/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a> CONSTANT_ADDRESS</pre> |
| <div class="block"><pre> |
| Use the backend address as-is, with no modification to the path. If the |
| URL pattern contains variables, the variable names and values will be |
| appended to the query string. If a query string parameter and a URL |
| pattern variable have the same name, this may result in duplicate keys in |
| the query string. |
| # Examples |
| Given the following operation config: |
| Method path: /api/company/{cid}/user/{uid} |
| Backend address: https://example.cloudfunctions.net/getUser |
| Requests to the following request paths will call the backend at the |
| translated path: |
| Request path: /api/company/widgetworks/user/johndoe |
| Translated: |
| https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe |
| Request path: /api/company/widgetworks/user/johndoe?timezone=EST |
| Translated: |
| https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
| </pre> |
| |
| <code>CONSTANT_ADDRESS = 1;</code></div> |
| </li> |
| </ul> |
| <a name="APPEND_PATH_TO_ADDRESS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>APPEND_PATH_TO_ADDRESS</h4> |
| <pre>public static final <a href="../../../com/google/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a> APPEND_PATH_TO_ADDRESS</pre> |
| <div class="block"><pre> |
| The request path will be appended to the backend address. |
| # Examples |
| Given the following operation config: |
| Method path: /api/company/{cid}/user/{uid} |
| Backend address: https://example.appspot.com |
| Requests to the following request paths will call the backend at the |
| translated path: |
| Request path: /api/company/widgetworks/user/johndoe |
| Translated: |
| https://example.appspot.com/api/company/widgetworks/user/johndoe |
| Request path: /api/company/widgetworks/user/johndoe?timezone=EST |
| Translated: |
| https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| </pre> |
| |
| <code>APPEND_PATH_TO_ADDRESS = 2;</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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</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="PATH_TRANSLATION_UNSPECIFIED_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PATH_TRANSLATION_UNSPECIFIED_VALUE</h4> |
| <pre>public static final int PATH_TRANSLATION_UNSPECIFIED_VALUE</pre> |
| <div class="block"><code>PATH_TRANSLATION_UNSPECIFIED = 0;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.api.BackendRule.PathTranslation.PATH_TRANSLATION_UNSPECIFIED_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CONSTANT_ADDRESS_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CONSTANT_ADDRESS_VALUE</h4> |
| <pre>public static final int CONSTANT_ADDRESS_VALUE</pre> |
| <div class="block"><pre> |
| Use the backend address as-is, with no modification to the path. If the |
| URL pattern contains variables, the variable names and values will be |
| appended to the query string. If a query string parameter and a URL |
| pattern variable have the same name, this may result in duplicate keys in |
| the query string. |
| # Examples |
| Given the following operation config: |
| Method path: /api/company/{cid}/user/{uid} |
| Backend address: https://example.cloudfunctions.net/getUser |
| Requests to the following request paths will call the backend at the |
| translated path: |
| Request path: /api/company/widgetworks/user/johndoe |
| Translated: |
| https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe |
| Request path: /api/company/widgetworks/user/johndoe?timezone=EST |
| Translated: |
| https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
| </pre> |
| |
| <code>CONSTANT_ADDRESS = 1;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.api.BackendRule.PathTranslation.CONSTANT_ADDRESS_VALUE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="APPEND_PATH_TO_ADDRESS_VALUE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>APPEND_PATH_TO_ADDRESS_VALUE</h4> |
| <pre>public static final int APPEND_PATH_TO_ADDRESS_VALUE</pre> |
| <div class="block"><pre> |
| The request path will be appended to the backend address. |
| # Examples |
| Given the following operation config: |
| Method path: /api/company/{cid}/user/{uid} |
| Backend address: https://example.appspot.com |
| Requests to the following request paths will call the backend at the |
| translated path: |
| Request path: /api/company/widgetworks/user/johndoe |
| Translated: |
| https://example.appspot.com/api/company/widgetworks/user/johndoe |
| Request path: /api/company/widgetworks/user/johndoe?timezone=EST |
| Translated: |
| https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| </pre> |
| |
| <code>APPEND_PATH_TO_ADDRESS = 2;</code></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#com.google.api.BackendRule.PathTranslation.APPEND_PATH_TO_ADDRESS_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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</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 (BackendRule.PathTranslation c : BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</a> valueOf(int value)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../com/google/api/BackendRule.PathTranslation.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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</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/api/BackendRule.PathTranslation.html" title="enum in com.google.api">BackendRule.PathTranslation</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/api/BackendRule.Builder.html" title="class in com.google.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/api/BackendRuleOrBuilder.html" title="interface in com.google.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/api/BackendRule.PathTranslation.html" target="_top">Frames</a></li> |
| <li><a href="BackendRule.PathTranslation.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> |
