ResourceDescriptor.php — ShareThis Dashboard for Google Analytics trunk

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

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

ResourceDescriptor.php

482 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/api/resource.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 simple descriptor of a resource type.
13	* ResourceDescriptor annotates a resource message (either by means of a
14	* protobuf annotation or use in the service config), and associates the
15	* resource's schema, the resource type, and the pattern of the resource name.
16	* Example:
17	* message Topic {
18	* // Indicates this message defines a resource schema.
19	* // Declares the resource type in the format of {service}/{kind}.
20	* // For Kubernetes resources, the format is {api group}/{kind}.
21	* option (google.api.resource) = {
22	* type: "pubsub.googleapis.com/Topic"
23	* name_descriptor: {
24	* pattern: "projects/{project}/topics/{topic}"
25	* parent_type: "cloudresourcemanager.googleapis.com/Project"
26	* parent_name_extractor: "projects/{project}"
27	* }
28	* };
29	* }
30	* The ResourceDescriptor Yaml config will look like:
31	* resources:
32	* - type: "pubsub.googleapis.com/Topic"
33	* name_descriptor:
34	* - pattern: "projects/{project}/topics/{topic}"
35	* parent_type: "cloudresourcemanager.googleapis.com/Project"
36	* parent_name_extractor: "projects/{project}"
37	* Sometimes, resources have multiple patterns, typically because they can
38	* live under multiple parents.
39	* Example:
40	* message LogEntry {
41	* option (google.api.resource) = {
42	* type: "logging.googleapis.com/LogEntry"
43	* name_descriptor: {
44	* pattern: "projects/{project}/logs/{log}"
45	* parent_type: "cloudresourcemanager.googleapis.com/Project"
46	* parent_name_extractor: "projects/{project}"
47	* }
48	* name_descriptor: {
49	* pattern: "folders/{folder}/logs/{log}"
50	* parent_type: "cloudresourcemanager.googleapis.com/Folder"
51	* parent_name_extractor: "folders/{folder}"
52	* }
53	* name_descriptor: {
54	* pattern: "organizations/{organization}/logs/{log}"
55	* parent_type: "cloudresourcemanager.googleapis.com/Organization"
56	* parent_name_extractor: "organizations/{organization}"
57	* }
58	* name_descriptor: {
59	* pattern: "billingAccounts/{billing_account}/logs/{log}"
60	* parent_type: "billing.googleapis.com/BillingAccount"
61	* parent_name_extractor: "billingAccounts/{billing_account}"
62	* }
63	* };
64	* }
65	* The ResourceDescriptor Yaml config will look like:
66	* resources:
67	* - type: 'logging.googleapis.com/LogEntry'
68	* name_descriptor:
69	* - pattern: "projects/{project}/logs/{log}"
70	* parent_type: "cloudresourcemanager.googleapis.com/Project"
71	* parent_name_extractor: "projects/{project}"
72	* - pattern: "folders/{folder}/logs/{log}"
73	* parent_type: "cloudresourcemanager.googleapis.com/Folder"
74	* parent_name_extractor: "folders/{folder}"
75	* - pattern: "organizations/{organization}/logs/{log}"
76	* parent_type: "cloudresourcemanager.googleapis.com/Organization"
77	* parent_name_extractor: "organizations/{organization}"
78	* - pattern: "billingAccounts/{billing_account}/logs/{log}"
79	* parent_type: "billing.googleapis.com/BillingAccount"
80	* parent_name_extractor: "billingAccounts/{billing_account}"
81	* For flexible resources, the resource name doesn't contain parent names, but
82	* the resource itself has parents for policy evaluation.
83	* Example:
84	* message Shelf {
85	* option (google.api.resource) = {
86	* type: "library.googleapis.com/Shelf"
87	* name_descriptor: {
88	* pattern: "shelves/{shelf}"
89	* parent_type: "cloudresourcemanager.googleapis.com/Project"
90	* }
91	* name_descriptor: {
92	* pattern: "shelves/{shelf}"
93	* parent_type: "cloudresourcemanager.googleapis.com/Folder"
94	* }
95	* };
96	* }
97	* The ResourceDescriptor Yaml config will look like:
98	* resources:
99	* - type: 'library.googleapis.com/Shelf'
100	* name_descriptor:
101	* - pattern: "shelves/{shelf}"
102	* parent_type: "cloudresourcemanager.googleapis.com/Project"
103	* - pattern: "shelves/{shelf}"
104	* parent_type: "cloudresourcemanager.googleapis.com/Folder"
105	*
106	* Generated from protobuf message <code>google.api.ResourceDescriptor</code>
107	*/
108	class ResourceDescriptor extends \Google\Protobuf\Internal\Message
109	{
110	/**
111	* The resource type. It must be in the format of
112	* {service_name}/{resource_type_kind}. The `resource_type_kind` must be
113	* singular and must not include version numbers.
114	* Example: `storage.googleapis.com/Bucket`
115	* The value of the resource_type_kind must follow the regular expression
116	* /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
117	* should use PascalCase (UpperCamelCase). The maximum number of
118	* characters allowed for the `resource_type_kind` is 100.
119	*
120	* Generated from protobuf field <code>string type = 1;</code>
121	*/
122	private $type = '';
123	/**
124	* Optional. The relative resource name pattern associated with this resource
125	* type. The DNS prefix of the full resource name shouldn't be specified here.
126	* The path pattern must follow the syntax, which aligns with HTTP binding
127	* syntax:
128	* Template = Segment { "/" Segment } ;
129	* Segment = LITERAL \| Variable ;
130	* Variable = "{" LITERAL "}" ;
131	* Examples:
132	* - "projects/{project}/topics/{topic}"
133	* - "projects/{project}/knowledgeBases/{knowledge_base}"
134	* The components in braces correspond to the IDs for each resource in the
135	* hierarchy. It is expected that, if multiple patterns are provided,
136	* the same component name (e.g. "project") refers to IDs of the same
137	* type of resource.
138	*
139	* Generated from protobuf field <code>repeated string pattern = 2;</code>
140	*/
141	private $pattern;
142	/**
143	* Optional. The field on the resource that designates the resource name
144	* field. If omitted, this is assumed to be "name".
145	*
146	* Generated from protobuf field <code>string name_field = 3;</code>
147	*/
148	private $name_field = '';
149	/**
150	* Optional. The historical or future-looking state of the resource pattern.
151	* Example:
152	* // The InspectTemplate message originally only supported resource
153	* // names with organization, and project was added later.
154	* message InspectTemplate {
155	* option (google.api.resource) = {
156	* type: "dlp.googleapis.com/InspectTemplate"
157	* pattern:
158	* "organizations/{organization}/inspectTemplates/{inspect_template}"
159	* pattern: "projects/{project}/inspectTemplates/{inspect_template}"
160	* history: ORIGINALLY_SINGLE_PATTERN
161	* };
162	* }
163	*
164	* Generated from protobuf field <code>.google.api.ResourceDescriptor.History history = 4;</code>
165	*/
166	private $history = 0;
167	/**
168	* The plural name used in the resource name, such as 'projects' for
169	* the name of 'projects/{project}'. It is the same concept of the `plural`
170	* field in k8s CRD spec
171	* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
172	*
173	* Generated from protobuf field <code>string plural = 5;</code>
174	*/
175	private $plural = '';
176	/**
177	* The same concept of the `singular` field in k8s CRD spec
178	* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
179	* Such as "project" for the `resourcemanager.googleapis.com/Project` type.
180	*
181	* Generated from protobuf field <code>string singular = 6;</code>
182	*/
183	private $singular = '';
184
185	/**
186	* Constructor.
187	*
188	* @param array $data {
189	* Optional. Data for populating the Message object.
190	*
191	* @type string $type
192	* The resource type. It must be in the format of
193	* {service_name}/{resource_type_kind}. The `resource_type_kind` must be
194	* singular and must not include version numbers.
195	* Example: `storage.googleapis.com/Bucket`
196	* The value of the resource_type_kind must follow the regular expression
197	* /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
198	* should use PascalCase (UpperCamelCase). The maximum number of
199	* characters allowed for the `resource_type_kind` is 100.
200	* @type string[]\|\Google\Protobuf\Internal\RepeatedField $pattern
201	* Optional. The relative resource name pattern associated with this resource
202	* type. The DNS prefix of the full resource name shouldn't be specified here.
203	* The path pattern must follow the syntax, which aligns with HTTP binding
204	* syntax:
205	* Template = Segment { "/" Segment } ;
206	* Segment = LITERAL \| Variable ;
207	* Variable = "{" LITERAL "}" ;
208	* Examples:
209	* - "projects/{project}/topics/{topic}"
210	* - "projects/{project}/knowledgeBases/{knowledge_base}"
211	* The components in braces correspond to the IDs for each resource in the
212	* hierarchy. It is expected that, if multiple patterns are provided,
213	* the same component name (e.g. "project") refers to IDs of the same
214	* type of resource.
215	* @type string $name_field
216	* Optional. The field on the resource that designates the resource name
217	* field. If omitted, this is assumed to be "name".
218	* @type int $history
219	* Optional. The historical or future-looking state of the resource pattern.
220	* Example:
221	* // The InspectTemplate message originally only supported resource
222	* // names with organization, and project was added later.
223	* message InspectTemplate {
224	* option (google.api.resource) = {
225	* type: "dlp.googleapis.com/InspectTemplate"
226	* pattern:
227	* "organizations/{organization}/inspectTemplates/{inspect_template}"
228	* pattern: "projects/{project}/inspectTemplates/{inspect_template}"
229	* history: ORIGINALLY_SINGLE_PATTERN
230	* };
231	* }
232	* @type string $plural
233	* The plural name used in the resource name, such as 'projects' for
234	* the name of 'projects/{project}'. It is the same concept of the `plural`
235	* field in k8s CRD spec
236	* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
237	* @type string $singular
238	* The same concept of the `singular` field in k8s CRD spec
239	* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
240	* Such as "project" for the `resourcemanager.googleapis.com/Project` type.
241	* }
242	*/
243	public function __construct($data = NULL) {
244	\GPBMetadata\Google\Api\Resource::initOnce();
245	parent::__construct($data);
246	}
247
248	/**
249	* The resource type. It must be in the format of
250	* {service_name}/{resource_type_kind}. The `resource_type_kind` must be
251	* singular and must not include version numbers.
252	* Example: `storage.googleapis.com/Bucket`
253	* The value of the resource_type_kind must follow the regular expression
254	* /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
255	* should use PascalCase (UpperCamelCase). The maximum number of
256	* characters allowed for the `resource_type_kind` is 100.
257	*
258	* Generated from protobuf field <code>string type = 1;</code>
259	* @return string
260	*/
261	public function getType()
262	{
263	return $this->type;
264	}
265
266	/**
267	* The resource type. It must be in the format of
268	* {service_name}/{resource_type_kind}. The `resource_type_kind` must be
269	* singular and must not include version numbers.
270	* Example: `storage.googleapis.com/Bucket`
271	* The value of the resource_type_kind must follow the regular expression
272	* /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
273	* should use PascalCase (UpperCamelCase). The maximum number of
274	* characters allowed for the `resource_type_kind` is 100.
275	*
276	* Generated from protobuf field <code>string type = 1;</code>
277	* @param string $var
278	* @return $this
279	*/
280	public function setType($var)
281	{
282	GPBUtil::checkString($var, True);
283	$this->type = $var;
284
285	return $this;
286	}
287
288	/**
289	* Optional. The relative resource name pattern associated with this resource
290	* type. The DNS prefix of the full resource name shouldn't be specified here.
291	* The path pattern must follow the syntax, which aligns with HTTP binding
292	* syntax:
293	* Template = Segment { "/" Segment } ;
294	* Segment = LITERAL \| Variable ;
295	* Variable = "{" LITERAL "}" ;
296	* Examples:
297	* - "projects/{project}/topics/{topic}"
298	* - "projects/{project}/knowledgeBases/{knowledge_base}"
299	* The components in braces correspond to the IDs for each resource in the
300	* hierarchy. It is expected that, if multiple patterns are provided,
301	* the same component name (e.g. "project") refers to IDs of the same
302	* type of resource.
303	*
304	* Generated from protobuf field <code>repeated string pattern = 2;</code>
305	* @return \Google\Protobuf\Internal\RepeatedField
306	*/
307	public function getPattern()
308	{
309	return $this->pattern;
310	}
311
312	/**
313	* Optional. The relative resource name pattern associated with this resource
314	* type. The DNS prefix of the full resource name shouldn't be specified here.
315	* The path pattern must follow the syntax, which aligns with HTTP binding
316	* syntax:
317	* Template = Segment { "/" Segment } ;
318	* Segment = LITERAL \| Variable ;
319	* Variable = "{" LITERAL "}" ;
320	* Examples:
321	* - "projects/{project}/topics/{topic}"
322	* - "projects/{project}/knowledgeBases/{knowledge_base}"
323	* The components in braces correspond to the IDs for each resource in the
324	* hierarchy. It is expected that, if multiple patterns are provided,
325	* the same component name (e.g. "project") refers to IDs of the same
326	* type of resource.
327	*
328	* Generated from protobuf field <code>repeated string pattern = 2;</code>
329	* @param string[]\|\Google\Protobuf\Internal\RepeatedField $var
330	* @return $this
331	*/
332	public function setPattern($var)
333	{
334	$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
335	$this->pattern = $arr;
336
337	return $this;
338	}
339
340	/**
341	* Optional. The field on the resource that designates the resource name
342	* field. If omitted, this is assumed to be "name".
343	*
344	* Generated from protobuf field <code>string name_field = 3;</code>
345	* @return string
346	*/
347	public function getNameField()
348	{
349	return $this->name_field;
350	}
351
352	/**
353	* Optional. The field on the resource that designates the resource name
354	* field. If omitted, this is assumed to be "name".
355	*
356	* Generated from protobuf field <code>string name_field = 3;</code>
357	* @param string $var
358	* @return $this
359	*/
360	public function setNameField($var)
361	{
362	GPBUtil::checkString($var, True);
363	$this->name_field = $var;
364
365	return $this;
366	}
367
368	/**
369	* Optional. The historical or future-looking state of the resource pattern.
370	* Example:
371	* // The InspectTemplate message originally only supported resource
372	* // names with organization, and project was added later.
373	* message InspectTemplate {
374	* option (google.api.resource) = {
375	* type: "dlp.googleapis.com/InspectTemplate"
376	* pattern:
377	* "organizations/{organization}/inspectTemplates/{inspect_template}"
378	* pattern: "projects/{project}/inspectTemplates/{inspect_template}"
379	* history: ORIGINALLY_SINGLE_PATTERN
380	* };
381	* }
382	*
383	* Generated from protobuf field <code>.google.api.ResourceDescriptor.History history = 4;</code>
384	* @return int
385	*/
386	public function getHistory()
387	{
388	return $this->history;
389	}
390
391	/**
392	* Optional. The historical or future-looking state of the resource pattern.
393	* Example:
394	* // The InspectTemplate message originally only supported resource
395	* // names with organization, and project was added later.
396	* message InspectTemplate {
397	* option (google.api.resource) = {
398	* type: "dlp.googleapis.com/InspectTemplate"
399	* pattern:
400	* "organizations/{organization}/inspectTemplates/{inspect_template}"
401	* pattern: "projects/{project}/inspectTemplates/{inspect_template}"
402	* history: ORIGINALLY_SINGLE_PATTERN
403	* };
404	* }
405	*
406	* Generated from protobuf field <code>.google.api.ResourceDescriptor.History history = 4;</code>
407	* @param int $var
408	* @return $this
409	*/
410	public function setHistory($var)
411	{
412	GPBUtil::checkEnum($var, \Google\Api\ResourceDescriptor_History::class);
413	$this->history = $var;
414
415	return $this;
416	}
417
418	/**
419	* The plural name used in the resource name, such as 'projects' for
420	* the name of 'projects/{project}'. It is the same concept of the `plural`
421	* field in k8s CRD spec
422	* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
423	*
424	* Generated from protobuf field <code>string plural = 5;</code>
425	* @return string
426	*/
427	public function getPlural()
428	{
429	return $this->plural;
430	}
431
432	/**
433	* The plural name used in the resource name, such as 'projects' for
434	* the name of 'projects/{project}'. It is the same concept of the `plural`
435	* field in k8s CRD spec
436	* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
437	*
438	* Generated from protobuf field <code>string plural = 5;</code>
439	* @param string $var
440	* @return $this
441	*/
442	public function setPlural($var)
443	{
444	GPBUtil::checkString($var, True);
445	$this->plural = $var;
446
447	return $this;
448	}
449
450	/**
451	* The same concept of the `singular` field in k8s CRD spec
452	* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
453	* Such as "project" for the `resourcemanager.googleapis.com/Project` type.
454	*
455	* Generated from protobuf field <code>string singular = 6;</code>
456	* @return string
457	*/
458	public function getSingular()
459	{
460	return $this->singular;
461	}
462
463	/**
464	* The same concept of the `singular` field in k8s CRD spec
465	* https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
466	* Such as "project" for the `resourcemanager.googleapis.com/Project` type.
467	*
468	* Generated from protobuf field <code>string singular = 6;</code>
469	* @param string $var
470	* @return $this
471	*/
472	public function setSingular($var)
473	{
474	GPBUtil::checkString($var, True);
475	$this->singular = $var;
476
477	return $this;
478	}
479
480	}
481
482