/
integrations_v1alpha.projects.locations.connections.html
328 lines (299 loc) 路 19.4 KB
/
integrations_v1alpha.projects.locations.connections.html
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
<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="integrations_v1alpha.html">Application Integration API</a> . <a href="integrations_v1alpha.projects.html">projects</a> . <a href="integrations_v1alpha.projects.locations.html">locations</a> . <a href="integrations_v1alpha.projects.locations.connections.html">connections</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="integrations_v1alpha.projects.locations.connections.runtimeActionSchemas.html">runtimeActionSchemas()</a></code>
</p>
<p class="firstline">Returns the runtimeActionSchemas Resource.</p>
<p class="toc_element">
<code><a href="integrations_v1alpha.projects.locations.connections.runtimeEntitySchemas.html">runtimeEntitySchemas()</a></code>
</p>
<p class="firstline">Returns the runtimeEntitySchemas Resource.</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="#getConnectionSchemaMetadata">getConnectionSchemaMetadata(name, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the available entities and actions associated with a Connection.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Connections 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="getConnectionSchemaMetadata">getConnectionSchemaMetadata(name, x__xgafv=None)</code>
<pre>Lists the available entities and actions associated with a Connection.
Args:
name: string, Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Metadata of runtime connection schema.
"actions": [ # List of actions.
"A String",
],
"entities": [ # List of entity names.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Connections in a given project and location.
Args:
parent: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*` (required)
filter: string, Filter.
orderBy: string, Order by parameters.
pageSize: integer, Page size.
pageToken: string, 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 containing Connections listed by region.
"connections": [ # Connections.
{ # Connection represents an instance of connector.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"intValue": "A String", # Value is an integer
"key": "A String", # Key of the config variable.
"keyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"authKey": "A String", # Identifier key for auth config
"authType": "A String", # The type of authentication configured.
"oauth2AuthCodeFlow": { # Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details. # Oauth2AuthCodeFlow.
"authCode": "A String", # Authorization code to be exchanged for access and refresh tokens.
"authUri": "A String", # Auth URL for Authorization Code Flow
"clientId": "A String", # Client ID for user-provided OAuth app.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"enablePkce": True or False, # Whether to enable PKCE when the user performs the auth code flow.
"pkceVerifier": "A String", # PKCE verifier to be used during the auth code exchange.
"redirectUri": "A String", # Redirect URI to be provided during the auth code exchange.
"scopes": [ # Scopes the connection will request when the user performs the auth code flow.
"A String",
],
},
"oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials.
"clientId": "A String", # The client identifier.
"clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
},
"oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer.
"clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token.
"audience": "A String", # Value for the "aud" claim.
"issuer": "A String", # Value for the "iss" claim.
"subject": "A String", # Value for the "sub" claim.
},
},
"sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
"certType": "A String", # Format of SSH Client cert.
"sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # The user account used to authenticate.
},
"userPassword": { # Parameters to support Username and Password Authentication. # UserPassword.
"password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"username": "A String", # Username.
},
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"intValue": "A String", # Value is an integer
"key": "A String", # Key of the config variable.
"keyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
"connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
"connectorVersionLaunchStage": "A String", # Output only. Flag to mark the version indicating the launch stage.
"createTime": "A String", # Output only. Created time.
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # Define the Connectors target endpoint.
"destinations": [ # The destinations for the key.
{
"host": "A String", # For publicly routable host.
"port": 42, # The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
"key": "A String", # The key is the destination identifier that is supported by the Connector.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"labels": { # Optional. 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",
},
"lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
"locked": True or False, # Indicates whether or not the connection is locked.
"reason": "A String", # Describes why a connection is locked.
},
"logConfig": { # Log configuration for the connection. # Optional. Log configuration for the connection.
"enabled": True or False, # Enabled represents whether logging is enabled or not for a connection.
},
"name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
"nodeConfig": { # Node configuration for the connection. # Optional. Node configuration for the connection.
"maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
"minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
},
"serviceAccount": "A String", # Optional. Service account needed for runtime plane to access GCP resources.
"serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Additional SSL related field values
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
"boolValue": True or False, # Value is a bool.
"intValue": "A String", # Value is an integer
"key": "A String", # Key of the config variable.
"keyValue": { # Encryption Key value. # Value is a Encryption Key.
"kmsKeyName": "A String", # The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
"type": "A String", # Type.
},
"secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"stringValue": "A String", # Value is a string.
},
],
"clientCertType": "A String", # Type of Client Cert (PEM/JKS/.. etc.)
"clientCertificate": { # Secret provides a reference to entries in Secret Manager. # Client Certificate
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKey": { # Secret provides a reference to entries in Secret Manager. # Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"clientPrivateKeyPass": { # Secret provides a reference to entries in Secret Manager. # Secret containing the passphrase protecting the Client Private Key
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"privateServerCertificate": { # Secret provides a reference to entries in Secret Manager. # Private Server Certificate. Needs to be specified if trust model is `PRIVATE`.
"secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
"serverCertType": "A String", # Type of Server Cert (PEM/JKS/.. etc.)
"trustModel": "A String", # Trust Model of the SSL connection
"type": "A String", # Controls the ssl type for the given connector version.
"useSsl": True or False, # Bool for enabling SSL
},
"status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
"description": "A String", # Description.
"state": "A String", # State.
"status": "A String", # Status provides detailed information for the state.
},
"subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project.
"suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
"updateTime": "A String", # Output only. Updated time.
},
],
"nextPageToken": "A String", # Next page token.
}</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>