Skip to content

Commit de160dd

Browse files
feat(connectors): update the api
#### connectors:v1 The following keys were added: - schemas.AuthConfig.properties.oauth2AuthCodeFlow.$ref (Total Keys: 1) - schemas.Connection.properties.logConfig.$ref (Total Keys: 1) - schemas.ConnectorVersion.properties.destinationConfigTemplates (Total Keys: 3) - schemas.ConnectorsLogConfig (Total Keys: 3) - schemas.DestinationConfigTemplate (Total Keys: 13) - schemas.Oauth2AuthCodeFlow (Total Keys: 10)
1 parent 63c723e commit de160dd

File tree

4 files changed

+215
-2
lines changed

4 files changed

+215
-2
lines changed

docs/dyn/connectors_v1.projects.locations.connections.html

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,19 @@ <h3>Method Details</h3>
151151
},
152152
],
153153
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
154+
&quot;oauth2AuthCodeFlow&quot;: { # 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.
155+
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
156+
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
157+
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
158+
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
159+
},
160+
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
161+
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
162+
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
163+
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
164+
&quot;A String&quot;,
165+
],
166+
},
154167
&quot;oauth2ClientCredentials&quot;: { # 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.
155168
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
156169
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
@@ -219,6 +232,9 @@ <h3>Method Details</h3>
219232
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
220233
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
221234
},
235+
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
236+
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
237+
},
222238
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
223239
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
224240
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.
@@ -363,6 +379,19 @@ <h3>Method Details</h3>
363379
},
364380
],
365381
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
382+
&quot;oauth2AuthCodeFlow&quot;: { # 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.
383+
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
384+
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
385+
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
386+
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
387+
},
388+
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
389+
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
390+
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
391+
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
392+
&quot;A String&quot;,
393+
],
394+
},
366395
&quot;oauth2ClientCredentials&quot;: { # 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.
367396
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
368397
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
@@ -431,6 +460,9 @@ <h3>Method Details</h3>
431460
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
432461
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
433462
},
463+
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
464+
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
465+
},
434466
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
435467
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
436468
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.
@@ -593,6 +625,19 @@ <h3>Method Details</h3>
593625
},
594626
],
595627
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
628+
&quot;oauth2AuthCodeFlow&quot;: { # 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.
629+
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
630+
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
631+
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
632+
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
633+
},
634+
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
635+
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
636+
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
637+
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
638+
&quot;A String&quot;,
639+
],
640+
},
596641
&quot;oauth2ClientCredentials&quot;: { # 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.
597642
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
598643
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
@@ -661,6 +706,9 @@ <h3>Method Details</h3>
661706
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
662707
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
663708
},
709+
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
710+
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
711+
},
664712
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
665713
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
666714
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.
@@ -751,6 +799,19 @@ <h3>Method Details</h3>
751799
},
752800
],
753801
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
802+
&quot;oauth2AuthCodeFlow&quot;: { # 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.
803+
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
804+
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
805+
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
806+
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
807+
},
808+
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
809+
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
810+
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
811+
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
812+
&quot;A String&quot;,
813+
],
814+
},
754815
&quot;oauth2ClientCredentials&quot;: { # 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.
755816
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
756817
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
@@ -819,6 +880,9 @@ <h3>Method Details</h3>
819880
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
820881
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
821882
},
883+
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
884+
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
885+
},
822886
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
823887
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
824888
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.

docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,19 @@ <h3>Method Details</h3>
194194
},
195195
],
196196
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
197+
&quot;destinationConfigTemplates&quot;: [ # Output only. List of destination configs needed to create a connection.
198+
{ # DestinationConfigTemplate defines required destinations supported by the Connector.
199+
&quot;defaultPort&quot;: 42, # The default port.
200+
&quot;description&quot;: &quot;A String&quot;, # Description.
201+
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the parameter.
202+
&quot;isAdvanced&quot;: True or False, # Whether the current destination tempalate is part of Advanced settings
203+
&quot;key&quot;: &quot;A String&quot;, # Key of the destination.
204+
&quot;max&quot;: 42, # The maximum number of destinations supported for this key.
205+
&quot;min&quot;: 42, # The minimum number of destinations supported for this key.
206+
&quot;portFieldType&quot;: &quot;A String&quot;, # Whether port number should be provided by customers.
207+
&quot;regexPattern&quot;: &quot;A String&quot;, # Regex pattern for host.
208+
},
209+
],
197210
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name.
198211
&quot;egressControlConfig&quot;: { # 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.
199212
&quot;backends&quot;: &quot;A String&quot;, # 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).
@@ -401,6 +414,19 @@ <h3>Method Details</h3>
401414
},
402415
],
403416
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
417+
&quot;destinationConfigTemplates&quot;: [ # Output only. List of destination configs needed to create a connection.
418+
{ # DestinationConfigTemplate defines required destinations supported by the Connector.
419+
&quot;defaultPort&quot;: 42, # The default port.
420+
&quot;description&quot;: &quot;A String&quot;, # Description.
421+
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the parameter.
422+
&quot;isAdvanced&quot;: True or False, # Whether the current destination tempalate is part of Advanced settings
423+
&quot;key&quot;: &quot;A String&quot;, # Key of the destination.
424+
&quot;max&quot;: 42, # The maximum number of destinations supported for this key.
425+
&quot;min&quot;: 42, # The minimum number of destinations supported for this key.
426+
&quot;portFieldType&quot;: &quot;A String&quot;, # Whether port number should be provided by customers.
427+
&quot;regexPattern&quot;: &quot;A String&quot;, # Regex pattern for host.
428+
},
429+
],
404430
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name.
405431
&quot;egressControlConfig&quot;: { # 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.
406432
&quot;backends&quot;: &quot;A String&quot;, # 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).

0 commit comments

Comments
 (0)