RoutingParameter.php — ShareThis Dashboard for Google Analytics 3.3.0

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

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

RoutingParameter.php

282 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/api/routing.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 projection from an input message to the GRPC or REST header.
13	*
14	* Generated from protobuf message <code>google.api.RoutingParameter</code>
15	*/
16	class RoutingParameter extends \Google\Protobuf\Internal\Message
17	{
18	/**
19	* A request field to extract the header key-value pair from.
20	*
21	* Generated from protobuf field <code>string field = 1;</code>
22	*/
23	protected $field = '';
24	/**
25	* A pattern matching the key-value field. Optional.
26	* If not specified, the whole field specified in the `field` field will be
27	* taken as value, and its name used as key. If specified, it MUST contain
28	* exactly one named segment (along with any number of unnamed segments) The
29	* pattern will be matched over the field specified in the `field` field, then
30	* if the match is successful:
31	* - the name of the single named segment will be used as a header name,
32	* - the match value of the segment will be used as a header value;
33	* if the match is NOT successful, nothing will be sent.
34	* Example:
35	* -- This is a field in the request message
36	* \| that the header value will be extracted from.
37	* \|
38	* \| -- This is the key name in the
39	* \| \| routing header.
40	* V \|
41	* field: "table_name" v
42	* path_template: "projects//{table_location=instances/}/tables/*"
43	* ^ ^
44	* \| \|
45	* In the {} brackets is the pattern that -- \|
46	* specifies what to extract from the \|
47	* field as a value to be sent. \|
48	* \|
49	* The string in the field must match the whole pattern --
50	* before brackets, inside brackets, after brackets.
51	* When looking at this specific example, we can see that:
52	* - A key-value pair with the key `table_location`
53	* and the value matching `instances/*` should be added
54	* to the x-goog-request-params routing header.
55	* - The value is extracted from the request message's `table_name` field
56	* if it matches the full pattern specified:
57	* `projects//instances//tables/*`.
58	* NB: If the `path_template` field is not provided, the key name is
59	* equal to the field name, and the whole field should be sent as a value.
60	* This makes the pattern for the field and the value functionally equivalent
61	* to `**`, and the configuration
62	* {
63	* field: "table_name"
64	* }
65	* is a functionally equivalent shorthand to:
66	* {
67	* field: "table_name"
68	* path_template: "{table_name=**}"
69	* }
70	* See Example 1 for more details.
71	*
72	* Generated from protobuf field <code>string path_template = 2;</code>
73	*/
74	protected $path_template = '';
75
76	/**
77	* Constructor.
78	*
79	* @param array $data {
80	* Optional. Data for populating the Message object.
81	*
82	* @type string $field
83	* A request field to extract the header key-value pair from.
84	* @type string $path_template
85	* A pattern matching the key-value field. Optional.
86	* If not specified, the whole field specified in the `field` field will be
87	* taken as value, and its name used as key. If specified, it MUST contain
88	* exactly one named segment (along with any number of unnamed segments) The
89	* pattern will be matched over the field specified in the `field` field, then
90	* if the match is successful:
91	* - the name of the single named segment will be used as a header name,
92	* - the match value of the segment will be used as a header value;
93	* if the match is NOT successful, nothing will be sent.
94	* Example:
95	* -- This is a field in the request message
96	* \| that the header value will be extracted from.
97	* \|
98	* \| -- This is the key name in the
99	* \| \| routing header.
100	* V \|
101	* field: "table_name" v
102	* path_template: "projects//{table_location=instances/}/tables/*"
103	* ^ ^
104	* \| \|
105	* In the {} brackets is the pattern that -- \|
106	* specifies what to extract from the \|
107	* field as a value to be sent. \|
108	* \|
109	* The string in the field must match the whole pattern --
110	* before brackets, inside brackets, after brackets.
111	* When looking at this specific example, we can see that:
112	* - A key-value pair with the key `table_location`
113	* and the value matching `instances/*` should be added
114	* to the x-goog-request-params routing header.
115	* - The value is extracted from the request message's `table_name` field
116	* if it matches the full pattern specified:
117	* `projects//instances//tables/*`.
118	* NB: If the `path_template` field is not provided, the key name is
119	* equal to the field name, and the whole field should be sent as a value.
120	* This makes the pattern for the field and the value functionally equivalent
121	* to `**`, and the configuration
122	* {
123	* field: "table_name"
124	* }
125	* is a functionally equivalent shorthand to:
126	* {
127	* field: "table_name"
128	* path_template: "{table_name=**}"
129	* }
130	* See Example 1 for more details.
131	* }
132	*/
133	public function __construct($data = NULL) {
134	\GPBMetadata\Google\Api\Routing::initOnce();
135	parent::__construct($data);
136	}
137
138	/**
139	* A request field to extract the header key-value pair from.
140	*
141	* Generated from protobuf field <code>string field = 1;</code>
142	* @return string
143	*/
144	public function getField()
145	{
146	return $this->field;
147	}
148
149	/**
150	* A request field to extract the header key-value pair from.
151	*
152	* Generated from protobuf field <code>string field = 1;</code>
153	* @param string $var
154	* @return $this
155	*/
156	public function setField($var)
157	{
158	GPBUtil::checkString($var, True);
159	$this->field = $var;
160
161	return $this;
162	}
163
164	/**
165	* A pattern matching the key-value field. Optional.
166	* If not specified, the whole field specified in the `field` field will be
167	* taken as value, and its name used as key. If specified, it MUST contain
168	* exactly one named segment (along with any number of unnamed segments) The
169	* pattern will be matched over the field specified in the `field` field, then
170	* if the match is successful:
171	* - the name of the single named segment will be used as a header name,
172	* - the match value of the segment will be used as a header value;
173	* if the match is NOT successful, nothing will be sent.
174	* Example:
175	* -- This is a field in the request message
176	* \| that the header value will be extracted from.
177	* \|
178	* \| -- This is the key name in the
179	* \| \| routing header.
180	* V \|
181	* field: "table_name" v
182	* path_template: "projects//{table_location=instances/}/tables/*"
183	* ^ ^
184	* \| \|
185	* In the {} brackets is the pattern that -- \|
186	* specifies what to extract from the \|
187	* field as a value to be sent. \|
188	* \|
189	* The string in the field must match the whole pattern --
190	* before brackets, inside brackets, after brackets.
191	* When looking at this specific example, we can see that:
192	* - A key-value pair with the key `table_location`
193	* and the value matching `instances/*` should be added
194	* to the x-goog-request-params routing header.
195	* - The value is extracted from the request message's `table_name` field
196	* if it matches the full pattern specified:
197	* `projects//instances//tables/*`.
198	* NB: If the `path_template` field is not provided, the key name is
199	* equal to the field name, and the whole field should be sent as a value.
200	* This makes the pattern for the field and the value functionally equivalent
201	* to `**`, and the configuration
202	* {
203	* field: "table_name"
204	* }
205	* is a functionally equivalent shorthand to:
206	* {
207	* field: "table_name"
208	* path_template: "{table_name=**}"
209	* }
210	* See Example 1 for more details.
211	*
212	* Generated from protobuf field <code>string path_template = 2;</code>
213	* @return string
214	*/
215	public function getPathTemplate()
216	{
217	return $this->path_template;
218	}
219
220	/**
221	* A pattern matching the key-value field. Optional.
222	* If not specified, the whole field specified in the `field` field will be
223	* taken as value, and its name used as key. If specified, it MUST contain
224	* exactly one named segment (along with any number of unnamed segments) The
225	* pattern will be matched over the field specified in the `field` field, then
226	* if the match is successful:
227	* - the name of the single named segment will be used as a header name,
228	* - the match value of the segment will be used as a header value;
229	* if the match is NOT successful, nothing will be sent.
230	* Example:
231	* -- This is a field in the request message
232	* \| that the header value will be extracted from.
233	* \|
234	* \| -- This is the key name in the
235	* \| \| routing header.
236	* V \|
237	* field: "table_name" v
238	* path_template: "projects//{table_location=instances/}/tables/*"
239	* ^ ^
240	* \| \|
241	* In the {} brackets is the pattern that -- \|
242	* specifies what to extract from the \|
243	* field as a value to be sent. \|
244	* \|
245	* The string in the field must match the whole pattern --
246	* before brackets, inside brackets, after brackets.
247	* When looking at this specific example, we can see that:
248	* - A key-value pair with the key `table_location`
249	* and the value matching `instances/*` should be added
250	* to the x-goog-request-params routing header.
251	* - The value is extracted from the request message's `table_name` field
252	* if it matches the full pattern specified:
253	* `projects//instances//tables/*`.
254	* NB: If the `path_template` field is not provided, the key name is
255	* equal to the field name, and the whole field should be sent as a value.
256	* This makes the pattern for the field and the value functionally equivalent
257	* to `**`, and the configuration
258	* {
259	* field: "table_name"
260	* }
261	* is a functionally equivalent shorthand to:
262	* {
263	* field: "table_name"
264	* path_template: "{table_name=**}"
265	* }
266	* See Example 1 for more details.
267	*
268	* Generated from protobuf field <code>string path_template = 2;</code>
269	* @param string $var
270	* @return $this
271	*/
272	public function setPathTemplate($var)
273	{
274	GPBUtil::checkString($var, True);
275	$this->path_template = $var;
276
277	return $this;
278	}
279
280	}
281
282