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
|
<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="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.authorizations.html">authorizations</a></h1>
<h2>Instance Methods</h2>
<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, authorizationId=None, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an Authorization.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an Authorization.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an Authorization.</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 all Authorizations under an Engine.</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, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an Authorization</p>
<h3>Method Details</h3>
<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, authorizationId=None, body=None, x__xgafv=None)</code>
<pre>Creates an Authorization.
Args:
parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # Discovery Engine Authorization resource.
"displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
"name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
"authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
"clientId": "A String", # Required. The OAuth2 client ID.
"clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
"pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
"scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
"A String",
],
"tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
},
}
authorizationId: string, Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Discovery Engine Authorization resource.
"displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
"name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
"authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
"clientId": "A String", # Required. The OAuth2 client ID.
"clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
"pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
"scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
"A String",
],
"tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an Authorization.
Args:
name: string, Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an Authorization.
Args:
name: string, Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Discovery Engine Authorization resource.
"displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
"name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
"authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
"clientId": "A String", # Required. The OAuth2 client ID.
"clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
"pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
"scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
"A String",
],
"tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all Authorizations under an Engine.
Args:
parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}` (required)
pageSize: integer, Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
pageToken: string, A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token.
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 the AuthorizationService.ListAuthorizations method.
"authorizations": [ # All the customer's Authorizations.
{ # Discovery Engine Authorization resource.
"displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
"name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
"authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
"clientId": "A String", # Required. The OAuth2 client ID.
"clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
"pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
"scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
"A String",
],
"tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
},
},
],
"nextPageToken": "A String", # A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</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, updateMask=None, x__xgafv=None)</code>
<pre>Updates an Authorization
Args:
name: string, Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
body: object, The request body.
The object takes the form of:
{ # Discovery Engine Authorization resource.
"displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
"name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
"authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
"clientId": "A String", # Required. The OAuth2 client ID.
"clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
"pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
"scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
"A String",
],
"tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
},
}
updateMask: string, The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Discovery Engine Authorization resource.
"displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
"name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
"serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
"authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
"clientId": "A String", # Required. The OAuth2 client ID.
"clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
"pkceVerificationEnabled": True or False, # Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
"scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
"A String",
],
"tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
},
}</pre>
</div>
</body></html>
|
