diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html index 55fbb3ce13..2d1c7f6d41 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # CustomConnectorVersion indicates a specific version of a connector. - "authConfig": { # AuthConfig defines details of a authentication type. # Required. Configuration for establishing the authentication to the connector destination. + "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. "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. @@ -176,23 +176,78 @@

Method Details

"username": "A String", # Username. }, }, - "createTime": "A String", # Output only. Created time. - "destinationConfig": { # Define the Connectors target endpoint. # Required. Configuration of the customConnector's destination. - "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/* + "backendVariableTemplates": [ # Optional. Backend variables config templates. This translates to additional variable templates in 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 Google Cloud 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 Google Cloud 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. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal 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 Google Cloud 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", + ], }, - ], - "key": "A String", # The key is the destination identifier that is supported by the Connector. - }, - "enableBackendDestinationConfig": True or False, # Optional. Whether to enable backend destination config. This is the backend server that the connector connects to. + "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. + "destinationConfigs": [ # Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. + { # 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. + }, + ], + "enableBackendDestinationConfig": True or False, # Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation. "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", }, "name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version} - "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets. + "serviceAccount": "A String", # Required. Service account used by runtime plane to access auth config secrets. "specLocation": "A String", # Optional. Location of the custom connector spec. "updateTime": "A String", # Output only. Updated time. } @@ -277,7 +332,7 @@

Method Details

