AuthRequirement.php — ShareThis Dashboard for Google Analytics trunk

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

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

AuthRequirement.php

159 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/api/auth.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	* User-defined authentication requirements, including support for
13	* [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
14	*
15	* Generated from protobuf message <code>google.api.AuthRequirement</code>
16	*/
17	class AuthRequirement extends \Google\Protobuf\Internal\Message
18	{
19	/**
20	* [id][google.api.AuthProvider.id] from authentication provider.
21	* Example:
22	* provider_id: bookstore_auth
23	*
24	* Generated from protobuf field <code>string provider_id = 1;</code>
25	*/
26	private $provider_id = '';
27	/**
28	* NOTE: This will be deprecated soon, once AuthProvider.audiences is
29	* implemented and accepted in all the runtime components.
30	* The list of JWT
31	* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
32	* that are allowed to access. A JWT containing any of these audiences will
33	* be accepted. When this setting is absent, only JWTs with audience
34	* "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
35	* will be accepted. For example, if no audiences are in the setting,
36	* LibraryService API will only accept JWTs with the following audience
37	* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
38	* Example:
39	* audiences: bookstore_android.apps.googleusercontent.com,
40	* bookstore_web.apps.googleusercontent.com
41	*
42	* Generated from protobuf field <code>string audiences = 2;</code>
43	*/
44	private $audiences = '';
45
46	/**
47	* Constructor.
48	*
49	* @param array $data {
50	* Optional. Data for populating the Message object.
51	*
52	* @type string $provider_id
53	* [id][google.api.AuthProvider.id] from authentication provider.
54	* Example:
55	* provider_id: bookstore_auth
56	* @type string $audiences
57	* NOTE: This will be deprecated soon, once AuthProvider.audiences is
58	* implemented and accepted in all the runtime components.
59	* The list of JWT
60	* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
61	* that are allowed to access. A JWT containing any of these audiences will
62	* be accepted. When this setting is absent, only JWTs with audience
63	* "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
64	* will be accepted. For example, if no audiences are in the setting,
65	* LibraryService API will only accept JWTs with the following audience
66	* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
67	* Example:
68	* audiences: bookstore_android.apps.googleusercontent.com,
69	* bookstore_web.apps.googleusercontent.com
70	* }
71	*/
72	public function __construct($data = NULL) {
73	\GPBMetadata\Google\Api\Auth::initOnce();
74	parent::__construct($data);
75	}
76
77	/**
78	* [id][google.api.AuthProvider.id] from authentication provider.
79	* Example:
80	* provider_id: bookstore_auth
81	*
82	* Generated from protobuf field <code>string provider_id = 1;</code>
83	* @return string
84	*/
85	public function getProviderId()
86	{
87	return $this->provider_id;
88	}
89
90	/**
91	* [id][google.api.AuthProvider.id] from authentication provider.
92	* Example:
93	* provider_id: bookstore_auth
94	*
95	* Generated from protobuf field <code>string provider_id = 1;</code>
96	* @param string $var
97	* @return $this
98	*/
99	public function setProviderId($var)
100	{
101	GPBUtil::checkString($var, True);
102	$this->provider_id = $var;
103
104	return $this;
105	}
106
107	/**
108	* NOTE: This will be deprecated soon, once AuthProvider.audiences is
109	* implemented and accepted in all the runtime components.
110	* The list of JWT
111	* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
112	* that are allowed to access. A JWT containing any of these audiences will
113	* be accepted. When this setting is absent, only JWTs with audience
114	* "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
115	* will be accepted. For example, if no audiences are in the setting,
116	* LibraryService API will only accept JWTs with the following audience
117	* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
118	* Example:
119	* audiences: bookstore_android.apps.googleusercontent.com,
120	* bookstore_web.apps.googleusercontent.com
121	*
122	* Generated from protobuf field <code>string audiences = 2;</code>
123	* @return string
124	*/
125	public function getAudiences()
126	{
127	return $this->audiences;
128	}
129
130	/**
131	* NOTE: This will be deprecated soon, once AuthProvider.audiences is
132	* implemented and accepted in all the runtime components.
133	* The list of JWT
134	* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
135	* that are allowed to access. A JWT containing any of these audiences will
136	* be accepted. When this setting is absent, only JWTs with audience
137	* "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
138	* will be accepted. For example, if no audiences are in the setting,
139	* LibraryService API will only accept JWTs with the following audience
140	* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
141	* Example:
142	* audiences: bookstore_android.apps.googleusercontent.com,
143	* bookstore_web.apps.googleusercontent.com
144	*
145	* Generated from protobuf field <code>string audiences = 2;</code>
146	* @param string $var
147	* @return $this
148	*/
149	public function setAudiences($var)
150	{
151	GPBUtil::checkString($var, True);
152	$this->audiences = $var;
153
154	return $this;
155	}
156
157	}
158
159