Connectors API . projects . locations . connections . tools

close()

Close httplib2 connections.

execute(name, body=None, x__xgafv=None)

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
  "parameters": { # Input parameters for the tool.
    "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
  "result": { # Output from the tool execution.
    "a_key": "", # Properties of the object.
  },
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists all available tools.

Args:
  parent: string, Required. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} (required)
  pageSize: integer, Page size.
  pageToken: string, Page token.
  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
  "nextPageToken": "A String", # Next page token.
  "tools": [ # List of available tools.
    { # Message representing a single tool.
      "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.
        "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
          "a_key": "", # Properties of the object.
        },
        "default": "", # The default value of the field or object described by this schema.
        "description": "A String", # A description of this schema.
        "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
          "",
        ],
        "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
        "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.
        "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
        },
        "required": [ # Whether this property is required.
          "A String",
        ],
        "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
          "A String",
        ],
      },
      "name": "A String", # Name of the tool.
      "outputSchema": { # JsonSchema representation of schema metadata # JSON schema for the output of the tool.
        "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
          "a_key": "", # Properties of the object.
        },
        "default": "", # The default value of the field or object described by this schema.
        "description": "A String", # A description of this schema.
        "enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
          "",
        ],
        "format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
        "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.
        "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
        },
        "required": [ # Whether this property is required.
          "A String",
        ],
        "type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
          "A String",
        ],
      },
    },
  ],
}

list_next()

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.