| <!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:55 PDT 2019 --> |
| <title>ResourceDescriptorOrBuilder (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="ResourceDescriptorOrBuilder (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ResourceDescriptor.History.html" title="enum in com.google.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/api/ResourceProto.html" title="class in com.google.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/api/ResourceDescriptorOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="ResourceDescriptorOrBuilder.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface ResourceDescriptorOrBuilder" class="title">Interface ResourceDescriptorOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../com/google/api/ResourceDescriptor.html" title="class in com.google.api">ResourceDescriptor</a>, <a href="../../../com/google/api/ResourceDescriptor.Builder.html" title="class in com.google.api">ResourceDescriptor.Builder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ResourceDescriptorOrBuilder</span> |
| extends <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../com/google/api/ResourceDescriptor.History.html" title="enum in com.google.api">ResourceDescriptor.History</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getHistory--">getHistory</a></span>()</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getHistoryValue--">getHistoryValue</a></span>()</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getNameField--">getNameField</a></span>()</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getNameFieldBytes--">getNameFieldBytes</a></span>()</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getPattern-int-">getPattern</a></span>(int index)</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getPatternBytes-int-">getPatternBytes</a></span>(int index)</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getPatternCount--">getPatternCount</a></span>()</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getPatternList--">getPatternList</a></span>()</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getPlural--">getPlural</a></span>()</code> |
| <div class="block"> |
| The plural name used in the resource name, such as 'projects' for |
| the name of 'projects/{project}'.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getPluralBytes--">getPluralBytes</a></span>()</code> |
| <div class="block"> |
| The plural name used in the resource name, such as 'projects' for |
| the name of 'projects/{project}'.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getSingular--">getSingular</a></span>()</code> |
| <div class="block"> |
| The same concept of the `singular` field in k8s CRD spec |
| https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ |
| Such as "project" for the `resourcemanager.googleapis.com/Project` type.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getSingularBytes--">getSingularBytes</a></span>()</code> |
| <div class="block"> |
| The same concept of the `singular` field in k8s CRD spec |
| https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ |
| Such as "project" for the `resourcemanager.googleapis.com/Project` type.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getType--">getType</a></span>()</code> |
| <div class="block"> |
| The resource type.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/ResourceDescriptorOrBuilder.html#getTypeBytes--">getTypeBytes</a></span>()</code> |
| <div class="block"> |
| The resource type.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#findInitializationErrors--" title="class or interface in com.google.protobuf">findInitializationErrors</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getAllFields--" title="class or interface in com.google.protobuf">getAllFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDefaultInstanceForType--" title="class or interface in com.google.protobuf">getDefaultInstanceForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf">getDescriptorForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getInitializationErrorString--" title="class or interface in com.google.protobuf">getInitializationErrorString</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getOneofFieldDescriptor-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">getOneofFieldDescriptor</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedField-com.google.protobuf.Descriptors.FieldDescriptor-int-" title="class or interface in com.google.protobuf">getRepeatedField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedFieldCount-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getRepeatedFieldCount</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getUnknownFields--" title="class or interface in com.google.protobuf">getUnknownFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">hasField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasOneof-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">hasOneof</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true#isInitialized--" title="class or interface in com.google.protobuf">isInitialized</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getType--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre>java.lang.String getType()</pre> |
| <div class="block"><pre> |
| The resource type. It must be in the format of |
| {service_name}/{resource_type_kind}. The `resource_type_kind` must be |
| singular and must not include version numbers. |
| Example: `storage.googleapis.com/Bucket` |
| The value of the resource_type_kind must follow the regular expression |
| /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and |
| should use PascalCase (UpperCamelCase). The maximum number of |
| characters allowed for the `resource_type_kind` is 100. |
| </pre> |
| |
| <code>string type = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getTypeBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTypeBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getTypeBytes()</pre> |
| <div class="block"><pre> |
| The resource type. It must be in the format of |
| {service_name}/{resource_type_kind}. The `resource_type_kind` must be |
| singular and must not include version numbers. |
| Example: `storage.googleapis.com/Bucket` |
| The value of the resource_type_kind must follow the regular expression |
| /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and |
| should use PascalCase (UpperCamelCase). The maximum number of |
| characters allowed for the `resource_type_kind` is 100. |
| </pre> |
| |
| <code>string type = 1;</code></div> |
| </li> |
| </ul> |
| <a name="getPatternList--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPatternList</h4> |
| <pre>java.util.List<java.lang.String> getPatternList()</pre> |
| <div class="block"><pre> |
| Optional. The relative resource name pattern associated with this resource |
| type. The DNS prefix of the full resource name shouldn't be specified here. |
| The path pattern must follow the syntax, which aligns with HTTP binding |
| syntax: |
| Template = Segment { "/" Segment } ; |
| Segment = LITERAL | Variable ; |
| Variable = "{" LITERAL "}" ; |
| Examples: |
| - "projects/{project}/topics/{topic}" |
| - "projects/{project}/knowledgeBases/{knowledge_base}" |
| The components in braces correspond to the IDs for each resource in the |
| hierarchy. It is expected that, if multiple patterns are provided, |
| the same component name (e.g. "project") refers to IDs of the same |
| type of resource. |
| </pre> |
| |
| <code>repeated string pattern = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getPatternCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPatternCount</h4> |
| <pre>int getPatternCount()</pre> |
| <div class="block"><pre> |
| Optional. The relative resource name pattern associated with this resource |
| type. The DNS prefix of the full resource name shouldn't be specified here. |
| The path pattern must follow the syntax, which aligns with HTTP binding |
| syntax: |
| Template = Segment { "/" Segment } ; |
| Segment = LITERAL | Variable ; |
| Variable = "{" LITERAL "}" ; |
| Examples: |
| - "projects/{project}/topics/{topic}" |
| - "projects/{project}/knowledgeBases/{knowledge_base}" |
| The components in braces correspond to the IDs for each resource in the |
| hierarchy. It is expected that, if multiple patterns are provided, |
| the same component name (e.g. "project") refers to IDs of the same |
| type of resource. |
| </pre> |
| |
| <code>repeated string pattern = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getPattern-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPattern</h4> |
| <pre>java.lang.String getPattern(int index)</pre> |
| <div class="block"><pre> |
| Optional. The relative resource name pattern associated with this resource |
| type. The DNS prefix of the full resource name shouldn't be specified here. |
| The path pattern must follow the syntax, which aligns with HTTP binding |
| syntax: |
| Template = Segment { "/" Segment } ; |
| Segment = LITERAL | Variable ; |
| Variable = "{" LITERAL "}" ; |
| Examples: |
| - "projects/{project}/topics/{topic}" |
| - "projects/{project}/knowledgeBases/{knowledge_base}" |
| The components in braces correspond to the IDs for each resource in the |
| hierarchy. It is expected that, if multiple patterns are provided, |
| the same component name (e.g. "project") refers to IDs of the same |
| type of resource. |
| </pre> |
| |
| <code>repeated string pattern = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getPatternBytes-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPatternBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getPatternBytes(int index)</pre> |
| <div class="block"><pre> |
| Optional. The relative resource name pattern associated with this resource |
| type. The DNS prefix of the full resource name shouldn't be specified here. |
| The path pattern must follow the syntax, which aligns with HTTP binding |
| syntax: |
| Template = Segment { "/" Segment } ; |
| Segment = LITERAL | Variable ; |
| Variable = "{" LITERAL "}" ; |
| Examples: |
| - "projects/{project}/topics/{topic}" |
| - "projects/{project}/knowledgeBases/{knowledge_base}" |
| The components in braces correspond to the IDs for each resource in the |
| hierarchy. It is expected that, if multiple patterns are provided, |
| the same component name (e.g. "project") refers to IDs of the same |
| type of resource. |
| </pre> |
| |
| <code>repeated string pattern = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getNameField--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNameField</h4> |
| <pre>java.lang.String getNameField()</pre> |
| <div class="block"><pre> |
| Optional. The field on the resource that designates the resource name |
| field. If omitted, this is assumed to be "name". |
| </pre> |
| |
| <code>string name_field = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getNameFieldBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNameFieldBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getNameFieldBytes()</pre> |
| <div class="block"><pre> |
| Optional. The field on the resource that designates the resource name |
| field. If omitted, this is assumed to be "name". |
| </pre> |
| |
| <code>string name_field = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getHistoryValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHistoryValue</h4> |
| <pre>int getHistoryValue()</pre> |
| <div class="block"><pre> |
| Optional. The historical or future-looking state of the resource pattern. |
| Example: |
| // The InspectTemplate message originally only supported resource |
| // names with organization, and project was added later. |
| message InspectTemplate { |
| option (google.api.resource) = { |
| type: "dlp.googleapis.com/InspectTemplate" |
| pattern: |
| "organizations/{organization}/inspectTemplates/{inspect_template}" |
| pattern: "projects/{project}/inspectTemplates/{inspect_template}" |
| history: ORIGINALLY_SINGLE_PATTERN |
| }; |
| } |
| </pre> |
| |
| <code>.google.api.ResourceDescriptor.History history = 4;</code></div> |
| </li> |
| </ul> |
| <a name="getHistory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHistory</h4> |
| <pre><a href="../../../com/google/api/ResourceDescriptor.History.html" title="enum in com.google.api">ResourceDescriptor.History</a> getHistory()</pre> |
| <div class="block"><pre> |
| Optional. The historical or future-looking state of the resource pattern. |
| Example: |
| // The InspectTemplate message originally only supported resource |
| // names with organization, and project was added later. |
| message InspectTemplate { |
| option (google.api.resource) = { |
| type: "dlp.googleapis.com/InspectTemplate" |
| pattern: |
| "organizations/{organization}/inspectTemplates/{inspect_template}" |
| pattern: "projects/{project}/inspectTemplates/{inspect_template}" |
| history: ORIGINALLY_SINGLE_PATTERN |
| }; |
| } |
| </pre> |
| |
| <code>.google.api.ResourceDescriptor.History history = 4;</code></div> |
| </li> |
| </ul> |
| <a name="getPlural--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPlural</h4> |
| <pre>java.lang.String getPlural()</pre> |
| <div class="block"><pre> |
| The plural name used in the resource name, such as 'projects' for |
| the name of 'projects/{project}'. It is the same concept of the `plural` |
| field in k8s CRD spec |
| https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ |
| </pre> |
| |
| <code>string plural = 5;</code></div> |
| </li> |
| </ul> |
| <a name="getPluralBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPluralBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getPluralBytes()</pre> |
| <div class="block"><pre> |
| The plural name used in the resource name, such as 'projects' for |
| the name of 'projects/{project}'. It is the same concept of the `plural` |
| field in k8s CRD spec |
| https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ |
| </pre> |
| |
| <code>string plural = 5;</code></div> |
| </li> |
| </ul> |
| <a name="getSingular--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSingular</h4> |
| <pre>java.lang.String getSingular()</pre> |
| <div class="block"><pre> |
| The same concept of the `singular` field in k8s CRD spec |
| https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ |
| Such as "project" for the `resourcemanager.googleapis.com/Project` type. |
| </pre> |
| |
| <code>string singular = 6;</code></div> |
| </li> |
| </ul> |
| <a name="getSingularBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSingularBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getSingularBytes()</pre> |
| <div class="block"><pre> |
| The same concept of the `singular` field in k8s CRD spec |
| https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/ |
| Such as "project" for the `resourcemanager.googleapis.com/Project` type. |
| </pre> |
| |
| <code>string singular = 6;</code></div> |
| </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/ResourceDescriptor.History.html" title="enum in com.google.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/api/ResourceProto.html" title="class in com.google.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/api/ResourceDescriptorOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="ResourceDescriptorOrBuilder.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |