• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2020 Google LLC
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     https://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 // Generated by the protocol buffer compiler.  DO NOT EDIT!
17 // source: google/api/system_parameter.proto
18 
19 package com.google.api;
20 
21 public interface SystemParametersOrBuilder
22     extends
23     // @@protoc_insertion_point(interface_extends:google.api.SystemParameters)
24     com.google.protobuf.MessageOrBuilder {
25 
26   /**
27    *
28    *
29    * <pre>
30    * Define system parameters.
31    * The parameters defined here will override the default parameters
32    * implemented by the system. If this field is missing from the service
33    * config, default system parameters will be used. Default system parameters
34    * and names is implementation-dependent.
35    * Example: define api key for all methods
36    *     system_parameters
37    *       rules:
38    *         - selector: "*"
39    *           parameters:
40    *             - name: api_key
41    *               url_query_parameter: api_key
42    * Example: define 2 api key names for a specific method.
43    *     system_parameters
44    *       rules:
45    *         - selector: "/ListShelves"
46    *           parameters:
47    *             - name: api_key
48    *               http_header: Api-Key1
49    *             - name: api_key
50    *               http_header: Api-Key2
51    * **NOTE:** All service configuration rules follow "last one wins" order.
52    * </pre>
53    *
54    * <code>repeated .google.api.SystemParameterRule rules = 1;</code>
55    */
getRulesList()56   java.util.List<com.google.api.SystemParameterRule> getRulesList();
57   /**
58    *
59    *
60    * <pre>
61    * Define system parameters.
62    * The parameters defined here will override the default parameters
63    * implemented by the system. If this field is missing from the service
64    * config, default system parameters will be used. Default system parameters
65    * and names is implementation-dependent.
66    * Example: define api key for all methods
67    *     system_parameters
68    *       rules:
69    *         - selector: "*"
70    *           parameters:
71    *             - name: api_key
72    *               url_query_parameter: api_key
73    * Example: define 2 api key names for a specific method.
74    *     system_parameters
75    *       rules:
76    *         - selector: "/ListShelves"
77    *           parameters:
78    *             - name: api_key
79    *               http_header: Api-Key1
80    *             - name: api_key
81    *               http_header: Api-Key2
82    * **NOTE:** All service configuration rules follow "last one wins" order.
83    * </pre>
84    *
85    * <code>repeated .google.api.SystemParameterRule rules = 1;</code>
86    */
getRules(int index)87   com.google.api.SystemParameterRule getRules(int index);
88   /**
89    *
90    *
91    * <pre>
92    * Define system parameters.
93    * The parameters defined here will override the default parameters
94    * implemented by the system. If this field is missing from the service
95    * config, default system parameters will be used. Default system parameters
96    * and names is implementation-dependent.
97    * Example: define api key for all methods
98    *     system_parameters
99    *       rules:
100    *         - selector: "*"
101    *           parameters:
102    *             - name: api_key
103    *               url_query_parameter: api_key
104    * Example: define 2 api key names for a specific method.
105    *     system_parameters
106    *       rules:
107    *         - selector: "/ListShelves"
108    *           parameters:
109    *             - name: api_key
110    *               http_header: Api-Key1
111    *             - name: api_key
112    *               http_header: Api-Key2
113    * **NOTE:** All service configuration rules follow "last one wins" order.
114    * </pre>
115    *
116    * <code>repeated .google.api.SystemParameterRule rules = 1;</code>
117    */
getRulesCount()118   int getRulesCount();
119   /**
120    *
121    *
122    * <pre>
123    * Define system parameters.
124    * The parameters defined here will override the default parameters
125    * implemented by the system. If this field is missing from the service
126    * config, default system parameters will be used. Default system parameters
127    * and names is implementation-dependent.
128    * Example: define api key for all methods
129    *     system_parameters
130    *       rules:
131    *         - selector: "*"
132    *           parameters:
133    *             - name: api_key
134    *               url_query_parameter: api_key
135    * Example: define 2 api key names for a specific method.
136    *     system_parameters
137    *       rules:
138    *         - selector: "/ListShelves"
139    *           parameters:
140    *             - name: api_key
141    *               http_header: Api-Key1
142    *             - name: api_key
143    *               http_header: Api-Key2
144    * **NOTE:** All service configuration rules follow "last one wins" order.
145    * </pre>
146    *
147    * <code>repeated .google.api.SystemParameterRule rules = 1;</code>
148    */
getRulesOrBuilderList()149   java.util.List<? extends com.google.api.SystemParameterRuleOrBuilder> getRulesOrBuilderList();
150   /**
151    *
152    *
153    * <pre>
154    * Define system parameters.
155    * The parameters defined here will override the default parameters
156    * implemented by the system. If this field is missing from the service
157    * config, default system parameters will be used. Default system parameters
158    * and names is implementation-dependent.
159    * Example: define api key for all methods
160    *     system_parameters
161    *       rules:
162    *         - selector: "*"
163    *           parameters:
164    *             - name: api_key
165    *               url_query_parameter: api_key
166    * Example: define 2 api key names for a specific method.
167    *     system_parameters
168    *       rules:
169    *         - selector: "/ListShelves"
170    *           parameters:
171    *             - name: api_key
172    *               http_header: Api-Key1
173    *             - name: api_key
174    *               http_header: Api-Key2
175    * **NOTE:** All service configuration rules follow "last one wins" order.
176    * </pre>
177    *
178    * <code>repeated .google.api.SystemParameterRule rules = 1;</code>
179    */
getRulesOrBuilder(int index)180   com.google.api.SystemParameterRuleOrBuilder getRulesOrBuilder(int index);
181 }
182