DocumentationRule.php — ShareThis Dashboard for Google Analytics 3.3.0

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

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

DocumentationRule.php

160 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	* A documentation rule provides information about individual API elements.
13	*
14	* Generated from protobuf message <code>google.api.DocumentationRule</code>
15	*/
16	class DocumentationRule extends \Google\Protobuf\Internal\Message
17	{
18	/**
19	* The selector is a comma-separated list of patterns. Each pattern is a
20	* qualified name of the element which may end in "*", indicating a wildcard.
21	* Wildcards are only allowed at the end and for a whole component of the
22	* qualified name, i.e. "foo." is ok, but not "foo.b" or "foo.*.bar". To
23	* specify a default for all applicable elements, the whole pattern "*"
24	* is used.
25	*
26	* Generated from protobuf field <code>string selector = 1;</code>
27	*/
28	private $selector = '';
29	/**
30	* Description of the selected API(s).
31	*
32	* Generated from protobuf field <code>string description = 2;</code>
33	*/
34	private $description = '';
35	/**
36	* Deprecation description of the selected element(s). It can be provided if an
37	* element is marked as `deprecated`.
38	*
39	* Generated from protobuf field <code>string deprecation_description = 3;</code>
40	*/
41	private $deprecation_description = '';
42
43	/**
44	* Constructor.
45	*
46	* @param array $data {
47	* Optional. Data for populating the Message object.
48	*
49	* @type string $selector
50	* The selector is a comma-separated list of patterns. Each pattern is a
51	* qualified name of the element which may end in "*", indicating a wildcard.
52	* Wildcards are only allowed at the end and for a whole component of the
53	* qualified name, i.e. "foo." is ok, but not "foo.b" or "foo.*.bar". To
54	* specify a default for all applicable elements, the whole pattern "*"
55	* is used.
56	* @type string $description
57	* Description of the selected API(s).
58	* @type string $deprecation_description
59	* Deprecation description of the selected element(s). It can be provided if an
60	* element is marked as `deprecated`.
61	* }
62	*/
63	public function __construct($data = NULL) {
64	\GPBMetadata\Google\Api\Documentation::initOnce();
65	parent::__construct($data);
66	}
67
68	/**
69	* The selector is a comma-separated list of patterns. Each pattern is a
70	* qualified name of the element which may end in "*", indicating a wildcard.
71	* Wildcards are only allowed at the end and for a whole component of the
72	* qualified name, i.e. "foo." is ok, but not "foo.b" or "foo.*.bar". To
73	* specify a default for all applicable elements, the whole pattern "*"
74	* is used.
75	*
76	* Generated from protobuf field <code>string selector = 1;</code>
77	* @return string
78	*/
79	public function getSelector()
80	{
81	return $this->selector;
82	}
83
84	/**
85	* The selector is a comma-separated list of patterns. Each pattern is a
86	* qualified name of the element which may end in "*", indicating a wildcard.
87	* Wildcards are only allowed at the end and for a whole component of the
88	* qualified name, i.e. "foo." is ok, but not "foo.b" or "foo.*.bar". To
89	* specify a default for all applicable elements, the whole pattern "*"
90	* is used.
91	*
92	* Generated from protobuf field <code>string selector = 1;</code>
93	* @param string $var
94	* @return $this
95	*/
96	public function setSelector($var)
97	{
98	GPBUtil::checkString($var, True);
99	$this->selector = $var;
100
101	return $this;
102	}
103
104	/**
105	* Description of the selected API(s).
106	*
107	* Generated from protobuf field <code>string description = 2;</code>
108	* @return string
109	*/
110	public function getDescription()
111	{
112	return $this->description;
113	}
114
115	/**
116	* Description of the selected API(s).
117	*
118	* Generated from protobuf field <code>string description = 2;</code>
119	* @param string $var
120	* @return $this
121	*/
122	public function setDescription($var)
123	{
124	GPBUtil::checkString($var, True);
125	$this->description = $var;
126
127	return $this;
128	}
129
130	/**
131	* Deprecation description of the selected element(s). It can be provided if an
132	* element is marked as `deprecated`.
133	*
134	* Generated from protobuf field <code>string deprecation_description = 3;</code>
135	* @return string
136	*/
137	public function getDeprecationDescription()
138	{
139	return $this->deprecation_description;
140	}
141
142	/**
143	* Deprecation description of the selected element(s). It can be provided if an
144	* element is marked as `deprecated`.
145	*
146	* Generated from protobuf field <code>string deprecation_description = 3;</code>
147	* @param string $var
148	* @return $this
149	*/
150	public function setDeprecationDescription($var)
151	{
152	GPBUtil::checkString($var, True);
153	$this->deprecation_description = $var;
154
155	return $this;
156	}
157
158	}
159
160