media-cloud-sync / includes / sdk / google / google / common-protos / src / Api / Documentation.php

Documentation.php in Media Cloud Sync 1.4.2, at includes/sdk/google/google/common-protos/src/Api/Documentation.php

342 lines 12.7 KB

Raw Download Zip

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