Method: projects.locations.apps.retrieveToolSchema

Recupera el esquema de la herramienta determinada. El esquema se calcula sobre la marcha para la instancia determinada de la herramienta.

Solicitud HTTP

POST https://ces.googleapis.com/v1beta/{parent=projects/*/locations/*/apps/*}:retrieveToolSchema

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el nombre del recurso de la app a la que pertenece la herramienta o el conjunto de herramientas. Formato: projects/{project}/locations/{location}/apps/{app}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
Campos
Es el identificador de la herramienta para la que se recuperará el esquema. Puede ser una herramienta persistente o una herramienta de un conjunto de herramientas. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
tool

string

Es opcional. Es el nombre de la herramienta para la que se recuperará el esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

Es opcional. Es la herramienta del conjunto de herramientas para recuperar el esquema. Solo una herramienta debe coincidir con el predicado del conjunto de herramientas. De lo contrario, se mostrará un error.

Fin de los campos mutuamente excluyentes.

Cuerpo de la respuesta

Mensaje de respuesta para ToolService.RetrieveToolSchema.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "tool": string,
  "toolsetTool": {
    object (ToolsetTool)
  }
  // End of mutually exclusive fields.
}
Campos
inputSchema

object (Schema)

Es el esquema de los parámetros de entrada de la herramienta.

outputSchema

object (Schema)

Es el esquema de los parámetros de salida de la herramienta.

Es el identificador de la herramienta para la que se usa el esquema. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
tool

string

Es el nombre de la herramienta para la que se creó el esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

toolsetTool

object (ToolsetTool)

Es la herramienta del conjunto de herramientas para la que se aplica el esquema.

Fin de los campos mutuamente excluyentes.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • ces.tools.get

Para obtener más información, consulta la documentación de IAM.