Method: projects.tenants.patch

Atualiza o locatário especificado.

Solicitação HTTP

PATCH https://jobs.googleapis.com/v4beta1/{tenant.name=projects/*/tenants/*}

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

Parâmetros de caminho

Parâmetros
tenant.name

string

Obrigatório durante a atualização do locatário.

O nome do recurso para um locatário. Ele é gerado pelo serviço quando um locatário é criado.

O formato é "projects/{projectId}/tenants/{tenantId}", por exemplo, "projects/foo/tenants/bar".

Corpo da solicitação

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

Representação JSON 
{
  "tenant": {
    "name": string,
    "externalId": string,
    "usageType": enum (DataUsageType),
    "keywordSearchableProfileCustomAttributes": [
      string
    ]
  },
  "updateMask": string
}
Campos
tenant.externalId

string

Obrigatório. Identificador de locatário do lado do cliente, usado para identificar exclusivamente o locatário.

O número máximo de caracteres permitido é 255.
tenant.usageType

enum (DataUsageType)

Indica se os dados de propriedade deste locatário podem ser usados para fornecer melhorias de produtos em outros locatários.

Se não for definido, o comportamento padrão será DataUsageType.ISOLATED.
tenant.keywordSearchableProfileCustomAttributes[]

string

Uma lista de chaves de Profile.custom_attributes filtrável, com stringValues correspondente usada em pesquisas por palavra-chave. Os perfis com stringValues nessas chaves de campo especificadas serão retornados se algum dos valores corresponder à palavra-chave de pesquisa. Os valores de campo personalizados com parênteses, colchetes e símbolos especiais não são pesquisáveis no estado em que se encontram e precisam estar entre aspas.
updateMask

string (FieldMask format)

É altamente recomendado para melhorar a experiência de atendimento.

Se updateMask for fornecido, somente os campos especificados em tenant serão atualizados. Do contrário, todos os campos serão atualizados.

Uma máscara de campo para especificar os campos de locatário a serem atualizados. Somente campos de nível superior de Tenant são aceitos.

Lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Tenant.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.