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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
|
<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="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.global_.html">global_</a> . <a href="connectors_v1.projects.locations.global_.providers.html">providers</a> . <a href="connectors_v1.projects.locations.global_.providers.connectors.html">connectors</a> . <a href="connectors_v1.projects.locations.global_.providers.connectors.versions.html">versions</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="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single connector version.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Connector Versions in a given project 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>
<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="get">get(name, view=None, x__xgafv=None)</code>
<pre>Gets details of a single connector version.
Args:
name: string, Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` (required)
view: string, Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `CUSTOMER` view.
Allowed values
CONNECTOR_VERSION_VIEW_UNSPECIFIED - CONNECTOR_VERSION_VIEW_UNSPECIFIED.
CONNECTOR_VERSION_VIEW_BASIC - Do not include role grant configs.
CONNECTOR_VERSION_VIEW_FULL - Include role grant configs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ConnectorVersion indicates a specific version of a connector.
"authConfigTemplates": [ # Output only. List of auth configs supported by the Connector Version.
{ # AuthConfigTemplate defines required field over an authentication type.
"authType": "A String", # The type of authentication configured.
"configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"key": "A String", # Key of the config variable.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
},
],
"configVariableTemplates": [ # Output only. List of config variables needed to create a connection.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"key": "A String", # Key of the config variable.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"createTime": "A String", # Output only. Created time.
"displayName": "A String", # Output only. Display name.
"egressControlConfig": { # Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource. # Output only. Configuration for Egress Control.
"backends": "A String", # Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name).
"extractionRules": { # Extraction Rules to identity the backends from customer provided configuration in Connection resource. # Extractions Rules to extract the backends from customer provided configuration.
"extractionRule": [ # Collection of Extraction Rule.
{ # Extraction Rule.
"extractionRegex": "A String", # Regex used to extract backend details from source. If empty, whole source value will be used.
"source": { # Source to extract the backend from. # Source on which the rule is applied.
"fieldId": "A String", # Field identifier. For example config vaiable name.
"sourceType": "A String", # Type of the source.
},
},
],
},
},
"labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"launchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"name": "A String", # Output only. Resource name of the Version. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}
"releaseVersion": "A String", # Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha".
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Output only. Role grant configuration for this config variable. It will be DEPRECATED soon.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"roleGrants": [ # Output only. Role grant configurations for this connector version.
{ # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
],
"supportedRuntimeFeatures": { # Supported runtime features of a connector version. This is passed to the management layer to add a new connector version by the connector developer. Details about how this proto is passed to the management layer is covered in this doc - go/runtime-manifest. # Output only. Information about the runtime features supported by the Connector.
"actionApis": True or False, # Specifies if the connector supports action apis like 'executeAction'.
"entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'.
"sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation.
},
"updateTime": "A String", # Output only. Updated time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists Connector Versions in a given project and location.
Args:
parent: string, Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*` (required)
pageSize: integer, Page size.
pageToken: string, Page token.
view: string, Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `CUSTOMER` view.
Allowed values
CONNECTOR_VERSION_VIEW_UNSPECIFIED - CONNECTOR_VERSION_VIEW_UNSPECIFIED.
CONNECTOR_VERSION_VIEW_BASIC - Do not include role grant configs.
CONNECTOR_VERSION_VIEW_FULL - Include role grant configs.
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 Connectors.ListConnectorVersions.
"connectorVersions": [ # A list of connector versions.
{ # ConnectorVersion indicates a specific version of a connector.
"authConfigTemplates": [ # Output only. List of auth configs supported by the Connector Version.
{ # AuthConfigTemplate defines required field over an authentication type.
"authType": "A String", # The type of authentication configured.
"configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"key": "A String", # Key of the config variable.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
},
],
"configVariableTemplates": [ # Output only. List of config variables needed to create a connection.
{ # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection.
"authorizationCodeLink": { # This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. # Authorization code link options. To be populated if `ValueType` is `AUTHORIZATION_CODE`
"clientId": "A String", # The client ID assigned to the GCP Connectors OAuth app for the connector data source.
"enablePkce": True or False, # Whether to enable PKCE for the auth code flow.
"scopes": [ # The scopes for which the user will authorize GCP Connectors on the connector data source.
"A String",
],
"uri": "A String", # The base URI the user must click to trigger the authorization code login flow.
},
"description": "A String", # Description.
"displayName": "A String", # Display name of the parameter.
"enumOptions": [ # Enum options. To be populated if `ValueType` is `ENUM`
{ # EnumOption definition
"displayName": "A String", # Display name of the option.
"id": "A String", # Id of the option.
},
],
"key": "A String", # Key of the config variable.
"required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection.
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"state": "A String", # State of the config variable.
"validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`.
"valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation.
},
],
"createTime": "A String", # Output only. Created time.
"displayName": "A String", # Output only. Display name.
"egressControlConfig": { # Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource. # Output only. Configuration for Egress Control.
"backends": "A String", # Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name).
"extractionRules": { # Extraction Rules to identity the backends from customer provided configuration in Connection resource. # Extractions Rules to extract the backends from customer provided configuration.
"extractionRule": [ # Collection of Extraction Rule.
{ # Extraction Rule.
"extractionRegex": "A String", # Regex used to extract backend details from source. If empty, whole source value will be used.
"source": { # Source to extract the backend from. # Source on which the rule is applied.
"fieldId": "A String", # Field identifier. For example config vaiable name.
"sourceType": "A String", # Type of the source.
},
},
],
},
},
"labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
"a_key": "A String",
},
"launchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"name": "A String", # Output only. Resource name of the Version. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}
"releaseVersion": "A String", # Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha".
"roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Output only. Role grant configuration for this config variable. It will be DEPRECATED soon.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
"roleGrants": [ # Output only. Role grant configurations for this connector version.
{ # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user.
"helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers.
"principal": "A String", # Prinicipal/Identity for whom the role need to assigned.
"resource": { # Resource definition # Resource on which the roles needs to be granted for the principal.
"pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template.
"type": "A String", # Different types of resource supported.
},
"roles": [ # List of roles that need to be granted.
"A String",
],
},
],
"supportedRuntimeFeatures": { # Supported runtime features of a connector version. This is passed to the management layer to add a new connector version by the connector developer. Details about how this proto is passed to the management layer is covered in this doc - go/runtime-manifest. # Output only. Information about the runtime features supported by the Connector.
"actionApis": True or False, # Specifies if the connector supports action apis like 'executeAction'.
"entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'.
"sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation.
},
"updateTime": "A String", # Output only. Updated time.
},
],
"nextPageToken": "A String", # Next page token.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</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>
</body></html>
|
