Method: projects.locations.apps.retrieveToolSchema

Recupera o esquema da ferramenta especificada. O esquema é calculado dinamicamente para a determinada instância da ferramenta.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do app a que a ferramenta/conjunto de ferramentas pertence. Formato: projects/{project}/locations/{location}/apps/{app}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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
O identificador da ferramenta para recuperar o esquema. Ela pode ser uma ferramenta persistente ou de um conjunto de ferramentas. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
tool

string

Opcional. O nome da ferramenta para recuperar o esquema. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

Opcional. A ferramenta do conjunto de ferramentas para recuperar o esquema. Apenas uma ferramenta precisa corresponder ao predicado do conjunto de ferramentas. Caso contrário, um erro será retornado.
Fim dos campos mutuamente exclusivos.

Corpo da resposta

Mensagem de resposta para ToolService.RetrieveToolSchema.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação 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)

O esquema dos parâmetros de entrada da ferramenta.
outputSchema

object (Schema)

O esquema dos parâmetros de saída da ferramenta.
O identificador da ferramenta a que o esquema se destina. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
tool

string

O nome da ferramenta para a qual o esquema é destinado. Formato: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolsetTool

object (ToolsetTool)

A ferramenta do conjunto de ferramentas para que o esquema é usado.
Fim dos campos mutuamente exclusivos.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • ces.tools.get

Para mais informações, consulte a documentação do IAM.