Índice
ReservationService(interfaz)Assignment(mensaje)Assignment.JobType(enum)Assignment.State(enum)BiReservation(mensaje)CapacityCommitment(mensaje)CapacityCommitment.CommitmentPlan(enum)CapacityCommitment.State(enum)CreateAssignmentRequest(mensaje)CreateCapacityCommitmentRequest(mensaje)CreateReservationRequest(mensaje)DeleteAssignmentRequest(mensaje)DeleteCapacityCommitmentRequest(mensaje)DeleteReservationRequest(mensaje)GetBiReservationRequest(mensaje)GetCapacityCommitmentRequest(mensaje)GetReservationRequest(mensaje)ListAssignmentsRequest(mensaje)ListAssignmentsResponse(mensaje)ListCapacityCommitmentsRequest(mensaje)ListCapacityCommitmentsResponse(mensaje)ListReservationsRequest(mensaje)ListReservationsResponse(mensaje)MergeCapacityCommitmentsRequest(mensaje)MoveAssignmentRequest(mensaje)Reservation(mensaje)SearchAssignmentsRequest(mensaje)SearchAssignmentsResponse(mensaje)SplitCapacityCommitmentRequest(mensaje)SplitCapacityCommitmentResponse(mensaje)UpdateBiReservationRequest(mensaje)UpdateCapacityCommitmentRequest(mensaje)UpdateReservationRequest(mensaje)
ReservationService
Esta API permite que los usuarios administren sus reservas de BigQuery de tasa fija.
Una reserva proporciona a los usuarios garantías de recursos de procesamiento, en forma de ranuras. Una ranura es una unidad de potencia de procesamiento en BigQuery y sirve como la unidad básica de paralelismo. En el análisis de una tabla con varias particiones, una sola ranura opera en una sola partición de la tabla. Existe un recurso de reserva como recurso secundario del proyecto y ubicación de administración, p. ej.: projects/myproject/locations/US/reservations/reservationName.
Un compromiso de capacidad es una forma de adquirir capacidad de procesamiento para los trabajos de BigQuery (en forma de ranuras) con un período de uso comprometido. Un recurso de compromiso de capacidad existe como un recurso secundario del proyecto y la ubicación de administración. P. ej.: projects/myproject/locations/US/capacityCommitments/id.
| CreateAssignment | |
|---|---|
|
Muestra
|
|
| CreateReservation | |
|---|---|
|
Crea un recurso de reserva nuevo.
|
|
| DeleteAssignment | |
|---|---|
|
Borra una asignación. No se producirá una expansión. P. ej.: organizationA contiene project1 y project2. La reserva res1 existe. CreateAssignment se invocó con anterioridad, y las siguientes asignaciones se crearon de manera explícita: <organizationA, res1> <project1, res1>. La eliminación de <organizationA, res1> no afectará a <project1, res1>. Después de la eliminación de <organizationA, res1>, las consultas de project1 usarán res1, y las de project2 usarán el modo a pedido.
|
|
| DeleteCapacityCommitment | |
|---|---|
|
Borra un compromiso de capacidad. Si intentas borrar el compromiso de capacidad antes de su commit_end_time, este fallará y arrojará el código de error
|
|
| DeleteReservation | |
|---|---|
|
Borra una reserva. Muestra
|
|
| GetBiReservation | |
|---|---|
|
Recupera una reserva de IE.
|
|
| GetCapacityCommitment | |
|---|---|
|
Muestra información sobre el compromiso de capacidad.
|
|
| GetReservation | |
|---|---|
|
Muestra información sobre la reserva.
|
|
| ListAssignments | |
|---|---|
|
Enumera las asignaciones. Solo se mostrarán las asignaciones que se crearon de manera explícita. P. ej.: organizationA contiene project1 y project2. La reserva res1 existe. CreateAssignment se invocó con anterioridad y las siguientes asignaciones se crearon de manera explícita: <organizationA, res1> <project1, res1> Entonces, esta API solo mostrará las dos asignaciones de arriba para la reserva res1, y no habrá ninguna expansión o fusión. El comodín “-” se puede usar para reservas en la solicitud. En ese caso, todas las asignaciones pertenecen al proyecto que se especificó, y la ubicación se enumerará. Nota: No se puede usar “-” para proyectos ni ubicaciones.
|
|
| ListCapacityCommitments | |
|---|---|
|
Enumera todos los compromisos de capacidad para el proyecto de administración.
|
|
| ListReservations | |
|---|---|
|
Muestra una lista de todas las reservas del proyecto en la ubicación especificada.
|
|
| MergeCapacityCommitments | |
|---|---|
|
Fusiona los compromisos de capacidad del mismo plan en uno solo. El compromiso de capacidad resultante tiene el mayor commitment_end_time de los dos. Si intentas combinar los compromisos de capacidad de un plan diferente, se producirá un error con el código de error
|
|
| MoveAssignment | |
|---|---|
|
Traslada una asignación a una reserva nueva. Los clientes pueden hacerlo si borran la asignación existente y crean otra asignación en la reserva nueva, pero este método proporciona una forma transaccional de hacerlo para asegurarse de que la persona asignada siempre tenga una reserva asociada. Sin el método, los clientes podrían ver algunas consultas ejecutadas a pedido que podrían ser imprevisibles.
|
|
| SearchAssignments | |
|---|---|
|
Busca asignaciones para un recurso específico en una región en particular. Si la solicitud es sobre un proyecto: 1) Se mostrarán las asignaciones creadas en el proyecto, si existen. 2) De lo contrario, se mostrarán las asignaciones creadas en el principal más cercano. 3) Se mostrarán todas las asignaciones para diferentes JobTypes. Se aplica la misma lógica si la solicitud es sobre una carpeta. Si la solicitud es sobre una organización, se mostrarán las asignaciones creadas en la organización (la organización no tiene principales). Si se compara con ListAssignments, existen algunas diferencias de comportamiento: 1) se verificará el permiso de la persona asignada en esta API. 2) En esta API, la búsqueda es jerárquica (proyecto-> carpeta-> organización). 3) El superior aquí es projects/*/locations/*, en lugar de projects/*/locations/*reservations/*. Nota: No se puede usar “-” para proyectos ni ubicaciones.
|
|
| SplitCapacityCommitment | |
|---|---|
|
Divide el compromiso de capacidad en dos compromisos del mismo plan y commitment_end_time. Un caso práctico común para hacerlo es realizar un cambio a una versión inferior. Por ejemplo, a fin de cambiar de una versión de 10,000 ranuras a una de 8,000, se puede dividir el compromiso de capacidad de 10,000 en 2,000 y 8,000, cambiar el plan del primer compromiso por uno flexible y, luego, borrarlo.
|
|
| UpdateBiReservation | |
|---|---|
|
Actualiza una reserva de IE. Solo se actualizan los campos especificados en field_mask. La reserva de IE de singleton siempre tiene el tamaño predeterminado 0. Para reservar capacidad de IE, debe actualizarse a una cantidad mayor que 0. Para liberar el tamaño de reserva de la capacidad de IE, se debe configurar en 0.
|
|
| UpdateCapacityCommitment | |
|---|---|
|
Actualiza un compromiso de capacidad existente. Solo se pueden actualizar los campos plan y renewal_plan. El plan solo se puede cambiar a un plan de un período de compromiso más largo. Los intentos de cambiar a un plan con un período de compromiso más corto fallarán con el código de error
|
|
| UpdateReservation | |
|---|---|
|
Actualiza un recurso de reserva existente.
|
|
Asignación
Una asignación permite que un proyecto envíe trabajos de un tipo determinado con ranuras de la reserva especificada.
| Campos | |
|---|---|
name |
Solo salida. Nombre del recurso. P. ej.: projects/myproject/locations/US/reservations/team1-prod/assignments/123. |
assignee |
El recurso que usará la reserva. P. ej.: projects/myproject, folders/123, organizations/456. |
job_type |
El tipo de trabajos que usará la reserva. |
state |
Solo salida. Estado de la asignación. |
JobType
Tipos de trabajo, que se pueden especificar cuando se usa la reserva.
| Enums | |
|---|---|
JOB_TYPE_UNSPECIFIED |
El tipo no es válido. Las solicitudes que tengan este valor se rechazarán con el código de error google.rpc.Code.INVALID_ARGUMENT. |
PIPELINE |
Los trabajos de canalización (carga y exportación) del proyecto usarán la reserva. |
QUERY |
Los trabajos de consulta del proyecto usarán la reserva. |
Estado
La asignación permanecerá en estado PENDING si no hay ningún compromiso de capacidad presente. Cambiará a ACTIVE cuando algún compromiso de capacidad se active.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Valor de estado no válido. |
PENDING |
Si hay asignaciones relacionadas pendientes, las consultas de la persona asignada se ejecutarán a pedido. |
ACTIVE |
La asignación está lista. |
BiReservation
Representa una reserva de IE.
| Campos | |
|---|---|
name |
El nombre del recurso de la reserva de IE de singleton. Los nombres de las reservas tienen el formato |
update_time |
Solo salida. La última marca de tiempo de actualización de una reserva. |
size |
Tamaño de una reserva, en bytes. |
CapacityCommitment
El compromiso de capacidad es una forma de adquirir capacidad de procesamiento para trabajos de BigQuery (en forma de ranuras) con un período de compromiso de uso. Los compromisos de permanencia anuales se renuevan de forma predeterminada. Los compromisos se pueden quitar después de la hora de finalización del compromiso. Para quitar el compromiso de permanencia anual, primero se debe cambiar su plan a mensual o flexible.
Existe un recurso de compromiso de capacidad como recurso secundario del proyecto del administrador.
| Campos | |
|---|---|
name |
Solo salida. El nombre del recurso del compromiso de capacidad, p. ej., projects/myproject/locations/US/capacityCommitments/123 |
slot_count |
Cantidad de ranuras en este compromiso. |
plan |
Plan de compromiso para el compromiso de capacidad. |
state |
Solo salida. Estado del compromiso. |
commitment_end_time |
Solo salida. El final del período de compromiso actual. Solo se aplica a los compromisos de capacidad ACTIVE. |
failure_status |
Solo salida. En el caso del plan de compromiso FAILED, se indica el motivo del error. |
renewal_plan |
El plan al que se convierte este compromiso de capacidad después de que se cumple el período de commitment_end_time. Una vez que se cambia el plan, el período de compromiso se extiende según el plan de compromiso. Solo se aplica a compromisos de permanencia ANUALES. |
CommitmentPlan
El plan de compromiso define el período de compromiso actual. El compromiso de capacidad no se puede borrar durante el período de compromiso.
| Enums | |
|---|---|
COMMITMENT_PLAN_UNSPECIFIED |
Valor de plan no válido. Las solicitudes que tengan este valor se rechazarán con el código de error google.rpc.Code.INVALID_ARGUMENT. |
FLEX |
Los compromisos flexibles tienen un período de compromiso de 1 minuto después de convertirse en ACTIVE. Luego, dejarán de estar en el período de compromiso y se podrán quitar en cualquier momento. |
TRIAL |
Los compromisos de prueba tienen un período de compromiso de 182 días después de convertirse en ACTIVE. Después de eso, se convierten en un compromiso nuevo basado en el renewal_plan. El renewal_plan predeterminado para el compromiso de prueba es flexible, a fin de que se pueda borrar de inmediato después de que finalice el período de compromiso. |
MONTHLY |
Los compromisos mensuales tienen un período de compromiso de 30 días después de convertirse en ACTIVE. Luego, dejarán de estar en el período de compromiso y se podrán quitar en cualquier momento. |
ANNUAL |
Los compromisos de permanencia anuales tienen un período de compromiso de 365 días después de convertirse en ACTIVE. Después de eso, se convierten en un compromiso nuevo basado en el renewal_plan. |
Estado
El compromiso de capacidad puede convertirse en ACTIVE de inmediato o pasar de PENDING a ACTIVE o FAILED.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Valor de estado no válido. |
PENDING |
El compromiso de capacidad posee aprovisionamiento pendiente. El compromiso de capacidad pendiente no contribuye a la slot_capacity del superior. |
ACTIVE |
Una vez que se aprovisionan las ranuras, el compromiso de capacidad pasa a ser activo. slot_count se agrega a la slot_capacity del superior. |
FAILED |
El backend falló y no activó el compromiso de capacidad. |
CreateAssignmentRequest
La solicitud para ReservationService.CreateAssignment. Nota: El permiso "bigquery.reservationAssignments.create" es obligatorio para la persona asignada relacionada.
| Campos | |
|---|---|
parent |
Obligatorio. El nombre del recurso superior de la asignación, p. ej., projects/myproject/locations/US/reservations/team1-prod La autorización requiere el siguiente permiso de IAM en el recurso
|
assignment |
Recurso de asignación para crear. |
CreateCapacityCommitmentRequest
La solicitud para ReservationService.CreateCapacityCommitment.
| Campos | |
|---|---|
parent |
Obligatorio. Nombre del recurso de la reserva superior. P. ej., projects/myproject/locations/US |
capacity_commitment |
Contenido del compromiso de capacidad que se creará. |
enforce_single_admin_project_per_org |
Si es verdadero, la solicitud falla si otro proyecto en la organización tiene un compromiso de capacidad. |
CreateReservationRequest
La solicitud para ReservationService.CreateReservation.
| Campos | |
|---|---|
parent |
Obligatorio. Proyecto, ubicación. P. ej., projects/myproject/locations/US |
reservation_id |
El ID de la reserva. Este campo solo debe contener caracteres alfanuméricos en minúscula o guiones. La longitud máxima es de 64 caracteres. |
reservation |
Contenido de la reserva nueva que se creará. |
DeleteAssignmentRequest
La solicitud para ReservationService.DeleteAssignment. Nota: El permiso "bigquery.reservationAssignments.delete" es obligatorio para la persona asignada relacionada.
| Campos | |
|---|---|
name |
Obligatorio. Nombre del recurso, p. ej.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 La autorización requiere el siguiente permiso de IAM en el recurso
|
DeleteCapacityCommitmentRequest
La solicitud para ReservationService.DeleteCapacityCommitment.
| Campos | |
|---|---|
name |
Obligatorio. Nombre del recurso del compromiso de capacidad a borrar. P. ej., projects/myproject/locations/US/capacityCommitments/123 |
DeleteReservationRequest
La solicitud para ReservationService.DeleteReservation.
| Campos | |
|---|---|
name |
Obligatorio. Nombre del recurso de la reserva que se recuperará. P. ej., projects/myproject/locations/US/reservations/team1-prod |
GetBiReservationRequest
Una solicitud para obtener una reserva de IE de singleton.
| Campos | |
|---|---|
name |
Obligatorio. Nombre de la reserva solicitada, por ejemplo: La autorización requiere el siguiente permiso de IAM en el recurso
|
GetCapacityCommitmentRequest
La solicitud para ReservationService.GetCapacityCommitment.
| Campos | |
|---|---|
name |
Obligatorio. Nombre del recurso del compromiso de capacidad que se recuperará. P. ej., projects/myproject/locations/US/capacityCommitments/123 |
GetReservationRequest
La solicitud para ReservationService.GetReservation.
| Campos | |
|---|---|
name |
Obligatorio. Nombre del recurso de la reserva que se recuperará. P. ej., projects/myproject/locations/US/reservations/team1-prod |
ListAssignmentsRequest
La solicitud para ReservationService.ListAssignments.
| Campos | |
|---|---|
parent |
Obligatorio. El nombre del recurso superior, p. ej., projects/myproject/locations/US/reservations/team1-prod O: projects/myproject/locations/US/reservations/- La autorización requiere el siguiente permiso de IAM en el recurso
|
page_size |
La cantidad máxima de elementos que se mostrarán. |
page_token |
El valor next_page_token que se muestra de una solicitud de lista anterior, si existe. |
ListAssignmentsResponse
La respuesta para ReservationService.ListAssignments.
| Campos | |
|---|---|
assignments[] |
Es la lista de asignaciones visibles para el usuario. |
next_page_token |
Token para recuperar la página siguiente de resultados o vaciarla si no hay más resultados en la lista. |
ListCapacityCommitmentsRequest
La solicitud para ReservationService.ListCapacityCommitments.
| Campos | |
|---|---|
parent |
Obligatorio. Nombre del recurso de la reserva superior. P. ej., projects/myproject/locations/US |
page_size |
La cantidad máxima de elementos que se mostrarán. |
page_token |
El valor next_page_token que se muestra de una solicitud de lista anterior, si existe. |
ListCapacityCommitmentsResponse
La respuesta para ReservationService.ListCapacityCommitments.
| Campos | |
|---|---|
capacity_commitments[] |
Lista de compromisos de capacidad visibles para el usuario. |
next_page_token |
Token para recuperar la página siguiente de resultados o vaciarla si no hay más resultados en la lista. |
ListReservationsRequest
La solicitud para ReservationService.ListReservations.
| Campos | |
|---|---|
parent |
Obligatorio. El nombre del recurso superior que contiene el proyecto y la ubicación, p. ej.: "projects/myproject/locations/US" |
page_size |
La cantidad máxima de elementos que se mostrarán. |
page_token |
El valor next_page_token que se muestra de una solicitud de lista anterior, si existe. |
filter |
Puede usarse para filtrar reservas basadas en nombres, capacidad, etc., p. ej.: filter="reservation.slot_capacity > 200" filter="reservation.name = "*dev/*"". Puedes consultar la sintaxis de filtro avanzado aquí. |
ListReservationsResponse
La respuesta para ReservationService.ListReservations.
| Campos | |
|---|---|
reservations[] |
Lista de reservas visibles para el usuario. |
next_page_token |
Token para recuperar la página siguiente de resultados o vaciarla si no hay más resultados en la lista. |
MergeCapacityCommitmentsRequest
La solicitud para ReservationService.MergeCapacityCommitments.
| Campos | |
|---|---|
parent |
Recurso principal que identifica el proyecto y la ubicación del administrador, p. ej., projects/myproject/locations/us |
capacity_commitment_ids[] |
ID de compromisos de capacidad para fusionar. Estos compromisos de capacidad deben estar en el proyecto y la ubicación de administrador especificados en el superior. |
MoveAssignmentRequest
La solicitud para ReservationService.MoveAssignment. Nota: El permiso de "bigquery.reservationAssignments.create" es obligatorio en el destination_id. Nota: El permiso "bigquery.reservationAssignments.create" y "bigquery.reservationAssignments.delete" es obligatorio para la persona asignada relacionada.
| Campos | |
|---|---|
name |
Obligatorio. El nombre del recurso de la asignación, p. ej.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 La autorización requiere el siguiente permiso de IAM en el recurso
|
destination_id |
El ID de reserva nuevo, p. ej.: projects/myotherproject/locations/US/reservations/team2-prod |
Reserva
Una reserva es un mecanismo que se usa para garantizar ranuras a los usuarios.
| Campos | |
|---|---|
name |
Es el nombre del recurso de la reserva, p. ej., “projects/*/locations/*/reservations/team1-prod”. |
slot_capacity |
Ranuras mínimas disponibles para esta reserva. Una ranura es una unidad de potencia de procesamiento en BigQuery y sirve como unidad de paralelismo. Las consultas que usan esta reserva pueden usar más ranuras durante el tiempo de ejecución si ignore_idle_slots está se establece en falso. Si la capacidad de ranuras de la reserva nueva supera la capacidad de ranuras del superior o si la capacidad total de la reserva nueva y los elementos de mismo nivel superan la capacidad de ranuras del superior, la solicitud producirá un error con |
ignore_idle_slots |
Si es falso, cualquier consulta que use esta reserva usará ranuras inactivas de otras reservas dentro del mismo proyecto de administrador. Si es verdadero, una consulta que use esta reserva se ejecutará con la capacidad de ranura máxima especificada con anterioridad. |
SearchAssignmentsRequest
La solicitud para ReservationService.SearchAssignments. Nota: El permiso "bigquery.reservationAssignments.search" es obligatorio para la persona asignada relacionada.
| Campos | |
|---|---|
parent |
Obligatorio. El nombre del recurso del proyecto de administración (que contiene el proyecto y la ubicación), p. ej. "projects/myproject/locations/US". |
query |
Especifica el nombre del recurso como persona asignada en la consulta, p. ej., "assignee=projects/myproject" "assignee=folders/123" "assignee=organizations/456" |
page_size |
La cantidad máxima de elementos que se mostrarán. |
page_token |
El valor next_page_token que se muestra de una solicitud de lista anterior, si existe. |
SearchAssignmentsResponse
La respuesta para ReservationService.SearchAssignments.
| Campos | |
|---|---|
assignments[] |
Es la lista de asignaciones visibles para el usuario. |
next_page_token |
Token para recuperar la página siguiente de resultados o vaciarla si no hay más resultados en la lista. |
SplitCapacityCommitmentRequest
La solicitud para ReservationService.SplitCapacityCommitment.
| Campos | |
|---|---|
name |
Obligatorio. El nombre del recurso, p. ej.: projects/myproject/locations/US/capacityCommitments/123 La autorización requiere el siguiente permiso de IAM en el recurso
|
slot_count |
La cantidad de ranuras en el compromiso de capacidad después de la división. |
SplitCapacityCommitmentResponse
La respuesta para ReservationService.SplitCapacityCommitment.
| Campos | |
|---|---|
first |
Primer compromiso de capacidad, resultado de una división. |
second |
Segundo compromiso de capacidad, resultado de una división. |
UpdateBiReservationRequest
Una solicitud para actualizar una reserva de IE.
| Campos | |
|---|---|
reservation |
Una reserva para actualizar. La autorización requiere el siguiente permiso de IAM en el recurso
|
update_mask |
Una lista de campos que se actualizarán en esta solicitud. |
UpdateCapacityCommitmentRequest
La solicitud para ReservationService.UpdateCapacityCommitment.
| Campos | |
|---|---|
capacity_commitment |
Contenido del compromiso de capacidad que se actualizará. |
update_mask |
Es la máscara de campo estándar para el conjunto de campos que se actualizará. |
UpdateReservationRequest
La solicitud para ReservationService.UpdateReservation.
| Campos | |
|---|---|
reservation |
Contenido de la reserva que se actualizará. |
update_mask |
Es la máscara de campo estándar para el conjunto de campos que se actualizará. |