Skip to content

Commit

Permalink
feat(connectors): update the api
Browse files Browse the repository at this point in the history
#### 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)
  • Loading branch information
yoshi-automation committed Apr 11, 2023
1 parent 63c723e commit de160dd
Show file tree
Hide file tree
Showing 4 changed files with 215 additions and 2 deletions.
64 changes: 64 additions & 0 deletions docs/dyn/connectors_v1.projects.locations.connections.html
Expand Up @@ -151,6 +151,19 @@ <h3>Method Details</h3>
},
],
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
&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.
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
&quot;A String&quot;,
],
},
&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.
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
Expand Down Expand Up @@ -219,6 +232,9 @@ <h3>Method Details</h3>
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
},
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.
Expand Down Expand Up @@ -363,6 +379,19 @@ <h3>Method Details</h3>
},
],
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
&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.
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
&quot;A String&quot;,
],
},
&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.
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
Expand Down Expand Up @@ -431,6 +460,9 @@ <h3>Method Details</h3>
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
},
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.
Expand Down Expand Up @@ -593,6 +625,19 @@ <h3>Method Details</h3>
},
],
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
&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.
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
&quot;A String&quot;,
],
},
&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.
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
Expand Down Expand Up @@ -661,6 +706,9 @@ <h3>Method Details</h3>
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
},
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.
Expand Down Expand Up @@ -751,6 +799,19 @@ <h3>Method Details</h3>
},
],
&quot;authType&quot;: &quot;A String&quot;, # The type of authentication configured.
&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.
&quot;authCode&quot;: &quot;A String&quot;, # Authorization code to be exchanged for access and refresh tokens.
&quot;clientId&quot;: &quot;A String&quot;, # Client ID for user-provided OAuth app.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Client secret for user-provided OAuth app.
&quot;secretVersion&quot;: &quot;A String&quot;, # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
&quot;enablePkce&quot;: True or False, # Whether to enable PKCE when the user performs the auth code flow.
&quot;pkceVerifier&quot;: &quot;A String&quot;, # PKCE verifier to be used during the auth code exchange.
&quot;redirectUri&quot;: &quot;A String&quot;, # Redirect URI to be provided during the auth code exchange.
&quot;scopes&quot;: [ # Scopes the connection will request when the user performs the auth code flow.
&quot;A String&quot;,
],
},
&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.
&quot;clientId&quot;: &quot;A String&quot;, # The client identifier.
&quot;clientSecret&quot;: { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
Expand Down Expand Up @@ -819,6 +880,9 @@ <h3>Method Details</h3>
&quot;locked&quot;: True or False, # Indicates whether or not the connection is locked.
&quot;reason&quot;: &quot;A String&quot;, # Describes why a connection is locked.
},
&quot;logConfig&quot;: { # Log configuration for the connection. # Optional. Log configuration for the connection.
&quot;enabled&quot;: True or False, # Enabled represents whether logging is enabled or not for a connection.
},
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
&quot;nodeConfig&quot;: { # Node configuration for the connection. # Optional. Node configuration for the connection.
&quot;maxNodeCount&quot;: 42, # Maximum number of nodes in the runtime nodes.
Expand Down
Expand Up @@ -194,6 +194,19 @@ <h3>Method Details</h3>
},
],
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
&quot;destinationConfigTemplates&quot;: [ # Output only. List of destination configs needed to create a connection.
{ # DestinationConfigTemplate defines required destinations supported by the Connector.
&quot;defaultPort&quot;: 42, # The default port.
&quot;description&quot;: &quot;A String&quot;, # Description.
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the parameter.
&quot;isAdvanced&quot;: True or False, # Whether the current destination tempalate is part of Advanced settings
&quot;key&quot;: &quot;A String&quot;, # Key of the destination.
&quot;max&quot;: 42, # The maximum number of destinations supported for this key.
&quot;min&quot;: 42, # The minimum number of destinations supported for this key.
&quot;portFieldType&quot;: &quot;A String&quot;, # Whether port number should be provided by customers.
&quot;regexPattern&quot;: &quot;A String&quot;, # Regex pattern for host.
},
],
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name.
&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.
&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).
Expand Down Expand Up @@ -401,6 +414,19 @@ <h3>Method Details</h3>
},
],
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Created time.
&quot;destinationConfigTemplates&quot;: [ # Output only. List of destination configs needed to create a connection.
{ # DestinationConfigTemplate defines required destinations supported by the Connector.
&quot;defaultPort&quot;: 42, # The default port.
&quot;description&quot;: &quot;A String&quot;, # Description.
&quot;displayName&quot;: &quot;A String&quot;, # Display name of the parameter.
&quot;isAdvanced&quot;: True or False, # Whether the current destination tempalate is part of Advanced settings
&quot;key&quot;: &quot;A String&quot;, # Key of the destination.
&quot;max&quot;: 42, # The maximum number of destinations supported for this key.
&quot;min&quot;: 42, # The minimum number of destinations supported for this key.
&quot;portFieldType&quot;: &quot;A String&quot;, # Whether port number should be provided by customers.
&quot;regexPattern&quot;: &quot;A String&quot;, # Regex pattern for host.
},
],
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Display name.
&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.
&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).
Expand Down

0 comments on commit de160dd

Please sign in to comment.