| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.global_.html">global_</a> . <a href="connectors_v1.projects.locations.global_.providers.html">providers</a> . <a href="connectors_v1.projects.locations.global_.providers.connectors.html">connectors</a> . <a href="connectors_v1.projects.locations.global_.providers.connectors.versions.html">versions</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single connector version.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists Connector Versions in a given project and location.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> |
| <pre>Gets details of a single connector version. |
| |
| Args: |
| name: string, Required. Resource name of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*` (required) |
| view: string, Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `CUSTOMER` view. |
| Allowed values |
| CONNECTOR_VERSION_VIEW_UNSPECIFIED - CONNECTOR_VERSION_VIEW_UNSPECIFIED. |
| CONNECTOR_VERSION_VIEW_BASIC - Do not include role grant configs. |
| CONNECTOR_VERSION_VIEW_FULL - Include role grant configs. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # ConnectorVersion indicates a specific version of a connector. |
| "authConfigTemplates": [ # Output only. List of auth configs supported by the Connector Version. |
| { # AuthConfigTemplate defines required field over an authentication type. |
| "authType": "A String", # The type of authentication configured. |
| "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. |
| { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. |
| "description": "A String", # Description. |
| "displayName": "A String", # Display name of the parameter. |
| "key": "A String", # Key of the config variable. |
| "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. |
| "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. |
| "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. |
| "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. |
| "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. |
| "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
| "type": "A String", # Different types of resource supported. |
| }, |
| "roles": [ # List of roles that need to be granted. |
| "A String", |
| ], |
| }, |
| "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. |
| "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. |
| }, |
| ], |
| }, |
| ], |
| "configVariableTemplates": [ # Output only. List of config variables needed to create a connection. |
| { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. |
| "description": "A String", # Description. |
| "displayName": "A String", # Display name of the parameter. |
| "key": "A String", # Key of the config variable. |
| "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. |
| "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. |
| "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. |
| "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. |
| "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. |
| "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
| "type": "A String", # Different types of resource supported. |
| }, |
| "roles": [ # List of roles that need to be granted. |
| "A String", |
| ], |
| }, |
| "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. |
| "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. |
| }, |
| ], |
| "createTime": "A String", # Output only. Created time. |
| "displayName": "A String", # Output only. Display name. |
| "egressControlConfig": { # Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource. # Output only. Configuration for Egress Control. |
| "backends": "A String", # Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name). |
| "extractionRules": { # Extraction Rules to identity the backends from customer provided configuration in Connection resource. # Extractions Rules to extract the backends from customer provided configuration. |
| "extractionRule": [ # Collection of Extraction Rule. |
| { # Extraction Rule. |
| "extractionRegex": "A String", # Regex used to extract backend details from source. If empty, whole source value will be used. |
| "source": { # Source to extract the backend from. # Source on which the rule is applied. |
| "fieldId": "A String", # Field identifier. For example config vaiable name. |
| "sourceType": "A String", # Type of the source. |
| }, |
| }, |
| ], |
| }, |
| }, |
| "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| "a_key": "A String", |
| }, |
| "launchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. |
| "name": "A String", # Output only. Resource name of the Version. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} |
| "releaseVersion": "A String", # Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha". |
| "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Output only. Role grant configuration for this config variable. It will be DEPRECATED soon. |
| "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. |
| "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. |
| "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. |
| "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
| "type": "A String", # Different types of resource supported. |
| }, |
| "roles": [ # List of roles that need to be granted. |
| "A String", |
| ], |
| }, |
| "roleGrants": [ # Output only. Role grant configurations for this connector version. |
| { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. |
| "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. |
| "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. |
| "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. |
| "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
| "type": "A String", # Different types of resource supported. |
| }, |
| "roles": [ # List of roles that need to be granted. |
| "A String", |
| ], |
| }, |
| ], |
| "supportedRuntimeFeatures": { # Supported runtime features of a connector version. This is passed to the management layer to add a new connector version by the connector developer. Details about how this proto is passed to the management layer is covered in this doc - go/runtime-manifest. # Output only. Information about the runtime features supported by the Connector. |
| "actionApis": True or False, # Specifies if the connector supports action apis like 'executeAction'. |
| "entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'. |
| "sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation. |
| }, |
| "updateTime": "A String", # Output only. Updated time. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> |
| <pre>Lists Connector Versions in a given project and location. |
| |
| Args: |
| parent: string, Required. Parent resource of the connectors, of the form: `projects/*/locations/*/providers/*/connectors/*` (required) |
| pageSize: integer, Page size. |
| pageToken: string, Page token. |
| view: string, Specifies which fields of the ConnectorVersion are returned in the response. Defaults to `CUSTOMER` view. |
| Allowed values |
| CONNECTOR_VERSION_VIEW_UNSPECIFIED - CONNECTOR_VERSION_VIEW_UNSPECIFIED. |
| CONNECTOR_VERSION_VIEW_BASIC - Do not include role grant configs. |
| CONNECTOR_VERSION_VIEW_FULL - Include role grant configs. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for Connectors.ListConnectorVersions. |
| "connectorVersions": [ # A list of connector versions. |
| { # ConnectorVersion indicates a specific version of a connector. |
| "authConfigTemplates": [ # Output only. List of auth configs supported by the Connector Version. |
| { # AuthConfigTemplate defines required field over an authentication type. |
| "authType": "A String", # The type of authentication configured. |
| "configVariableTemplates": [ # Config variables to describe an `AuthConfig` for a `Connection`. |
| { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. |
| "description": "A String", # Description. |
| "displayName": "A String", # Display name of the parameter. |
| "key": "A String", # Key of the config variable. |
| "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. |
| "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. |
| "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. |
| "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. |
| "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. |
| "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
| "type": "A String", # Different types of resource supported. |
| }, |
| "roles": [ # List of roles that need to be granted. |
| "A String", |
| ], |
| }, |
| "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. |
| "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. |
| }, |
| ], |
| }, |
| ], |
| "configVariableTemplates": [ # Output only. List of config variables needed to create a connection. |
| { # ConfigVariableTemplate provides metadata about a `ConfigVariable` that is used in a Connection. |
| "description": "A String", # Description. |
| "displayName": "A String", # Display name of the parameter. |
| "key": "A String", # Key of the config variable. |
| "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. |
| "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Role grant configuration for the config variable. |
| "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. |
| "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. |
| "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. |
| "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
| "type": "A String", # Different types of resource supported. |
| }, |
| "roles": [ # List of roles that need to be granted. |
| "A String", |
| ], |
| }, |
| "validationRegex": "A String", # Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable`. |
| "valueType": "A String", # Type of the parameter: string, int, bool etc. consider custom type for the benefit for the validation. |
| }, |
| ], |
| "createTime": "A String", # Output only. Created time. |
| "displayName": "A String", # Output only. Display name. |
| "egressControlConfig": { # Egress control config for connector runtime. These configurations define the rules to identify which outbound domains/hosts needs to be whitelisted. It may be a static information for a particular connector version or it is derived from the configurations provided by the customer in Connection resource. # Output only. Configuration for Egress Control. |
| "backends": "A String", # Static Comma separated backends which are common for all Connection resources. Supported formats for each backend are host:port or just host (host can be ip address or domain name). |
| "extractionRules": { # Extraction Rules to identity the backends from customer provided configuration in Connection resource. # Extractions Rules to extract the backends from customer provided configuration. |
| "extractionRule": [ # Collection of Extraction Rule. |
| { # Extraction Rule. |
| "extractionRegex": "A String", # Regex used to extract backend details from source. If empty, whole source value will be used. |
| "source": { # Source to extract the backend from. # Source on which the rule is applied. |
| "fieldId": "A String", # Field identifier. For example config vaiable name. |
| "sourceType": "A String", # Type of the source. |
| }, |
| }, |
| ], |
| }, |
| }, |
| "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
| "a_key": "A String", |
| }, |
| "launchStage": "A String", # Output only. Flag to mark the version indicating the launch stage. |
| "name": "A String", # Output only. Resource name of the Version. Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version} |
| "releaseVersion": "A String", # Output only. ReleaseVersion of the connector, for example: "1.0.1-alpha". |
| "roleGrant": { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. # Output only. Role grant configuration for this config variable. It will be DEPRECATED soon. |
| "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. |
| "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. |
| "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. |
| "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
| "type": "A String", # Different types of resource supported. |
| }, |
| "roles": [ # List of roles that need to be granted. |
| "A String", |
| ], |
| }, |
| "roleGrants": [ # Output only. Role grant configurations for this connector version. |
| { # This configuration defines all the Cloud IAM roles that needs to be granted to a particular GCP resource for the selected prinicpal like service account. These configurations will let UI display to customers what IAM roles need to be granted by them. Or these configurations can be used by the UI to render a 'grant' button to do the same on behalf of the user. |
| "helperTextTemplate": "A String", # Template that UI can use to provide helper text to customers. |
| "principal": "A String", # Prinicipal/Identity for whom the role need to assigned. |
| "resource": { # Resource definition # Resource on which the roles needs to be granted for the principal. |
| "pathTemplate": "A String", # Template to uniquely represent a GCP resource in a format IAM expects This is a template that can have references to other values provided in the config variable template. |
| "type": "A String", # Different types of resource supported. |
| }, |
| "roles": [ # List of roles that need to be granted. |
| "A String", |
| ], |
| }, |
| ], |
| "supportedRuntimeFeatures": { # Supported runtime features of a connector version. This is passed to the management layer to add a new connector version by the connector developer. Details about how this proto is passed to the management layer is covered in this doc - go/runtime-manifest. # Output only. Information about the runtime features supported by the Connector. |
| "actionApis": True or False, # Specifies if the connector supports action apis like 'executeAction'. |
| "entityApis": True or False, # Specifies if the connector supports entity apis like 'createEntity'. |
| "sqlQuery": True or False, # Specifies if the connector supports 'ExecuteSqlQuery' operation. |
| }, |
| "updateTime": "A String", # Output only. Updated time. |
| }, |
| ], |
| "nextPageToken": "A String", # Next page token. |
| "unreachable": [ # Locations that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</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> |
