Method: projects.locations.collections.engines.getWorkspaceSettings

Obtenha as definições do Workspace para o utilizador final.

Pedido HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*}:getWorkspaceSettings

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. Nome do recurso do motor completo. Formato: projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}

Corpo do pedido

O corpo do pedido tem de estar vazio.

Corpo da resposta

Definições do Workspace para o utilizador final.

Se for bem-sucedido, o corpo da resposta contém dados com a seguinte estrutura:

Representação JSON 
{
  "workspaceAccessEnabled": boolean
}
Campos
workspaceAccessEnabled

boolean

Indica se um utilizador final tem o acesso ao Workspace ativado.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

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

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso name:

  • discoveryengine.engines.get

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