An object of the form: { # CustomConnectorVersion indicates a specific version of a connector. - "authConfig": { # AuthConfig defines details of a authentication type. # Required. Configuration for establishing the authentication to the connector destination. + "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. "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. @@ -342,23 +397,78 @@

Method Details

"username": "A String", # Username. }, }, - "createTime": "A String", # Output only. Created time. - "destinationConfig": { # Define the Connectors target endpoint. # Required. Configuration of the customConnector's destination. - "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/* + "backendVariableTemplates": [ # Optional. Backend variables config templates. This translates to additional variable templates in 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 Google Cloud 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 Google Cloud 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. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal 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 Google Cloud 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", + ], }, - ], - "key": "A String", # The key is the destination identifier that is supported by the Connector. - }, - "enableBackendDestinationConfig": True or False, # Optional. Whether to enable backend destination config. This is the backend server that the connector connects to. + "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. + "destinationConfigs": [ # Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. + { # 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. + }, + ], + "enableBackendDestinationConfig": True or False, # Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation. "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", }, "name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version} - "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets. + "serviceAccount": "A String", # Required. Service account used by runtime plane to access auth config secrets. "specLocation": "A String", # Optional. Location of the custom connector spec. "updateTime": "A String", # Output only. Updated time. } @@ -383,7 +493,7 @@

Method Details

{ # Response message for Connectors.ListCustomConnectorVersions. "customConnectorVersions": [ # A list of connector versions. { # CustomConnectorVersion indicates a specific version of a connector. - "authConfig": { # AuthConfig defines details of a authentication type. # Required. Configuration for establishing the authentication to the connector destination. + "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. "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. @@ -448,23 +558,78 @@

Method Details

"username": "A String", # Username. }, }, - "createTime": "A String", # Output only. Created time. - "destinationConfig": { # Define the Connectors target endpoint. # Required. Configuration of the customConnector's destination. - "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/* + "backendVariableTemplates": [ # Optional. Backend variables config templates. This translates to additional variable templates in 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 Google Cloud 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 Google Cloud 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. }, - ], - "key": "A String", # The key is the destination identifier that is supported by the Connector. - }, - "enableBackendDestinationConfig": True or False, # Optional. Whether to enable backend destination config. This is the backend server that the connector connects to. + "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. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal 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 Google Cloud 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. + "destinationConfigs": [ # Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. + { # 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. + }, + ], + "enableBackendDestinationConfig": True or False, # Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation. "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", }, "name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version} - "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets. + "serviceAccount": "A String", # Required. Service account used by runtime plane to access auth config secrets. "specLocation": "A String", # Optional. Location of the custom connector spec. "updateTime": "A String", # Output only. Updated time. }, @@ -500,7 +665,7 @@

Method Details

The object takes the form of: { # CustomConnectorVersion indicates a specific version of a connector. - "authConfig": { # AuthConfig defines details of a authentication type. # Required. Configuration for establishing the authentication to the connector destination. + "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. "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. @@ -565,23 +730,78 @@

Method Details

"username": "A String", # Username. }, }, - "createTime": "A String", # Output only. Created time. - "destinationConfig": { # Define the Connectors target endpoint. # Required. Configuration of the customConnector's destination. - "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/* + "backendVariableTemplates": [ # Optional. Backend variables config templates. This translates to additional variable templates in 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 Google Cloud 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 Google Cloud 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. + }, + ], + "isAdvanced": True or False, # Indicates if current template is part of advanced settings + "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. + "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. + "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. + "fieldComparisons": [ # A list of fields to be compared. + { # Field that needs to be compared. + "boolValue": True or False, # Boolean value + "comparator": "A String", # Comparator to use for comparing the field value. + "intValue": "A String", # Integer value + "key": "A String", # Key of the field. + "stringValue": "A String", # String value + }, + ], + "logicalExpressions": [ # A list of nested conditions to be compared. + # Object with schema name: LogicalExpression + ], + "logicalOperator": "A String", # The logical operator to use between the fields and conditions. + }, + "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular Google Cloud resource for the selected principal 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 Google Cloud 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", + ], }, - ], - "key": "A String", # The key is the destination identifier that is supported by the Connector. - }, - "enableBackendDestinationConfig": True or False, # Optional. Whether to enable backend destination config. This is the backend server that the connector connects to. + "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. + "destinationConfigs": [ # Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true. + { # 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. + }, + ], + "enableBackendDestinationConfig": True or False, # Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation. "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", }, "name": "A String", # Output only. Identifier. Resource name of the Version. Format: projects/{project}/locations/{location}/customConnectors/{custom_connector}/customConnectorVersions/{custom_connector_version} - "serviceAccount": "A String", # Required. Service account needed for runtime plane to access Custom Connector secrets. + "serviceAccount": "A String", # Required. Service account used by runtime plane to access auth config secrets. "specLocation": "A String", # Optional. Location of the custom connector spec. "updateTime": "A String", # Output only. Updated time. } diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html index a9069eefd5..2dbfe8ff0e 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -141,6 +141,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -197,6 +198,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -298,6 +300,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -354,6 +357,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -411,6 +415,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -469,6 +474,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -568,6 +574,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -614,6 +621,9 @@

Method Details

"entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'. "sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation. }, + "unsupportedConnectionTypes": [ # Output only. Unsupported connection types. + "A String", + ], "updateTime": "A String", # Output only. Updated time. } @@ -666,6 +676,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -722,6 +733,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -823,6 +835,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -879,6 +892,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -936,6 +950,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -994,6 +1009,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -1093,6 +1109,7 @@

Method Details

], "isAdvanced": True or False, # Indicates if current template is part of advanced settings "key": "A String", # Key of the config variable. + "locationType": "A String", # Optional. Location Tyep denotes where this value should be sent in BYOC connections. "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. "fieldComparisons": [ # A list of fields to be compared. @@ -1139,6 +1156,9 @@

Method Details

"entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'. "sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation. }, + "unsupportedConnectionTypes": [ # Output only. Unsupported connection types. + "A String", + ], "updateTime": "A String", # Output only. Updated time. }, ], diff --git a/docs/dyn/connectors_v2.projects.locations.connections.html b/docs/dyn/connectors_v2.projects.locations.connections.html index 05f532260f..108a7d7e08 100644 --- a/docs/dyn/connectors_v2.projects.locations.connections.html +++ b/docs/dyn/connectors_v2.projects.locations.connections.html @@ -84,18 +84,98 @@

Instance Methods

Returns the entityTypes Resource.

+

+ checkReadiness(name, x__xgafv=None)

+

Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.

+

+ checkStatus(name, x__xgafv=None)

+

Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.

close()

Close httplib2 connections.

+

+ exchangeAuthCode(name, body=None, x__xgafv=None)

+

ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).

executeSqlQuery(connection, body=None, x__xgafv=None)

Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.

+

+ refreshAccessToken(name, body=None, x__xgafv=None)

+

RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).

Method Details

+
+ checkReadiness(name, x__xgafv=None) +
Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.
+
+Args:
+  name: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response containing status of the connector for readiness prober.
+  "status": "A String",
+}
+
+ +
+ checkStatus(name, x__xgafv=None) +
Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not "OK", which indicates that ConnectionStatus itself, not the connection, failed.
+
+Args:
+  name: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The status of the connector.
+  "description": "A String", # When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state.
+  "state": "A String", # State of the connector.
+}
+
+
close()
Close httplib2 connections.
+
+ exchangeAuthCode(name, body=None, x__xgafv=None) +
ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).
+
+Args:
+  name: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ExchangeAuthCodeRequest currently includes no fields.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ExchangeAuthCodeResponse includes the returned access token and its associated credentials.
+  "accessCredentials": { # AccessCredentials includes the OAuth access token, and the other fields returned along with it.
+    "accessToken": "A String", # OAuth access token.
+    "expiresIn": "A String", # Duration till the access token expires.
+    "refreshToken": "A String", # OAuth refresh token.
+  },
+}
+
+
executeSqlQuery(connection, body=None, x__xgafv=None)
Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.
@@ -136,4 +216,33 @@ 

