-
Notifications
You must be signed in to change notification settings - Fork 461
Expand file tree
/
Copy pathPushConfig.php
More file actions
294 lines (268 loc) · 12.5 KB
/
PushConfig.php
File metadata and controls
294 lines (268 loc) · 12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/cloud/bigquery/analyticshub/v1/pubsub.proto
namespace Google\Cloud\BigQuery\AnalyticsHub\V1;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\GPBUtil;
use Google\Protobuf\RepeatedField;
/**
* Configuration for a push delivery endpoint.
*
* Generated from protobuf message <code>google.cloud.bigquery.analyticshub.v1.PushConfig</code>
*/
class PushConfig extends \Google\Protobuf\Internal\Message
{
/**
* Optional. A URL locating the endpoint to which messages should be pushed.
* For example, a Webhook endpoint might use `https://example.com/push`.
*
* Generated from protobuf field <code>string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
protected $push_endpoint = '';
/**
* Optional. Endpoint configuration attributes that can be used to control
* different aspects of the message delivery.
* The only currently supported attribute is `x-goog-version`, which you can
* use to change the format of the pushed message. This attribute
* indicates the version of the data expected by the endpoint. This
* controls the shape of the pushed message (i.e., its fields and metadata).
* If not present during the `CreateSubscription` call, it will default to
* the version of the Pub/Sub API used to make such call. If not present in a
* `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
* calls will always return a valid version, even if the subscription was
* created without this attribute.
* The only supported values for the `x-goog-version` attribute are:
* * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
* * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
* For example:
* `attributes { "x-goog-version": "v1" }`
*
* Generated from protobuf field <code>map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
*/
private $attributes;
protected $authentication_method;
protected $wrapper;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\OidcToken $oidc_token
* Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
* token as an `Authorization` header in the HTTP request for every pushed
* message.
* @type \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\PubsubWrapper $pubsub_wrapper
* Optional. When set, the payload to the push endpoint is in the form of
* the JSON representation of a PubsubMessage
* (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
* @type \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\NoWrapper $no_wrapper
* Optional. When set, the payload to the push endpoint is not wrapped.
* @type string $push_endpoint
* Optional. A URL locating the endpoint to which messages should be pushed.
* For example, a Webhook endpoint might use `https://example.com/push`.
* @type array|\Google\Protobuf\Internal\MapField $attributes
* Optional. Endpoint configuration attributes that can be used to control
* different aspects of the message delivery.
* The only currently supported attribute is `x-goog-version`, which you can
* use to change the format of the pushed message. This attribute
* indicates the version of the data expected by the endpoint. This
* controls the shape of the pushed message (i.e., its fields and metadata).
* If not present during the `CreateSubscription` call, it will default to
* the version of the Pub/Sub API used to make such call. If not present in a
* `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
* calls will always return a valid version, even if the subscription was
* created without this attribute.
* The only supported values for the `x-goog-version` attribute are:
* * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
* * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
* For example:
* `attributes { "x-goog-version": "v1" }`
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Bigquery\Analyticshub\V1\Pubsub::initOnce();
parent::__construct($data);
}
/**
* Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
* token as an `Authorization` header in the HTTP request for every pushed
* message.
*
* Generated from protobuf field <code>.google.cloud.bigquery.analyticshub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\OidcToken|null
*/
public function getOidcToken()
{
return $this->readOneof(3);
}
public function hasOidcToken()
{
return $this->hasOneof(3);
}
/**
* Optional. If specified, Pub/Sub will generate and attach an OIDC JWT
* token as an `Authorization` header in the HTTP request for every pushed
* message.
*
* Generated from protobuf field <code>.google.cloud.bigquery.analyticshub.v1.PushConfig.OidcToken oidc_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\OidcToken $var
* @return $this
*/
public function setOidcToken($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\OidcToken::class);
$this->writeOneof(3, $var);
return $this;
}
/**
* Optional. When set, the payload to the push endpoint is in the form of
* the JSON representation of a PubsubMessage
* (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
*
* Generated from protobuf field <code>.google.cloud.bigquery.analyticshub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\PubsubWrapper|null
*/
public function getPubsubWrapper()
{
return $this->readOneof(4);
}
public function hasPubsubWrapper()
{
return $this->hasOneof(4);
}
/**
* Optional. When set, the payload to the push endpoint is in the form of
* the JSON representation of a PubsubMessage
* (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#pubsubmessage).
*
* Generated from protobuf field <code>.google.cloud.bigquery.analyticshub.v1.PushConfig.PubsubWrapper pubsub_wrapper = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\PubsubWrapper $var
* @return $this
*/
public function setPubsubWrapper($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\PubsubWrapper::class);
$this->writeOneof(4, $var);
return $this;
}
/**
* Optional. When set, the payload to the push endpoint is not wrapped.
*
* Generated from protobuf field <code>.google.cloud.bigquery.analyticshub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\NoWrapper|null
*/
public function getNoWrapper()
{
return $this->readOneof(5);
}
public function hasNoWrapper()
{
return $this->hasOneof(5);
}
/**
* Optional. When set, the payload to the push endpoint is not wrapped.
*
* Generated from protobuf field <code>.google.cloud.bigquery.analyticshub.v1.PushConfig.NoWrapper no_wrapper = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\NoWrapper $var
* @return $this
*/
public function setNoWrapper($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\AnalyticsHub\V1\PushConfig\NoWrapper::class);
$this->writeOneof(5, $var);
return $this;
}
/**
* Optional. A URL locating the endpoint to which messages should be pushed.
* For example, a Webhook endpoint might use `https://example.com/push`.
*
* Generated from protobuf field <code>string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return string
*/
public function getPushEndpoint()
{
return $this->push_endpoint;
}
/**
* Optional. A URL locating the endpoint to which messages should be pushed.
* For example, a Webhook endpoint might use `https://example.com/push`.
*
* Generated from protobuf field <code>string push_endpoint = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param string $var
* @return $this
*/
public function setPushEndpoint($var)
{
GPBUtil::checkString($var, True);
$this->push_endpoint = $var;
return $this;
}
/**
* Optional. Endpoint configuration attributes that can be used to control
* different aspects of the message delivery.
* The only currently supported attribute is `x-goog-version`, which you can
* use to change the format of the pushed message. This attribute
* indicates the version of the data expected by the endpoint. This
* controls the shape of the pushed message (i.e., its fields and metadata).
* If not present during the `CreateSubscription` call, it will default to
* the version of the Pub/Sub API used to make such call. If not present in a
* `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
* calls will always return a valid version, even if the subscription was
* created without this attribute.
* The only supported values for the `x-goog-version` attribute are:
* * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
* * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
* For example:
* `attributes { "x-goog-version": "v1" }`
*
* Generated from protobuf field <code>map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
* @return \Google\Protobuf\Internal\MapField
*/
public function getAttributes()
{
return $this->attributes;
}
/**
* Optional. Endpoint configuration attributes that can be used to control
* different aspects of the message delivery.
* The only currently supported attribute is `x-goog-version`, which you can
* use to change the format of the pushed message. This attribute
* indicates the version of the data expected by the endpoint. This
* controls the shape of the pushed message (i.e., its fields and metadata).
* If not present during the `CreateSubscription` call, it will default to
* the version of the Pub/Sub API used to make such call. If not present in a
* `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
* calls will always return a valid version, even if the subscription was
* created without this attribute.
* The only supported values for the `x-goog-version` attribute are:
* * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
* * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
* For example:
* `attributes { "x-goog-version": "v1" }`
*
* Generated from protobuf field <code>map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
* @param array|\Google\Protobuf\Internal\MapField $var
* @return $this
*/
public function setAttributes($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->attributes = $arr;
return $this;
}
/**
* @return string
*/
public function getAuthenticationMethod()
{
return $this->whichOneof("authentication_method");
}
/**
* @return string
*/
public function getWrapper()
{
return $this->whichOneof("wrapper");
}
}