| <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_v2.html">Connectors API</a> . <a href="connectors_v2.projects.html">projects</a> . <a href="connectors_v2.projects.locations.html">locations</a> . <a href="connectors_v2.projects.locations.connections.html">connections</a> . <a href="connectors_v2.projects.locations.connections.tools.html">tools</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="#execute">execute(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Executes a specific tool.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, executionConfig_headers=None, pageSize=None, pageToken=None, toolNames=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all available tools.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="execute">execute(name, body=None, x__xgafv=None)</code> |
| <pre>Executes a specific tool. |
| |
| Args: |
| name: string, Required. Resource name of the Tool. Format: projects/{project}/locations/{location}/connections/{connection}/tools/{tool} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for ConnectorAgentService.ExecuteTool |
| "executionConfig": { # execution config for the request. |
| "headers": "A String", # headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}' |
| }, |
| "parameters": { # Input parameters for the tool. |
| "a_key": "", # Properties of the object. |
| }, |
| "toolDefinition": { # Tool definition for the tool to be executed. |
| "a_key": "", # Properties of the object. |
| }, |
| } |
| |
| 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 ConnectorAgentService.ExecuteTool |
| "_meta": { # Metadata for the tool execution result. |
| "a_key": "", # Properties of the object. |
| }, |
| "metadata": { # Metadata like service latency, etc. |
| "a_key": { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }, |
| "result": { # Output from the tool execution. |
| "a_key": "", # Properties of the object. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, executionConfig_headers=None, pageSize=None, pageToken=None, toolNames=None, x__xgafv=None)</code> |
| <pre>Lists all available tools. |
| |
| Args: |
| parent: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required) |
| executionConfig_headers: string, headers to be used for the request. For example: headers:'{"x-integration-connectors-managed-connection-id":"conn-id","x-integration-connectors-runtime-config":"runtime-cfg"}' |
| pageSize: integer, Page size. |
| pageToken: string, Page token. |
| toolNames: string, List of tool names for selective tool fetching. (repeated) |
| 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 ConnectorAgentService.ListTools |
| "metadata": { # Metadata like service latency, etc. |
| "a_key": { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }, |
| "nextPageToken": "A String", # Next page token. |
| "tools": [ # List of available tools. |
| { # Message representing a single tool. |
| "_meta": { # Metadata for the tool. |
| "a_key": "", # Properties of the object. |
| }, |
| "annotations": { # ToolAnnotations holds annotations for a tool. # Annotations for the tool. |
| "destructiveHint": True or False, # If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. (This property is meaningful only when `read_only_hint == false`) |
| "idempotentHint": True or False, # If true, calling the tool repeatedly with the same arguments will have no additional effect on the environment. (This property is meaningful only when `read_only_hint == false`) |
| "openWorldHint": True or False, # If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. |
| "readOnlyHint": True or False, # If true, the tool does not modify its environment. |
| "title": "A String", # A human-readable title for the tool. |
| }, |
| "dependsOn": [ # List of tool names that this tool depends on. |
| "A String", |
| ], |
| "description": "A String", # Description of the tool. |
| "inputSchema": { # JsonSchema representation of schema metadata # JSON schema for the input parameters of the tool. |
| "$comment": "A String", # A comment on the schema. |
| "$defs": { # Definitions for the schema. |
| "a_key": # Object with schema name: JsonSchema |
| }, |
| "$id": "A String", # The URI defining the core schema meta-schema. |
| "$ref": "A String", # A reference to another schema. |
| "$schema": "A String", # The URI defining the schema. |
| "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema |
| "a_key": "", # Properties of the object. |
| }, |
| "additionalItems": # Object with schema name: JsonSchema # Schema for additional items. |
| "additionalProperties": # Object with schema name: JsonSchema # Schema for additional properties. |
| "allOf": [ # Schema that must be valid against all of the sub-schemas. |
| # Object with schema name: JsonSchema |
| ], |
| "anyOf": [ # Schema that must be valid against at least one of the sub-schemas. |
| # Object with schema name: JsonSchema |
| ], |
| "const": "", # Const value that the data must match. |
| "contains": # Object with schema name: JsonSchema # Schema that applies to at least one item in an array. |
| "contentEncoding": "A String", # Encoding of the content. |
| "contentMediaType": "A String", # Media type of the content. |
| "default": "", # The default value of the field or object described by this schema. |
| "definitions": { # Definitions for the schema. |
| "a_key": # Object with schema name: JsonSchema |
| }, |
| "dependencies": { # Dependencies for the schema. |
| "a_key": "", |
| }, |
| "description": "A String", # A description of this schema. |
| "else": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is invalid. |
| "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values |
| "", |
| ], |
| "examples": [ # Examples of the value. |
| "", |
| ], |
| "exclusiveMaximum": "", # Whether the maximum number value is exclusive. |
| "exclusiveMinimum": "", # Whether the minimum number value is exclusive. |
| "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format |
| "if": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is valid. |
| "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`. |
| "jdbcType": "A String", # JDBC datatype of the field. |
| "maxItems": 42, # Maximum number of items in the array field. |
| "maxLength": 42, # Maximum length of the string field. |
| "maxProperties": 42, # Maximum number of properties. |
| "maximum": "", # Maximum value of the number field. |
| "minItems": 42, # Minimum number of items in the array field. |
| "minLength": 42, # Minimum length of the string field. |
| "minProperties": 42, # Minimum number of properties. |
| "minimum": "", # Minimum value of the number field. |
| "multipleOf": 3.14, # Number must be a multiple of this value. |
| "not": # Object with schema name: JsonSchema # Schema that must not be valid. |
| "oneOf": [ # Schema that must be valid against at least one of the sub-schemas. |
| # Object with schema name: JsonSchema |
| ], |
| "pattern": "A String", # Regex pattern of the string field. This is a string value that describes the regular expression that the string value should match. |
| "patternProperties": { # Pattern properties for the schema. |
| "a_key": # Object with schema name: JsonSchema |
| }, |
| "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property |
| "a_key": # Object with schema name: JsonSchema |
| }, |
| "propertyNames": # Object with schema name: JsonSchema # Schema for property names. |
| "readOnly": True or False, # Whether the value is read-only. |
| "required": [ # Whether this property is required. |
| "A String", |
| ], |
| "then": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is valid. |
| "title": "A String", # A title of the schema. |
| "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON |
| "A String", |
| ], |
| "uniqueItems": True or False, # Whether the items in the array field are unique. |
| "writeOnly": True or False, # Whether the value is write-only. |
| }, |
| "name": "A String", # Name of the tool. |
| "outputSchema": { # JsonSchema representation of schema metadata # JSON schema for the output of the tool. |
| "$comment": "A String", # A comment on the schema. |
| "$defs": { # Definitions for the schema. |
| "a_key": # Object with schema name: JsonSchema |
| }, |
| "$id": "A String", # The URI defining the core schema meta-schema. |
| "$ref": "A String", # A reference to another schema. |
| "$schema": "A String", # The URI defining the schema. |
| "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema |
| "a_key": "", # Properties of the object. |
| }, |
| "additionalItems": # Object with schema name: JsonSchema # Schema for additional items. |
| "additionalProperties": # Object with schema name: JsonSchema # Schema for additional properties. |
| "allOf": [ # Schema that must be valid against all of the sub-schemas. |
| # Object with schema name: JsonSchema |
| ], |
| "anyOf": [ # Schema that must be valid against at least one of the sub-schemas. |
| # Object with schema name: JsonSchema |
| ], |
| "const": "", # Const value that the data must match. |
| "contains": # Object with schema name: JsonSchema # Schema that applies to at least one item in an array. |
| "contentEncoding": "A String", # Encoding of the content. |
| "contentMediaType": "A String", # Media type of the content. |
| "default": "", # The default value of the field or object described by this schema. |
| "definitions": { # Definitions for the schema. |
| "a_key": # Object with schema name: JsonSchema |
| }, |
| "dependencies": { # Dependencies for the schema. |
| "a_key": "", |
| }, |
| "description": "A String", # A description of this schema. |
| "else": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is invalid. |
| "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values |
| "", |
| ], |
| "examples": [ # Examples of the value. |
| "", |
| ], |
| "exclusiveMaximum": "", # Whether the maximum number value is exclusive. |
| "exclusiveMinimum": "", # Whether the minimum number value is exclusive. |
| "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format |
| "if": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is valid. |
| "items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`. |
| "jdbcType": "A String", # JDBC datatype of the field. |
| "maxItems": 42, # Maximum number of items in the array field. |
| "maxLength": 42, # Maximum length of the string field. |
| "maxProperties": 42, # Maximum number of properties. |
| "maximum": "", # Maximum value of the number field. |
| "minItems": 42, # Minimum number of items in the array field. |
| "minLength": 42, # Minimum length of the string field. |
| "minProperties": 42, # Minimum number of properties. |
| "minimum": "", # Minimum value of the number field. |
| "multipleOf": 3.14, # Number must be a multiple of this value. |
| "not": # Object with schema name: JsonSchema # Schema that must not be valid. |
| "oneOf": [ # Schema that must be valid against at least one of the sub-schemas. |
| # Object with schema name: JsonSchema |
| ], |
| "pattern": "A String", # Regex pattern of the string field. This is a string value that describes the regular expression that the string value should match. |
| "patternProperties": { # Pattern properties for the schema. |
| "a_key": # Object with schema name: JsonSchema |
| }, |
| "properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property |
| "a_key": # Object with schema name: JsonSchema |
| }, |
| "propertyNames": # Object with schema name: JsonSchema # Schema for property names. |
| "readOnly": True or False, # Whether the value is read-only. |
| "required": [ # Whether this property is required. |
| "A String", |
| ], |
| "then": # Object with schema name: JsonSchema # Schema that must be valid if the "if" schema is valid. |
| "title": "A String", # A title of the schema. |
| "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON |
| "A String", |
| ], |
| "uniqueItems": True or False, # Whether the items in the array field are unique. |
| "writeOnly": True or False, # Whether the value is write-only. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
