BackendRule.php — ShareThis Dashboard for Google Analytics trunk

googleanalytics / lib / analytics-admin / vendor / google / common-protos / src / Api / BackendRule.php

googleanalytics / lib / analytics-admin / vendor / google / common-protos / src / Api Last commit date

BackendRule.php

336 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/api/backend.proto
4
5	namespace Google\Api;
6
7	use Google\Protobuf\Internal\GPBType;
8	use Google\Protobuf\Internal\RepeatedField;
9	use Google\Protobuf\Internal\GPBUtil;
10
11	/**
12	* A backend rule provides configuration for an individual API element.
13	*
14	* Generated from protobuf message <code>google.api.BackendRule</code>
15	*/
16	class BackendRule extends \Google\Protobuf\Internal\Message
17	{
18	/**
19	* Selects the methods to which this rule applies.
20	* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
21	*
22	* Generated from protobuf field <code>string selector = 1;</code>
23	*/
24	private $selector = '';
25	/**
26	* The address of the API backend.
27	*
28	* Generated from protobuf field <code>string address = 2;</code>
29	*/
30	private $address = '';
31	/**
32	* The number of seconds to wait for a response from a request. The default
33	* varies based on the request protocol and deployment environment.
34	*
35	* Generated from protobuf field <code>double deadline = 3;</code>
36	*/
37	private $deadline = 0.0;
38	/**
39	* Minimum deadline in seconds needed for this method. Calls having deadline
40	* value lower than this will be rejected.
41	*
42	* Generated from protobuf field <code>double min_deadline = 4;</code>
43	*/
44	private $min_deadline = 0.0;
45	/**
46	* The number of seconds to wait for the completion of a long running
47	* operation. The default is no deadline.
48	*
49	* Generated from protobuf field <code>double operation_deadline = 5;</code>
50	*/
51	private $operation_deadline = 0.0;
52	/**
53	* Generated from protobuf field <code>.google.api.BackendRule.PathTranslation path_translation = 6;</code>
54	*/
55	private $path_translation = 0;
56	protected $authentication;
57
58	/**
59	* Constructor.
60	*
61	* @param array $data {
62	* Optional. Data for populating the Message object.
63	*
64	* @type string $selector
65	* Selects the methods to which this rule applies.
66	* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
67	* @type string $address
68	* The address of the API backend.
69	* @type float $deadline
70	* The number of seconds to wait for a response from a request. The default
71	* varies based on the request protocol and deployment environment.
72	* @type float $min_deadline
73	* Minimum deadline in seconds needed for this method. Calls having deadline
74	* value lower than this will be rejected.
75	* @type float $operation_deadline
76	* The number of seconds to wait for the completion of a long running
77	* operation. The default is no deadline.
78	* @type int $path_translation
79	* @type string $jwt_audience
80	* The JWT audience is used when generating a JWT ID token for the backend.
81	* This ID token will be added in the HTTP "authorization" header, and sent
82	* to the backend.
83	* @type bool $disable_auth
84	* When disable_auth is false, a JWT ID token will be generated with the
85	* value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP
86	* "Authorization" request header and sent to the backend.
87	* When disable_auth is true, a JWT ID token won't be generated and the
88	* original "Authorization" HTTP header will be preserved. If the header is
89	* used to carry the original token and is expected by the backend, this
90	* field must be set to true to preserve the header.
91	* }
92	*/
93	public function __construct($data = NULL) {
94	\GPBMetadata\Google\Api\Backend::initOnce();
95	parent::__construct($data);
96	}
97
98	/**
99	* Selects the methods to which this rule applies.
100	* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
101	*
102	* Generated from protobuf field <code>string selector = 1;</code>
103	* @return string
104	*/
105	public function getSelector()
106	{
107	return $this->selector;
108	}
109
110	/**
111	* Selects the methods to which this rule applies.
112	* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
113	*
114	* Generated from protobuf field <code>string selector = 1;</code>
115	* @param string $var
116	* @return $this
117	*/
118	public function setSelector($var)
119	{
120	GPBUtil::checkString($var, True);
121	$this->selector = $var;
122
123	return $this;
124	}
125
126	/**
127	* The address of the API backend.
128	*
129	* Generated from protobuf field <code>string address = 2;</code>
130	* @return string
131	*/
132	public function getAddress()
133	{
134	return $this->address;
135	}
136
137	/**
138	* The address of the API backend.
139	*
140	* Generated from protobuf field <code>string address = 2;</code>
141	* @param string $var
142	* @return $this
143	*/
144	public function setAddress($var)
145	{
146	GPBUtil::checkString($var, True);
147	$this->address = $var;
148
149	return $this;
150	}
151
152	/**
153	* The number of seconds to wait for a response from a request. The default
154	* varies based on the request protocol and deployment environment.
155	*
156	* Generated from protobuf field <code>double deadline = 3;</code>
157	* @return float
158	*/
159	public function getDeadline()
160	{
161	return $this->deadline;
162	}
163
164	/**
165	* The number of seconds to wait for a response from a request. The default
166	* varies based on the request protocol and deployment environment.
167	*
168	* Generated from protobuf field <code>double deadline = 3;</code>
169	* @param float $var
170	* @return $this
171	*/
172	public function setDeadline($var)
173	{
174	GPBUtil::checkDouble($var);
175	$this->deadline = $var;
176
177	return $this;
178	}
179
180	/**
181	* Minimum deadline in seconds needed for this method. Calls having deadline
182	* value lower than this will be rejected.
183	*
184	* Generated from protobuf field <code>double min_deadline = 4;</code>
185	* @return float
186	*/
187	public function getMinDeadline()
188	{
189	return $this->min_deadline;
190	}
191
192	/**
193	* Minimum deadline in seconds needed for this method. Calls having deadline
194	* value lower than this will be rejected.
195	*
196	* Generated from protobuf field <code>double min_deadline = 4;</code>
197	* @param float $var
198	* @return $this
199	*/
200	public function setMinDeadline($var)
201	{
202	GPBUtil::checkDouble($var);
203	$this->min_deadline = $var;
204
205	return $this;
206	}
207
208	/**
209	* The number of seconds to wait for the completion of a long running
210	* operation. The default is no deadline.
211	*
212	* Generated from protobuf field <code>double operation_deadline = 5;</code>
213	* @return float
214	*/
215	public function getOperationDeadline()
216	{
217	return $this->operation_deadline;
218	}
219
220	/**
221	* The number of seconds to wait for the completion of a long running
222	* operation. The default is no deadline.
223	*
224	* Generated from protobuf field <code>double operation_deadline = 5;</code>
225	* @param float $var
226	* @return $this
227	*/
228	public function setOperationDeadline($var)
229	{
230	GPBUtil::checkDouble($var);
231	$this->operation_deadline = $var;
232
233	return $this;
234	}
235
236	/**
237	* Generated from protobuf field <code>.google.api.BackendRule.PathTranslation path_translation = 6;</code>
238	* @return int
239	*/
240	public function getPathTranslation()
241	{
242	return $this->path_translation;
243	}
244
245	/**
246	* Generated from protobuf field <code>.google.api.BackendRule.PathTranslation path_translation = 6;</code>
247	* @param int $var
248	* @return $this
249	*/
250	public function setPathTranslation($var)
251	{
252	GPBUtil::checkEnum($var, \Google\Api\BackendRule_PathTranslation::class);
253	$this->path_translation = $var;
254
255	return $this;
256	}
257
258	/**
259	* The JWT audience is used when generating a JWT ID token for the backend.
260	* This ID token will be added in the HTTP "authorization" header, and sent
261	* to the backend.
262	*
263	* Generated from protobuf field <code>string jwt_audience = 7;</code>
264	* @return string
265	*/
266	public function getJwtAudience()
267	{
268	return $this->readOneof(7);
269	}
270
271	/**
272	* The JWT audience is used when generating a JWT ID token for the backend.
273	* This ID token will be added in the HTTP "authorization" header, and sent
274	* to the backend.
275	*
276	* Generated from protobuf field <code>string jwt_audience = 7;</code>
277	* @param string $var
278	* @return $this
279	*/
280	public function setJwtAudience($var)
281	{
282	GPBUtil::checkString($var, True);
283	$this->writeOneof(7, $var);
284
285	return $this;
286	}
287
288	/**
289	* When disable_auth is false, a JWT ID token will be generated with the
290	* value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP
291	* "Authorization" request header and sent to the backend.
292	* When disable_auth is true, a JWT ID token won't be generated and the
293	* original "Authorization" HTTP header will be preserved. If the header is
294	* used to carry the original token and is expected by the backend, this
295	* field must be set to true to preserve the header.
296	*
297	* Generated from protobuf field <code>bool disable_auth = 8;</code>
298	* @return bool
299	*/
300	public function getDisableAuth()
301	{
302	return $this->readOneof(8);
303	}
304
305	/**
306	* When disable_auth is false, a JWT ID token will be generated with the
307	* value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP
308	* "Authorization" request header and sent to the backend.
309	* When disable_auth is true, a JWT ID token won't be generated and the
310	* original "Authorization" HTTP header will be preserved. If the header is
311	* used to carry the original token and is expected by the backend, this
312	* field must be set to true to preserve the header.
313	*
314	* Generated from protobuf field <code>bool disable_auth = 8;</code>
315	* @param bool $var
316	* @return $this
317	*/
318	public function setDisableAuth($var)
319	{
320	GPBUtil::checkBool($var);
321	$this->writeOneof(8, $var);
322
323	return $this;
324	}
325
326	/**
327	* @return string
328	*/
329	public function getAuthentication()
330	{
331	return $this->whichOneof("authentication");
332	}
333
334	}
335
336