Paquete google.cloud.bigquery.reservation.v1beta1

Índice

• ReservationService (interfaz)
• Assignment (mensaje)
• Assignment.JobType (enum)
• CapacityCommitment (mensaje)
• CapacityCommitment.CommitmentPlan (enum)
• CapacityCommitment.State (enum)
• CreateAssignmentRequest (mensaje)
• CreateCapacityCommitmentMetadata (mensaje)
• CreateReservationRequest (mensaje)
• DeleteAssignmentRequest (mensaje)
• DeleteCapacityCommitmentRequest (mensaje)
• DeleteReservationRequest (mensaje)
• GetCapacityCommitmentRequest (mensaje)
• GetReservationRequest (mensaje)
• ListAssignmentsRequest (mensaje)
• ListAssignmentsResponse (mensaje)
• ListCapacityCommitmentsRequest (mensaje)
• ListCapacityCommitmentsResponse (mensaje)
• ListReservationsRequest (mensaje)
• ListReservationsResponse (mensaje)
• MoveAssignmentRequest (mensaje)
• Reservation (mensaje)
• SearchAssignmentsRequest (mensaje)
• SearchAssignmentsResponse (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 compromiso de uso mínimo. 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.

Algunos de los métodos muestran google.longrunning.Operation, ya que puede llevar mucho tiempo procesar la solicitud.

CreateAssignment

CreateAssignmentRequestAssignment rpc CreateAssignment() returns () Muestra google.rpc.Code.PERMISSION_DENIED si el usuario no tiene permisos “bigquery.admin” en el proyecto que usa la reserva y en el que posee esta reserva. Muestra google.rpc.Code.INVALID_ARGUMENT cuando la ubicación de la asignación no coincide con la ubicación de la reserva. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

CreateReservation
CreateReservationRequestReservation rpc CreateReservation() returns () Crea un recurso de reserva nuevo. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

DeleteAssignment

DeleteAssignmentRequestEmpty rpc DeleteAssignment() returns () 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. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

DeleteCapacityCommitment

DeleteCapacityCommitmentRequestEmpty rpc DeleteCapacityCommitment() returns () 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 google.rpc.Code.FAILED_PRECONDITION. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

DeleteReservation

DeleteReservationRequestEmpty rpc DeleteReservation() returns () Borra una reserva. Muestra google.rpc.Code.FAILED_PRECONDITION cuando la reserva tiene asignaciones. Esta verificación se puede omitir si se establece la marca DeleteReservationRequest.force como verdadera. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

GetCapacityCommitment
GetCapacityCommitmentRequestCapacityCommitment rpc GetCapacityCommitment() returns () Muestra la información sobre el compromiso de capacidad. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

GetReservation
GetReservationRequestReservation rpc GetReservation() returns () Muestra información sobre la reserva. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

ListAssignments

ListAssignmentsRequestListAssignmentsResponse rpc ListAssignments() returns () Muestra 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á. Ten en cuenta que “-” no se puede usar para proyectos ni ubicaciones. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

ListCapacityCommitments

ListCapacityCommitmentsRequestListCapacityCommitmentsResponse rpc ListCapacityCommitments() returns () Enumera todos los compromisos de capacidad para el proyecto de administración. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

ListReservations

ListReservationsRequestListReservationsResponse rpc ListReservations() returns () Muestra una lista de todas las reservas del proyecto en la ubicación especificada. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

MoveAssignment

MoveAssignmentRequestAssignment rpc MoveAssignment() returns () 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 pudieran ser imprevisibles. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

SearchAssignments

SearchAssignmentsRequestSearchAssignmentsResponse rpc SearchAssignments() returns () 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/* y no projects/*/locations/*reservations/*. El comodín "-" se puede usar para proyectos en SearchAssignmentsRequest.parent. Ten en cuenta que “-” no se puede usar para proyectos ni ubicaciones. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

UpdateReservation
UpdateReservationRequestReservation rpc UpdateReservation() returns () Actualiza un recurso de reserva existente. Alcances de autorización Se necesita uno de los siguientes alcances de OAuth: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/cloud-platform Para obtener más información, consulta Descripción general de la autenticación.

Assignment

Una asignación permite que un proyecto envíe trabajos de un tipo determinado con ranuras de la reserva especificada.

Campos
name	string Solo salida. Nombre del recurso. P. ej.: projects/myproject/locations/US/reservations/team1-prod/assignments/123.
assignee	string El recurso que usará la reserva. P. ej.: projects/myproject, folders/123, organizations/456.
job_type	JobType El tipo de trabajos que usará la reserva.

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.

CapacityCommitment

El 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 compromiso de uso mínimo. El compromiso de capacidad no puede modificarse ni borrarse hasta el final del período de compromiso. Una vez finalizado el período de compromiso, las ranuras siguen disponibles, pero pueden quitarse en cualquier momento.

Un recurso de compromiso de capacidad existe como recurso secundario del proyecto de administración.

Campos
name	string Solo salida. El nombre del recurso del compromiso de capacidad, p. ej., projects/myproject/locations/US/capacityCommitments/123
slot_count	int64 Cantidad de ranuras en este compromiso.
plan	CommitmentPlan Plan de compromiso para el compromiso de capacidad.
state	State Solo salida. Estado del compromiso.
commitment_end_time	Timestamp Solo salida. El final del período de compromiso. No se puede quitar el compromiso de capacidad antes del commitment_end_time. Solo se aplica a los compromisos de capacidad ACTIVOS y se calcula como una combinación del plan y el momento en el que el compromiso de capacidad pasó a ser ACTIVO.

CommitmentPlan

El plan de compromiso define el final del 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.
MONTHLY	No se puede quitar el compromiso de capacidad por 30 días después de que pasa a ser ACTIVO.
ANNUAL	No se puede quitar el compromiso de capacidad por 365 días después de que pasa a ser ACTIVO.

Estado

El compromiso de capacidad puede pasar a ser ACTIVO de inmediato o pasar de PENDIENTE a ACTIVO.

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.

CreateAssignmentRequest

La solicitud para ReservationService.CreateAssignment. Nota: El permiso de "bigquery.reservationAssignments.create" es obligatorio para la persona asignada relacionada.

Campos
parent	string El nombre del recurso superior de la asignación, p. ej., projects/myproject/location/US/reservations/team1-prod La autorización requiere el siguiente permiso de Google IAM en el recurso especificado parent: bigquery.reservationAssignments.create
assignment	Assignment Recurso de asignación para crear.

CreateCapacityCommitmentMetadata

Los metadatos de la operación que se muestran desde ReservationService.CreateCapacityCommitment.

Campos
capacity_commitment	string Nombre del recurso del compromiso de capacidad que está en proceso de creación. P. ej., projects/myproject/locations/US/capacityCommitments/123

CreateReservationRequest

La solicitud para ReservationService.CreateReservation.

Campos
parent	string Proyecto, ubicación. P. ej., projects/myproject/locations/US
reservation_id	string El ID de la reserva. Este campo solo debe contener caracteres alfanuméricos o guiones.
reservation	Reservation Contenido de la reserva nueva para crear.

DeleteAssignmentRequest

La solicitud para ReservationService.DeleteAssignment. Nota: El permiso de "bigquery.reservationAssignments.delete" es obligatorio para la persona asignada relacionada.

Campos
name	string Nombre del recurso, p. ej.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 La autorización requiere el siguiente permiso de Google IAM en el recurso especificado name: bigquery.reservationAssignments.delete

DeleteCapacityCommitmentRequest

La solicitud para ReservationService.DeleteCapacityCommitment.

Campos
name	string 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	string Nombre del recurso de la reserva a recuperar. P. ej., projects/myproject/locations/US/reservations/team1-prod

GetCapacityCommitmentRequest

La solicitud para ReservationService.GetCapacityCommitment.

Campos
name	string 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	string Nombre del recurso de la reserva a recuperar. P. ej., projects/myproject/locations/US/reservations/team1-prod

ListAssignmentsRequest

La solicitud para ReservationService.ListAssignments.

Campos
parent	string El nombre del recurso superior, p. ej., projects/myproject/location/US/reservations/team1-prod o: projects/myproject/location/US/reservations/- La autorización requiere el siguiente permiso de Google IAM en el recurso especificado parent: bigquery.reservationAssignments.list
page_size	int32 La cantidad máxima de elementos por mostrar.
page_token	string El valor next_page_token que se muestra de una solicitud de lista anterior, si hubiere.

ListAssignmentsResponse

La respuesta para ReservationService.ListAssignments.

Campos
assignments[]	Assignment Lista de asignaciones visibles para el usuario.
next_page_token	string Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.

ListCapacityCommitmentsRequest

La solicitud para ReservationService.ListCapacityCommitments.

Campos
parent	string Nombre del recurso de la reserva superior. P. ej., projects/myproject/locations/US
page_size	int32 La cantidad máxima de elementos por mostrar.
page_token	string El valor next_page_token que se muestra de una solicitud de lista anterior, si hubiere.

ListCapacityCommitmentsResponse

La respuesta para ReservationService.ListCapacityCommitments.

Campos
capacity_commitments[]	CapacityCommitment Lista de compromisos de capacidad visibles para el usuario.
next_page_token	string Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.

ListReservationsRequest

La solicitud para ReservationService.ListReservations.

Campos
parent	string El nombre del recurso superior que contiene el proyecto y la ubicación, p. ej.: "projects/myproject/locations/US"
page_size	int32 La cantidad máxima de elementos por mostrar.
page_token	string El valor next_page_token que se muestra de una solicitud de lista anterior, si hubiere.
filter	string 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[]	Reservation Lista de reservas visibles para el usuario.
next_page_token	string Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.

MoveAssignmentRequest

La solicitud para ReservationService.MoveAssignment. Nota: El permiso de "bigquery.reservationAssignments.create" es obligatorio en el destination_id. Nota: El permiso de "bigquery.reservationAssignments.create" y "bigquery.reservationAssignments.delete" es obligatorio para la persona asignada relacionada.

Campos
name	string 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 Google IAM en el recurso especificado name: bigquery.reservationAssignments.delete
destination_id	string 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	string Es el nombre del recurso de la reserva, p. ej., “projects/*/locations/*/reservations/team1-prod”.
slot_capacity	int64 Ranuras máximas disponibles para esta reserva. Una ranura es una unidad de potencia de procesamiento en BigQuery y sirve como unidad de paralelismo. En el análisis de una tabla con varias particiones, una sola ranura opera en una sola partición de la tabla. 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 google.rpc.Code.RESOURCE_EXHAUSTED.
ignore_idle_slots	bool Si es verdadero, toda consulta que use esta reserva podría usar las ranuras inactivas de otras reservas dentro del mismo proyecto de administración. Si es falso, una consulta que use esta reserva se ejecutará con la capacidad de ranuras máximas como se especificó antes. Si no se especifica, el valor predeterminado es verdadero.

SearchAssignmentsRequest

La solicitud para ReservationService.SearchAssignments. Nota: El permiso de "bigquery.reservationAssignments.search" es obligatorio para la persona asignada relacionada.

Campos
parent	string El nombre del recurso del proyecto de administración (que contiene el proyecto y la ubicación), p. ej. "projects/myproject/locations/US".
query	string Especifica el nombre del recurso como persona asignada en la consulta, p. ej., "assignee=projects/myproject" "assignee=folders/123" "assignee=organizations/456"
page_size	int32 La cantidad máxima de elementos a mostrar.
page_token	string El valor next_page_token que se muestra de una solicitud de lista anterior, si hubiere.

SearchAssignmentsResponse

La respuesta para ReservationService.SearchAssignments.

Campos
assignments[]	Assignment Lista de asignaciones visibles para el usuario.
next_page_token	string Token para recuperar la página siguiente de resultados o vaciar si no hay más resultados en la lista.

UpdateReservationRequest

La solicitud para ReservationService.UpdateReservation.

Campos
reservation	Reservation Contenido de la reserva por actualizar.
update_mask	FieldMask Es la máscara de campo estándar para el conjunto de campos que se actualizará.