Documentation.php — ShareThis Dashboard for Google Analytics 3.2.1

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

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

Documentation.php

309 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/api/documentation.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	* `Documentation` provides the information for describing a service.
13	* Example:
14	* <pre><code>documentation:
15	* summary: >
16	* The Google Calendar API gives access
17	* to most calendar features.
18	* pages:
19	* - name: Overview
20	* content: (== include google/foo/overview.md ==)
21	* - name: Tutorial
22	* content: (== include google/foo/tutorial.md ==)
23	* subpages;
24	* - name: Java
25	* content: (== include google/foo/tutorial_java.md ==)
26	* rules:
27	* - selector: google.calendar.Calendar.Get
28	* description: >
29	* ...
30	* - selector: google.calendar.Calendar.Put
31	* description: >
32	* ...
33	* </code></pre>
34	* Documentation is provided in markdown syntax. In addition to
35	* standard markdown features, definition lists, tables and fenced
36	* code blocks are supported. Section headers can be provided and are
37	* interpreted relative to the section nesting of the context where
38	* a documentation fragment is embedded.
39	* Documentation from the IDL is merged with documentation defined
40	* via the config at normalization time, where documentation provided
41	* by config rules overrides IDL provided.
42	* A number of constructs specific to the API platform are supported
43	* in documentation text.
44	* In order to reference a proto element, the following
45	* notation can be used:
46	* <pre><code>[fully.qualified.proto.name][]</code></pre>
47	* To override the display text used for the link, this can be used:
48	* <pre><code>[display text][fully.qualified.proto.name]</code></pre>
49	* Text can be excluded from doc using the following notation:
50	* <pre><code>(-- internal comment --)</code></pre>
51	* A few directives are available in documentation. Note that
52	* directives must appear on a single line to be properly
53	* identified. The `include` directive includes a markdown file from
54	* an external source:
55	* <pre><code>(== include path/to/file ==)</code></pre>
56	* The `resource_for` directive marks a message to be the resource of
57	* a collection in REST view. If it is not specified, tools attempt
58	* to infer the resource from the operations in a collection:
59	* <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
60	* The directive `suppress_warning` does not directly affect documentation
61	* and is documented together with service config validation.
62	*
63	* Generated from protobuf message <code>google.api.Documentation</code>
64	*/
65	class Documentation extends \Google\Protobuf\Internal\Message
66	{
67	/**
68	* A short summary of what the service does. Can only be provided by
69	* plain text.
70	*
71	* Generated from protobuf field <code>string summary = 1;</code>
72	*/
73	private $summary = '';
74	/**
75	* The top level pages for the documentation set.
76	*
77	* Generated from protobuf field <code>repeated .google.api.Page pages = 5;</code>
78	*/
79	private $pages;
80	/**
81	* A list of documentation rules that apply to individual API elements.
82	* NOTE: All service configuration rules follow "last one wins" order.
83	*
84	* Generated from protobuf field <code>repeated .google.api.DocumentationRule rules = 3;</code>
85	*/
86	private $rules;
87	/**
88	* The URL to the root of documentation.
89	*
90	* Generated from protobuf field <code>string documentation_root_url = 4;</code>
91	*/
92	private $documentation_root_url = '';
93	/**
94	* Declares a single overview page. For example:
95	* <pre><code>documentation:
96	* summary: ...
97	* overview: (== include overview.md ==)
98	* </code></pre>
99	* This is a shortcut for the following declaration (using pages style):
100	* <pre><code>documentation:
101	* summary: ...
102	* pages:
103	* - name: Overview
104	* content: (== include overview.md ==)
105	* </code></pre>
106	* Note: you cannot specify both `overview` field and `pages` field.
107	*
108	* Generated from protobuf field <code>string overview = 2;</code>
109	*/
110	private $overview = '';
111
112	/**
113	* Constructor.
114	*
115	* @param array $data {
116	* Optional. Data for populating the Message object.
117	*
118	* @type string $summary
119	* A short summary of what the service does. Can only be provided by
120	* plain text.
121	* @type \Google\Api\Page[]\|\Google\Protobuf\Internal\RepeatedField $pages
122	* The top level pages for the documentation set.
123	* @type \Google\Api\DocumentationRule[]\|\Google\Protobuf\Internal\RepeatedField $rules
124	* A list of documentation rules that apply to individual API elements.
125	* NOTE: All service configuration rules follow "last one wins" order.
126	* @type string $documentation_root_url
127	* The URL to the root of documentation.
128	* @type string $overview
129	* Declares a single overview page. For example:
130	* <pre><code>documentation:
131	* summary: ...
132	* overview: (== include overview.md ==)
133	* </code></pre>
134	* This is a shortcut for the following declaration (using pages style):
135	* <pre><code>documentation:
136	* summary: ...
137	* pages:
138	* - name: Overview
139	* content: (== include overview.md ==)
140	* </code></pre>
141	* Note: you cannot specify both `overview` field and `pages` field.
142	* }
143	*/
144	public function __construct($data = NULL) {
145	\GPBMetadata\Google\Api\Documentation::initOnce();
146	parent::__construct($data);
147	}
148
149	/**
150	* A short summary of what the service does. Can only be provided by
151	* plain text.
152	*
153	* Generated from protobuf field <code>string summary = 1;</code>
154	* @return string
155	*/
156	public function getSummary()
157	{
158	return $this->summary;
159	}
160
161	/**
162	* A short summary of what the service does. Can only be provided by
163	* plain text.
164	*
165	* Generated from protobuf field <code>string summary = 1;</code>
166	* @param string $var
167	* @return $this
168	*/
169	public function setSummary($var)
170	{
171	GPBUtil::checkString($var, True);
172	$this->summary = $var;
173
174	return $this;
175	}
176
177	/**
178	* The top level pages for the documentation set.
179	*
180	* Generated from protobuf field <code>repeated .google.api.Page pages = 5;</code>
181	* @return \Google\Protobuf\Internal\RepeatedField
182	*/
183	public function getPages()
184	{
185	return $this->pages;
186	}
187
188	/**
189	* The top level pages for the documentation set.
190	*
191	* Generated from protobuf field <code>repeated .google.api.Page pages = 5;</code>
192	* @param \Google\Api\Page[]\|\Google\Protobuf\Internal\RepeatedField $var
193	* @return $this
194	*/
195	public function setPages($var)
196	{
197	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Api\Page::class);
198	$this->pages = $arr;
199
200	return $this;
201	}
202
203	/**
204	* A list of documentation rules that apply to individual API elements.
205	* NOTE: All service configuration rules follow "last one wins" order.
206	*
207	* Generated from protobuf field <code>repeated .google.api.DocumentationRule rules = 3;</code>
208	* @return \Google\Protobuf\Internal\RepeatedField
209	*/
210	public function getRules()
211	{
212	return $this->rules;
213	}
214
215	/**
216	* A list of documentation rules that apply to individual API elements.
217	* NOTE: All service configuration rules follow "last one wins" order.
218	*
219	* Generated from protobuf field <code>repeated .google.api.DocumentationRule rules = 3;</code>
220	* @param \Google\Api\DocumentationRule[]\|\Google\Protobuf\Internal\RepeatedField $var
221	* @return $this
222	*/
223	public function setRules($var)
224	{
225	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Api\DocumentationRule::class);
226	$this->rules = $arr;
227
228	return $this;
229	}
230
231	/**
232	* The URL to the root of documentation.
233	*
234	* Generated from protobuf field <code>string documentation_root_url = 4;</code>
235	* @return string
236	*/
237	public function getDocumentationRootUrl()
238	{
239	return $this->documentation_root_url;
240	}
241
242	/**
243	* The URL to the root of documentation.
244	*
245	* Generated from protobuf field <code>string documentation_root_url = 4;</code>
246	* @param string $var
247	* @return $this
248	*/
249	public function setDocumentationRootUrl($var)
250	{
251	GPBUtil::checkString($var, True);
252	$this->documentation_root_url = $var;
253
254	return $this;
255	}
256
257	/**
258	* Declares a single overview page. For example:
259	* <pre><code>documentation:
260	* summary: ...
261	* overview: (== include overview.md ==)
262	* </code></pre>
263	* This is a shortcut for the following declaration (using pages style):
264	* <pre><code>documentation:
265	* summary: ...
266	* pages:
267	* - name: Overview
268	* content: (== include overview.md ==)
269	* </code></pre>
270	* Note: you cannot specify both `overview` field and `pages` field.
271	*
272	* Generated from protobuf field <code>string overview = 2;</code>
273	* @return string
274	*/
275	public function getOverview()
276	{
277	return $this->overview;
278	}
279
280	/**
281	* Declares a single overview page. For example:
282	* <pre><code>documentation:
283	* summary: ...
284	* overview: (== include overview.md ==)
285	* </code></pre>
286	* This is a shortcut for the following declaration (using pages style):
287	* <pre><code>documentation:
288	* summary: ...
289	* pages:
290	* - name: Overview
291	* content: (== include overview.md ==)
292	* </code></pre>
293	* Note: you cannot specify both `overview` field and `pages` field.
294	*
295	* Generated from protobuf field <code>string overview = 2;</code>
296	* @param string $var
297	* @return $this
298	*/
299	public function setOverview($var)
300	{
301	GPBUtil::checkString($var, True);
302	$this->overview = $var;
303
304	return $this;
305	}
306
307	}
308
309