Index
ReservationService
(interface)Assignment
(mensagem)Assignment.JobType
(enum)Assignment.State
(enum)BiReservation
(mensagem)CapacityCommitment
(mensagem)CapacityCommitment.CommitmentPlan
(enum)CapacityCommitment.State
(enum)CreateAssignmentRequest
(mensagem)CreateCapacityCommitmentRequest
(mensagem)CreateReservationRequest
(mensagem)DeleteAssignmentRequest
(mensagem)DeleteCapacityCommitmentRequest
(mensagem)DeleteReservationRequest
(mensagem)GetBiReservationRequest
(mensagem)GetCapacityCommitmentRequest
(mensagem)GetReservationRequest
(mensagem)ListAssignmentsRequest
(mensagem)ListAssignmentsResponse
(mensagem)ListCapacityCommitmentsRequest
(mensagem)ListCapacityCommitmentsResponse
(mensagem)ListReservationsRequest
(mensagem)ListReservationsResponse
(mensagem)MergeCapacityCommitmentsRequest
(mensagem)MoveAssignmentRequest
(mensagem)Reservation
(mensagem)SearchAssignmentsRequest
(mensagem)SearchAssignmentsResponse
(mensagem)SplitCapacityCommitmentRequest
(mensagem)SplitCapacityCommitmentResponse
(mensagem)UpdateBiReservationRequest
(mensagem)UpdateCapacityCommitmentRequest
(mensagem)UpdateReservationRequest
(mensagem)
ReservationService
Esta API permite que os usuários gerenciem reservas de taxa fixa do BigQuery.
Uma reserva fornece garantias de recurso computacional na forma de slots aos usuários. Um slot é uma unidade de capacidade computacional no BigQuery. Ele funciona como unidade básica do paralelismo. Nas verificações de uma tabela multiparticionada, um único slot opera em uma única partição da tabela. Um recurso de reserva existe como recurso filho do projeto administrativo e do local, por exemplo: projects/myproject/locations/US/reservations/reservationName
.
Um compromisso de capacidade é uma forma de adquirir capacidade de computação para jobs do BigQuery (na forma de slots) com um período de uso confirmado. Um recurso de confirmação de capacidade existe como recurso filho do projeto administrativo e do local, por exemplo: projects/myproject/locations/US/capacityCommitments/id
CreateAssignment | |
---|---|
Cria um objeto de atribuição permitindo que o projeto em questão envie jobs de um determinado tipo usando slots da reserva especificada. Atualmente, um recurso (projeto, pasta, organização) pode ter apenas uma atribuição por cada combinação (job_type, local), e essa reserva será usada para todos os jobs do mesmo tipo. Diferentes atribuições podem ser criadas em diferentes níveis da hierarquia de projetos, pastas ou organizações. Durante a execução da consulta, a atribuição é pesquisada nos níveis do projeto, da pasta e da organização, nessa ordem. A primeira atribuição encontrada é aplicada à consulta. Ao criar atribuições, não faz diferença se existem outras em níveis mais altos. Exemplo:
Retorna Retorna
|
CreateCapacityCommitment | |
---|---|
Cria um novo recurso de compromisso de capacidade.
|
CreateReservation | |
---|---|
Cria um novo recurso de reserva.
|
DeleteAssignment | |
---|---|
Exclui uma atribuição. Não haverá nenhuma expansão. Exemplo:
Neste exemplo, a exclusão da atribuição
|
DeleteCapacityCommitment | |
---|---|
Exclui uma confirmação de capacidade. A tentativa de excluir a confirmação de capacidade antes do commit_end_time resultará em erro com o código
|
DeleteReservation | |
---|---|
Exclui uma reserva. Retorna o
|
GetBiReservation | |
---|---|
Recupera uma reserva de BI.
|
GetCapacityCommitment | |
---|---|
Retorna informações sobre a confirmação de capacidade.
|
GetReservation | |
---|---|
Retorna informações sobre a reserva.
|
ListAssignments | |
---|---|
Lista as atribuições. Somente as atribuições criadas explicitamente serão retornadas. Exemplo:
Neste exemplo, ListAssignments retornará apenas as duas atribuições acima para reserva O caractere curinga "-" pode ser usado para reservas na solicitação. Nesse caso, todas as atribuições pertencem ao projeto especificado e o local será listado. Observe que não é possível usar "-" para projetos nem locais.
|
ListCapacityCommitments | |
---|---|
Lista todas as confirmações de capacidade do projeto administrativo.
|
ListReservations | |
---|---|
Lista todas as reservas para o projeto no local especificado.
|
MergeCapacityCommitments | |
---|---|
Mescla os compromissos de capacidade do mesmo plano em um único compromisso. O compromisso de capacidade resultante tem o maior commitment_end_time dos compromissos de capacidade a serem mesclados. A tentativa de mesclar compromissos de capacidade de planos diferentes falhará e apresentará o código de erro
|
MoveAssignment | |
---|---|
Move uma tarefa para uma nova reserva. Isso é diferente de remover uma atribuição existente e recriar uma nova proporcionando uma alteração transacional para que um responsável sempre tenha uma reserva associada.
|
SearchAssignments | |
---|---|
Procura atribuições para um recurso especificado de uma região determinada. Se a solicitação for sobre um projeto:
A mesma lógica será aplicada se a solicitação for sobre uma pasta. Se a solicitação for sobre uma organização, as atribuições criadas na organização serão retornadas (a organização não tem ancestrais). Em comparação com ListAssignments, existem algumas diferenças de comportamento:
Observe que não é possível usar "-" para projetos nem locais.
|
SplitCapacityCommitment | |
---|---|
Divide o compromisso de capacidade em dois compromissos do mesmo plano e commitment_end_time. Um caso de uso comum é ativar o downgrade de compromissos. Por exemplo, para fazer downgrade de 10.000 slots para 8.000, divida um compromisso de capacidade de 10.000 em compromissos de 2.000 e 8.000. Depois, altere o plano do primeiro para
|
UpdateBiReservation | |
---|---|
Atualiza uma reserva de BI. Somente os campos especificados no Uma reserva de BI singleton sempre existe com o tamanho padrão 0. Para reservar a capacidade de BI, é necessário atualizá-la para um valor maior que 0. Para liberar a capacidade de BI, é necessário definir o tamanho da reserva como 0.
|
UpdateCapacityCommitment | |
---|---|
Atualiza um compromisso de capacidade. Somente os campos Só é possível alterar um plano para outro de maior período de compromisso. A tentativa de mudar para um plano com um período de compromisso mais curto falhará e apresentará o código de erro
|
UpdateReservation | |
---|---|
Atualiza um recurso de reserva atual.
|
Atribuição
Uma atribuição permite que um projeto envie jobs de um determinado tipo usando slots da reserva especificada.
Campos | |
---|---|
name |
Somente saída. Nome do recurso. Exemplo: |
assignee |
O recurso que usará a reserva. por exemplo: |
job_type |
Quais tipos de job usarão a reserva. |
state |
Somente saída. Estado da atribuição. |
JobType
Tipos de job, que podem ser especificados ao usar a reserva.
Enums | |
---|---|
JOB_TYPE_UNSPECIFIED |
Tipo inválido. As solicitações com esse valor serão rejeitadas com o código do erro google.rpc.Code.INVALID_ARGUMENT . |
PIPELINE |
Os jobs de pipeline (carregar/exportar) do projeto usarão a reserva. |
QUERY |
Os jobs de consulta do projeto usarão a reserva. |
Estado
A atribuição permanecerá no estado PENDING se nenhum compromisso de capacidade ativo estiver presente. Ele se tornará ACTIVE quando um compromisso de capacidade se tornar ativo.
Enums | |
---|---|
STATE_UNSPECIFIED |
Valor de estado inválido. |
PENDING |
As consultas do responsável pela atribuição serão executadas sob demanda se a atribuição relacionada estiver pendente. |
ACTIVE |
A atribuição está pronta. |
BiReservation
Representa uma reserva de BI.
Campos | |
---|---|
name |
O nome do recurso da reserva de BI de singleton. Os nomes de reserva têm o formato |
update_time |
Somente saída. O último carimbo de data/hora da atualização de uma reserva. |
size |
Tamanho de uma reserva, em bytes. |
CapacityCommitment
Compromisso de capacidade é uma maneira de adquirir capacidade computacional para jobs do BigQuery, na forma de slots, por um período de compromisso de uso. Os compromissos anuais são renovados por padrão. Os compromissos podem ser removidos após sua hora de término.
Para remover o compromisso anual, primeiro, o plano precisa ser alterado para mensal ou flexível.
O recurso de compromisso de capacidade existe como um recurso filho do projeto administrativo.
Campos | |
---|---|
name |
Apenas saída. O nome do recurso do compromisso de capacidade, por exemplo, |
slot_count |
Número de slots neste compromisso. |
plan |
Plano de compromisso do compromisso de capacidade. |
state |
Somente saída. Estado da confirmação. |
commitment_end_time |
Somente saída. O fim do período de compromisso atual. Ele é aplicável apenas a compromissos de capacidade ACTIVE. |
failure_status |
Somente saída. Para planos de comprometimento FAILED, dá o motivo da falha. |
renewal_plan |
Plano para o qual esse compromisso de capacidade é convertido depois que o commitment_end_time passar. Depois que o plano é alterado, o período do compromisso é estendido de acordo com o respectivo plano. Aplicável somente a compromissos ANNUAL e TRIAL. |
CommitmentPlan
O plano de compromisso define o período de compromisso atual. Não é possível excluir o compromisso de capacidade durante o período de compromisso dele.
Enums | |
---|---|
COMMITMENT_PLAN_UNSPECIFIED |
Valor de plano inválido. As solicitações com esse valor serão rejeitadas com o código do erro google.rpc.Code.INVALID_ARGUMENT . |
FLEX |
Compromissos flexíveis têm um período de compromisso de um minuto depois de se tornarem ACTIVE. Após esse tempo, eles deixarão de estar em um período de compromisso e, então, será possível removê-los a qualquer momento. |
TRIAL |
As avaliações têm um período de compromisso de 182 dias depois de se tornarem ACTIVE. Depois disso, eles são convertidos em um novo compromisso com base no renewal_plan. A renovação padrão do plano de avaliação é o Flex para que possa ser excluído logo após o término do período de confirmação. |
MONTHLY |
Compromissos mensais têm um período de compromisso de 30 dias após se tornarem ACTIVE. Após esse tempo, eles deixarão de estar em um período de compromisso e, então, será possível removê-los a qualquer momento. |
ANNUAL |
Compromissos anuais têm um período de 365 dias após se tornarem ACTIVE. Depois disso, eles são convertidos em um novo compromisso com base no renewal_plan. |
State
É possível que o compromisso de capacidade se torne ACTIVE imediatamente ou que passe de PENDING para ACTIVE ou FAILED.
Enums | |
---|---|
STATE_UNSPECIFIED |
Valor de estado inválido. |
PENDING |
A confirmação de capacidade está com provisionamento pendente. A confirmação de capacidade pendente não contribui para o slot_capacity do pai. |
ACTIVE |
Assim que os slots forem provisionados, a confirmação de capacidade ficará ativa. O slot_count será adicionado à slot_capacity do pai. |
FAILED |
O compromisso de capacidade falhará para ser ativado pelo back-end. |
CreateAssignmentRequest
A solicitação para ReservationService.CreateAssignment
. Observação: a permissão "bigquery.reservationAssignments.create" é obrigatória para o cessionário relacionado.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso pai da atribuição, por exemplo, A autorização requer a seguinte permissão do IAM no recurso especificado
|
assignment |
Criar um recurso de atribuição. |
CreateCapacityCommitmentRequest
A solicitação para ReservationService.CreateCapacityCommitment
.
Campos | |
---|---|
parent |
Obrigatório. Nome do recurso da reserva pai. Ex.: projects/myproject/locations/US |
capacity_commitment |
Conteúdo do compromisso de capacidade a ser criado. |
enforce_single_admin_project_per_org |
Se verdadeiro, cancele a solicitação se outro projeto na organização tiver um compromisso de capacidade. |
CreateReservationRequest
A solicitação para ReservationService.CreateReservation
.
Campos | |
---|---|
parent |
Obrigatório. Projeto, local. Exemplo, |
reservation_id |
O ID da reserva. É necessário que esse campo contenha apenas caracteres alfanuméricos em minúsculas ou travessão. O comprimento máximo é de 64 caracteres. |
reservation |
Definição da nova reserva a ser criada. |
DeleteAssignmentRequest
A solicitação para ReservationService.DeleteAssignment
. Observação: a permissão "bigquery.reservationAssignments.delete" é obrigatória para o cessionário relacionado.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso, por exemplo, A autorização requer a seguinte permissão do IAM no recurso especificado
|
DeleteCapacityCommitmentRequest
A solicitação para ReservationService.DeleteCapacityCommitment
.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso do compromisso de capacidade a ser excluído. Ex.: projects/myproject/locations/US/capacityCommitments/123 |
DeleteReservationRequest
A solicitação para ReservationService.DeleteReservation
.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso da reserva a ser recuperada. Ex.: |
GetBiReservationRequest
Uma solicitação para receber uma reserva de BI de singleton.
Campos | |
---|---|
name |
Obrigatório. Nome da reserva solicitada, por exemplo: A autorização requer a seguinte permissão do IAM no recurso especificado
|
GetCapacityCommitmentRequest
A solicitação para ReservationService.GetCapacityCommitment
.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso da confirmação de capacidade a ser recuperada. Ex.: projects/myproject/locations/US/capacityCommitments/123 |
GetReservationRequest
A solicitação para ReservationService.GetReservation
.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso da reserva a ser recuperada. Ex.: |
ListAssignmentsRequest
A solicitação para ReservationService.ListAssignments
.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso pai, por exemplo:
Ou:
A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
O número máximo de itens que serão retornados por página. |
page_token |
O valor next_page_token retornado de uma solicitação List anterior, se houver. |
ListAssignmentsResponse
A resposta para ReservationService.ListAssignments
.
Campos | |
---|---|
assignments[] |
Lista de atribuições visíveis para o usuário. |
next_page_token |
Token para recuperar a próxima página de resultados ou esvaziar se não houver mais resultados na lista. |
ListCapacityCommitmentsRequest
A solicitação para ReservationService.ListCapacityCommitments
.
Campos | |
---|---|
parent |
Obrigatório. Nome do recurso da reserva pai. Ex.: projects/myproject/locations/US |
page_size |
Número máximo de itens a serem retornados. |
page_token |
Valor next_page_token retornado de uma solicitação List anterior, se houver. |
ListCapacityCommitmentsResponse
A resposta para ReservationService.ListCapacityCommitments
.
Campos | |
---|---|
capacity_commitments[] |
Lista de compromissos de capacidade visíveis para o usuário. |
next_page_token |
Token para recuperar a próxima página de resultados ou esvaziar se não houver mais resultados na lista. |
ListReservationsRequest
A solicitação para ReservationService.ListReservations
.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso pai que contém o projeto e o local, por exemplo: "projects/myproject/locations/US" |
page_size |
O número máximo de itens que serão retornados por página. |
page_token |
O valor next_page_token retornado de uma solicitação List anterior, se houver. |
ListReservationsResponse
A resposta para ReservationService.ListReservations
.
Campos | |
---|---|
reservations[] |
Lista de atribuições visíveis para o usuário. |
next_page_token |
Token para recuperar a próxima página de resultados ou esvaziar se não houver mais resultados na lista. |
MergeCapacityCommitmentsRequest
A solicitação para ReservationService.MergeCapacityCommitments
.
Campos | |
---|---|
parent |
Recurso pai que identifica o projeto e o local do administrador, por exemplo: projects/myproject/locations/us |
capacity_commitment_ids[] |
Códigos dos compromissos de capacidade a serem mesclados. É necessário que esses compromissos de capacidade existam no projeto e no local do administrador especificados no principal. |
MoveAssignmentRequest
A solicitação para ReservationService.MoveAssignment
.
Observação: a permissão "bigquery.reservationAssignments.create" é exigida no destination_id.
Observação: as permissões "bigquery.reservationAssignments.create" e "bigquery.reservationAssignments.delete" são obrigatórias no responsável relacionado.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso da atribuição, por exemplo, A autorização requer a seguinte permissão do IAM no recurso especificado
|
destination_id |
O novo ID da reserva, por exemplo: |
Reserva
Uma reserva é um mecanismo usado para garantir slots aos usuários.
Campos | |
---|---|
name |
O nome do recurso da reserva, por exemplo: |
slot_capacity |
Mínimo de slots disponíveis para esta reserva. Slot é uma unidade de capacidade computacional no BigQuery e funciona como unidade de paralelismo. É possível que as consultas que usam essa reserva utilizem mais slots durante o tempo de execução se ignore_idle_slots estiver definido como falso. Se a capacidade de slots da nova reserva exceder a capacidade de slots do pai ou se a capacidade de slots total da nova reserva e dos irmãos dela excederem a capacidade de slots do pai, a solicitação falhará com |
ignore_idle_slots |
Se for falso, qualquer consulta que usar essa reserva utilizará slots de outras reservas no mesmo projeto do administrador. Se verdadeiro, uma consulta que usar essa reserva será executada com a capacidade de slots especificada acima no máximo. |
SearchAssignmentsRequest
A solicitação para ReservationService.SearchAssignments
. Observação: a permissão "bigquery.reservationAssignments.search" é obrigatória para o cessionário relacionado.
Campos | |
---|---|
parent |
Obrigatório. O nome do recurso do projeto do administrador (com projeto e local), por exemplo: "projetos/meuprojeto/locais/BR". |
query |
Especifique o nome do recurso como responsável na consulta. Exemplos:
|
page_size |
O número máximo de itens que serão retornados por página. |
page_token |
O valor next_page_token retornado de uma solicitação List anterior, se houver. |
SearchAssignmentsResponse
A resposta para ReservationService.SearchAssignments
.
Campos | |
---|---|
assignments[] |
Lista de atribuições visíveis para o usuário. |
next_page_token |
Token para recuperar a próxima página de resultados ou esvaziar se não houver mais resultados na lista. |
SplitCapacityCommitmentRequest
A solicitação para ReservationService.SplitCapacityCommitment
.
Campos | |
---|---|
name |
Obrigatório. Nome do recurso, por exemplo: projects/myproject/locations/US/capacityCommitments/123 A autorização requer a seguinte permissão do IAM no recurso especificado
|
slot_count |
Número de slots no compromisso de capacidade após a divisão. |
SplitCapacityCommitmentResponse
A resposta para ReservationService.SplitCapacityCommitment
.
Campos | |
---|---|
first |
Primeiro compromisso de capacidade, resultado de uma divisão. |
second |
Segundo compromisso de capacidade, resultado de uma divisão. |
UpdateBiReservationRequest
Uma solicitação para atualizar uma reserva de BI.
Campos | |
---|---|
bi_reservation |
Reserva a ser atualizada. A autorização requer a seguinte permissão do IAM no recurso especificado
|
update_mask |
Lista de campos a serem atualizados nesta solicitação. |
UpdateCapacityCommitmentRequest
A solicitação para ReservationService.UpdateCapacityCommitment
.
Campos | |
---|---|
capacity_commitment |
Conteúdo do compromisso de capacidade a ser atualizado. |
update_mask |
Máscara de campo padrão para o conjunto de campos a ser atualizado. |
UpdateReservationRequest
A solicitação para ReservationService.UpdateReservation
.
Campos | |
---|---|
reservation |
Conteúdo da reserva a ser atualizada. |
update_mask |
Máscara de campo padrão para o conjunto de campos a ser atualizado. |