Method Details

}
+
+ refreshAccessToken(name, body=None, x__xgafv=None) +
RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).
+
+Args:
+  name: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RefreshAccessTokenRequest currently includes no fields.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # RefreshAccessTokenResponse includes the returned access token and its associated credentials.
+  "accessCredentials": { # AccessCredentials includes the OAuth access token, and the other fields returned along with it.
+    "accessToken": "A String", # OAuth access token.
+    "expiresIn": "A String", # Duration till the access token expires.
+    "refreshToken": "A String", # OAuth refresh token.
+  },
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 843e001398..ed67dc5e8e 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2349,7 +2349,7 @@ } } }, - "revision": "20231126", + "revision": "20231205", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2625,6 +2625,22 @@ "description": "Key of the config variable.", "type": "string" }, + "locationType": { + "description": "Optional. Location Tyep denotes where this value should be sent in BYOC connections.", + "enum": [ + "LOCATION_TYPE_UNSPECIFIED", + "HEADER", + "PAYLOAD", + "QUERY_PARAM" + ], + "enumDescriptions": [ + "Location type unspecified.", + "Request header.", + "Request Payload.", + "Request query param." + ], + "type": "string" + }, "required": { "description": "Flag represents that this `ConfigVariable` must be provided for a connection.", "type": "boolean" @@ -3211,6 +3227,26 @@ "description": "Output only. Information about the runtime features supported by the Connector.", "readOnly": true }, + "unsupportedConnectionTypes": { + "description": "Output only. Unsupported connection types.", + "items": { + "enum": [ + "CONNECTION_TYPE_UNSPECIFIED", + "CONNECTION_WITH_EVENTING", + "ONLY_CONNECTION", + "ONLY_EVENTING" + ], + "enumDescriptions": [ + "Connection type is unspecified.", + "Connection with eventing.", + "Only connection.", + "Only eventing." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", @@ -3338,7 +3374,14 @@ "properties": { "authConfig": { "$ref": "AuthConfig", - "description": "Required. Configuration for establishing the authentication to the connector destination." + "description": "Optional. Authentication config for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true." + }, + "backendVariableTemplates": { + "description": "Optional. Backend variables config templates. This translates to additional variable templates in connection.", + "items": { + "$ref": "ConfigVariableTemplate" + }, + "type": "array" }, "createTime": { "description": "Output only. Created time.", @@ -3346,12 +3389,15 @@ "readOnly": true, "type": "string" }, - "destinationConfig": { - "$ref": "DestinationConfig", - "description": "Required. Configuration of the customConnector's destination." + "destinationConfigs": { + "description": "Optional. Destination config(s) for accessing connector facade/ proxy. This is used only when enable_backend_destination_config is true.", + "items": { + "$ref": "DestinationConfig" + }, + "type": "array" }, "enableBackendDestinationConfig": { - "description": "Optional. Whether to enable backend destination config. This is the backend server that the connector connects to.", + "description": "Optional. When enabled, the connector will be a facade/ proxy, and connects to the destination provided during connection creation.", "type": "boolean" }, "labels": { @@ -3367,7 +3413,7 @@ "type": "string" }, "serviceAccount": { - "description": "Required. Service account needed for runtime plane to access Custom Connector secrets.", + "description": "Required. Service account used by runtime plane to access auth config secrets.", "type": "string" }, "specLocation": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 1f23a4407c..7d9474063c 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -111,6 +111,81 @@ "resources": { "connections": { "methods": { + "checkReadiness": { + "description": "Reports readiness status of the connector. Similar logic to GetStatus but modified for kubernetes health check to understand.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkReadiness", + "httpMethod": "GET", + "id": "connectors.projects.locations.connections.checkReadiness", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:checkReadiness", + "response": { + "$ref": "CheckReadinessResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "checkStatus": { + "description": "Reports the status of the connection. Note that when the connection is in a state that is not ACTIVE, the implementation of this RPC method must return a Status with the corresponding State instead of returning a gRPC status code that is not \"OK\", which indicates that ConnectionStatus itself, not the connection, failed.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:checkStatus", + "httpMethod": "GET", + "id": "connectors.projects.locations.connections.checkStatus", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:checkStatus", + "response": { + "$ref": "CheckStatusResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "exchangeAuthCode": { + "description": "ExchangeAuthCode exchanges the OAuth authorization code (and other necessary data) for an access token (and associated credentials).", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:exchangeAuthCode", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.exchangeAuthCode", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:exchangeAuthCode", + "request": { + "$ref": "ExchangeAuthCodeRequest" + }, + "response": { + "$ref": "ExchangeAuthCodeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "executeSqlQuery": { "description": "Executes a SQL statement specified in the body of the request. An example of this SQL statement in the case of Salesforce connector would be 'select * from Account a, Order o where a.Id = o.AccountId'.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:executeSqlQuery", @@ -138,6 +213,33 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "refreshAccessToken": { + "description": "RefreshAccessToken exchanges the OAuth refresh token (and other necessary data) for a new access token (and new associated credentials).", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}:refreshAccessToken", + "httpMethod": "POST", + "id": "connectors.projects.locations.connections.refreshAccessToken", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:refreshAccessToken", + "request": { + "$ref": "RefreshAccessTokenRequest" + }, + "response": { + "$ref": "RefreshAccessTokenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -558,9 +660,29 @@ } } }, - "revision": "20231126", + "revision": "20231205", "rootUrl": "https://connectors.googleapis.com/", "schemas": { + "AccessCredentials": { + "description": "AccessCredentials includes the OAuth access token, and the other fields returned along with it.", + "id": "AccessCredentials", + "properties": { + "accessToken": { + "description": "OAuth access token.", + "type": "string" + }, + "expiresIn": { + "description": "Duration till the access token expires.", + "format": "google-duration", + "type": "string" + }, + "refreshToken": { + "description": "OAuth refresh token.", + "type": "string" + } + }, + "type": "object" + }, "Action": { "description": "Action message contains metadata information about a single action present in the external system.", "id": "Action", @@ -602,6 +724,43 @@ }, "type": "object" }, + "CheckReadinessResponse": { + "description": "Response containing status of the connector for readiness prober.", + "id": "CheckReadinessResponse", + "properties": { + "status": { + "type": "string" + } + }, + "type": "object" + }, + "CheckStatusResponse": { + "description": "The status of the connector.", + "id": "CheckStatusResponse", + "properties": { + "description": { + "description": "When the connector is not in ACTIVE state, the description must be populated to specify the reason why it's not in ACTIVE state.", + "type": "string" + }, + "state": { + "description": "State of the connector.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "ERROR", + "AUTH_ERROR" + ], + "enumDescriptions": [ + "State unspecified.", + "The connector is active and ready to process runtime requests. This can also mean that from the connector's perspective, the connector is not in an error state and should be able to process runtime requests successfully.", + "The connector is in an error state and cannot process runtime requests. An example reason would be that the connection container has some network issues that prevent outbound requests from being sent.", + "This is a more specific error state that the developers can opt to use when the connector is facing auth-related errors caused by auth configuration not present, invalid auth credentials, etc." + ], + "type": "string" + } + }, + "type": "object" + }, "Empty": { "description": "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); }", "id": "Empty", @@ -649,6 +808,22 @@ }, "type": "object" }, + "ExchangeAuthCodeRequest": { + "description": "ExchangeAuthCodeRequest currently includes no fields.", + "id": "ExchangeAuthCodeRequest", + "properties": {}, + "type": "object" + }, + "ExchangeAuthCodeResponse": { + "description": "ExchangeAuthCodeResponse includes the returned access token and its associated credentials.", + "id": "ExchangeAuthCodeResponse", + "properties": { + "accessCredentials": { + "$ref": "AccessCredentials" + } + }, + "type": "object" + }, "ExecuteActionRequest": { "description": "Request message for ActionService.ExecuteAction", "id": "ExecuteActionRequest", @@ -1547,6 +1722,22 @@ }, "type": "object" }, + "RefreshAccessTokenRequest": { + "description": "RefreshAccessTokenRequest currently includes no fields.", + "id": "RefreshAccessTokenRequest", + "properties": {}, + "type": "object" + }, + "RefreshAccessTokenResponse": { + "description": "RefreshAccessTokenResponse includes the returned access token and its associated credentials.", + "id": "RefreshAccessTokenResponse", + "properties": { + "accessCredentials": { + "$ref": "AccessCredentials" + } + }, + "type": "object" + }, "ResultMetadata": { "description": "Result Metadata message contains metadata about the result returned after executing an Action.", "id": "ResultMetadata",