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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="beyondcorp_v1alpha.html">BeyondCorp API</a> . <a href="beyondcorp_v1alpha.organizations.html">organizations</a> . <a href="beyondcorp_v1alpha.organizations.locations.html">locations</a> . <a href="beyondcorp_v1alpha.organizations.locations.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#cancel">cancel(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Subscription.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Subscriptions in a given organization and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.</p>
<p class="toc_element">
<code><a href="#restart">restart(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Restarts an existing BeyondCorp Enterprise Subscription in a given organization, that is scheduled for cancellation. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="cancel">cancel(name, requestId=None, x__xgafv=None)</code>
<pre>Cancels an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective
Args:
name: string, Required. Name of the resource. (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for BeyondCorp.CancelSubscription
"effectiveCancellationTime": "A String", # Time when the cancellation will become effective
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.
Args:
parent: string, Required. The resource name of the subscription location using the form: `organizations/{organization_id}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
"autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
"billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
"createTime": "A String", # Output only. Create time of the subscription.
"csgCustomer": True or False, # Optional. Whether the subscription is being created as part of the Citrix flow. If this field is set to true, the subscription should have both the start_time and end_time set in the request and the billing account used will be the Citrix master billing account regardless of what its set to in the request. This field can only be set to true in create requests.
"endTime": "A String", # Optional. End time of the subscription.
"name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
"seatCount": "A String", # Optional. Number of seats in the subscription.
"sku": "A String", # Required. SKU of subscription.
"startTime": "A String", # Optional. Start time of the subscription.
"state": "A String", # Output only. The current state of the subscription.
"subscriberType": "A String", # Output only. Type of subscriber.
"type": "A String", # Required. Type of subscription.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
"autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
"billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
"createTime": "A String", # Output only. Create time of the subscription.
"csgCustomer": True or False, # Optional. Whether the subscription is being created as part of the Citrix flow. If this field is set to true, the subscription should have both the start_time and end_time set in the request and the billing account used will be the Citrix master billing account regardless of what its set to in the request. This field can only be set to true in create requests.
"endTime": "A String", # Optional. End time of the subscription.
"name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
"seatCount": "A String", # Optional. Number of seats in the subscription.
"sku": "A String", # Required. SKU of subscription.
"startTime": "A String", # Optional. Start time of the subscription.
"state": "A String", # Output only. The current state of the subscription.
"subscriberType": "A String", # Output only. Type of subscriber.
"type": "A String", # Required. Type of subscription.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Subscription.
Args:
name: string, Required. The resource name of Subscription using the form: `organizations/{organization_id}/locations/{location}/subscriptions/{subscription_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
"autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
"billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
"createTime": "A String", # Output only. Create time of the subscription.
"csgCustomer": True or False, # Optional. Whether the subscription is being created as part of the Citrix flow. If this field is set to true, the subscription should have both the start_time and end_time set in the request and the billing account used will be the Citrix master billing account regardless of what its set to in the request. This field can only be set to true in create requests.
"endTime": "A String", # Optional. End time of the subscription.
"name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
"seatCount": "A String", # Optional. Number of seats in the subscription.
"sku": "A String", # Required. SKU of subscription.
"startTime": "A String", # Optional. Start time of the subscription.
"state": "A String", # Output only. The current state of the subscription.
"subscriberType": "A String", # Output only. Type of subscriber.
"type": "A String", # Required. Type of subscription.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Subscriptions in a given organization and location.
Args:
parent: string, Required. The resource name of Subscription using the form: `organizations/{organization_id}/locations/{location}` (required)
pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
pageToken: string, Optional. The next_page_token value returned from a previous ListSubscriptionsRequest, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for BeyondCorp.ListSubscriptions.
"nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list.
"subscriptions": [ # A list of BeyondCorp Subscriptions in the organization.
{ # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
"autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
"billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
"createTime": "A String", # Output only. Create time of the subscription.
"csgCustomer": True or False, # Optional. Whether the subscription is being created as part of the Citrix flow. If this field is set to true, the subscription should have both the start_time and end_time set in the request and the billing account used will be the Citrix master billing account regardless of what its set to in the request. This field can only be set to true in create requests.
"endTime": "A String", # Optional. End time of the subscription.
"name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
"seatCount": "A String", # Optional. Number of seats in the subscription.
"sku": "A String", # Required. SKU of subscription.
"startTime": "A String", # Optional. Start time of the subscription.
"state": "A String", # Output only. The current state of the subscription.
"subscriberType": "A String", # Output only. Type of subscriber.
"type": "A String", # Required. Type of subscription.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.
Args:
name: string, Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription. (required)
body: object, The request body.
The object takes the form of:
{ # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
"autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
"billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
"createTime": "A String", # Output only. Create time of the subscription.
"csgCustomer": True or False, # Optional. Whether the subscription is being created as part of the Citrix flow. If this field is set to true, the subscription should have both the start_time and end_time set in the request and the billing account used will be the Citrix master billing account regardless of what its set to in the request. This field can only be set to true in create requests.
"endTime": "A String", # Optional. End time of the subscription.
"name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
"seatCount": "A String", # Optional. Number of seats in the subscription.
"sku": "A String", # Required. SKU of subscription.
"startTime": "A String", # Optional. Start time of the subscription.
"state": "A String", # Output only. The current state of the subscription.
"subscriberType": "A String", # Output only. Type of subscriber.
"type": "A String", # Required. Type of subscription.
}
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Subscription resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. Mutable fields: seat_count.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A BeyondCorp Subscription resource represents BeyondCorp Enterprise Subscription. BeyondCorp Enterprise Subscription enables BeyondCorp Enterprise permium features for an organization.
"autoRenewEnabled": True or False, # Output only. Represents that, if subscription will renew or end when the term ends.
"billingAccount": "A String", # Optional. Name of the billing account in the format. e.g. billingAccounts/123456-123456-123456 Required if Subscription is of Paid type.
"createTime": "A String", # Output only. Create time of the subscription.
"csgCustomer": True or False, # Optional. Whether the subscription is being created as part of the Citrix flow. If this field is set to true, the subscription should have both the start_time and end_time set in the request and the billing account used will be the Citrix master billing account regardless of what its set to in the request. This field can only be set to true in create requests.
"endTime": "A String", # Optional. End time of the subscription.
"name": "A String", # Identifier. Unique resource name of the Subscription. The name is ignored when creating a subscription.
"seatCount": "A String", # Optional. Number of seats in the subscription.
"sku": "A String", # Required. SKU of subscription.
"startTime": "A String", # Optional. Start time of the subscription.
"state": "A String", # Output only. The current state of the subscription.
"subscriberType": "A String", # Output only. Type of subscriber.
"type": "A String", # Required. Type of subscription.
}</pre>
</div>
<div class="method">
<code class="details" id="restart">restart(name, requestId=None, x__xgafv=None)</code>
<pre>Restarts an existing BeyondCorp Enterprise Subscription in a given organization, that is scheduled for cancellation. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective
Args:
name: string, Required. Name of the resource. (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for BeyondCorp.RestartSubscription
}</pre>
</div>
</body></html>
|
