@google-cloud/bigquery-reservation
Version:
BigQuery Reservation client for Node.js
996 lines (995 loc) • 116 kB
JSON
{
"nested": {
"google": {
"nested": {
"cloud": {
"nested": {
"bigquery": {
"nested": {
"reservation": {
"nested": {
"v1": {
"options": {
"csharp_namespace": "Google.Cloud.BigQuery.Reservation.V1",
"go_package": "cloud.google.com/go/bigquery/reservation/apiv1/reservationpb;reservationpb",
"java_multiple_files": true,
"java_outer_classname": "ReservationProto",
"java_package": "com.google.cloud.bigquery.reservation.v1",
"php_namespace": "Google\\Cloud\\BigQuery\\Reservation\\V1"
},
"nested": {
"ReservationService": {
"options": {
"(google.api.default_host)": "bigqueryreservation.googleapis.com",
"(google.api.oauth_scopes)": "https://www.googleapis.com/auth/bigquery,https://www.googleapis.com/auth/cloud-platform"
},
"methods": {
"CreateReservation": {
"requestType": "CreateReservationRequest",
"responseType": "Reservation",
"options": {
"(google.api.http).post": "/v1/{parent=projects/*/locations/*}/reservations",
"(google.api.http).body": "reservation",
"(google.api.method_signature)": "parent,reservation,reservation_id"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*}/reservations",
"body": "reservation"
}
},
{
"(google.api.method_signature)": "parent,reservation,reservation_id"
}
]
},
"ListReservations": {
"requestType": "ListReservationsRequest",
"responseType": "ListReservationsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*}/reservations",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*}/reservations"
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"GetReservation": {
"requestType": "GetReservationRequest",
"responseType": "Reservation",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/reservations/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/reservations/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"DeleteReservation": {
"requestType": "DeleteReservationRequest",
"responseType": "google.protobuf.Empty",
"options": {
"(google.api.http).delete": "/v1/{name=projects/*/locations/*/reservations/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"delete": "/v1/{name=projects/*/locations/*/reservations/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"UpdateReservation": {
"requestType": "UpdateReservationRequest",
"responseType": "Reservation",
"options": {
"(google.api.http).patch": "/v1/{reservation.name=projects/*/locations/*/reservations/*}",
"(google.api.http).body": "reservation",
"(google.api.method_signature)": "reservation,update_mask"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v1/{reservation.name=projects/*/locations/*/reservations/*}",
"body": "reservation"
}
},
{
"(google.api.method_signature)": "reservation,update_mask"
}
]
},
"FailoverReservation": {
"requestType": "FailoverReservationRequest",
"responseType": "Reservation",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*/reservations/*}:failoverReservation",
"(google.api.http).body": "*"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*/reservations/*}:failoverReservation",
"body": "*"
}
}
]
},
"CreateCapacityCommitment": {
"requestType": "CreateCapacityCommitmentRequest",
"responseType": "CapacityCommitment",
"options": {
"(google.api.http).post": "/v1/{parent=projects/*/locations/*}/capacityCommitments",
"(google.api.http).body": "capacity_commitment",
"(google.api.method_signature)": "parent,capacity_commitment"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*}/capacityCommitments",
"body": "capacity_commitment"
}
},
{
"(google.api.method_signature)": "parent,capacity_commitment"
}
]
},
"ListCapacityCommitments": {
"requestType": "ListCapacityCommitmentsRequest",
"responseType": "ListCapacityCommitmentsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*}/capacityCommitments",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*}/capacityCommitments"
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"GetCapacityCommitment": {
"requestType": "GetCapacityCommitmentRequest",
"responseType": "CapacityCommitment",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/capacityCommitments/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/capacityCommitments/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"DeleteCapacityCommitment": {
"requestType": "DeleteCapacityCommitmentRequest",
"responseType": "google.protobuf.Empty",
"options": {
"(google.api.http).delete": "/v1/{name=projects/*/locations/*/capacityCommitments/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"delete": "/v1/{name=projects/*/locations/*/capacityCommitments/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"UpdateCapacityCommitment": {
"requestType": "UpdateCapacityCommitmentRequest",
"responseType": "CapacityCommitment",
"options": {
"(google.api.http).patch": "/v1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}",
"(google.api.http).body": "capacity_commitment",
"(google.api.method_signature)": "capacity_commitment,update_mask"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v1/{capacity_commitment.name=projects/*/locations/*/capacityCommitments/*}",
"body": "capacity_commitment"
}
},
{
"(google.api.method_signature)": "capacity_commitment,update_mask"
}
]
},
"SplitCapacityCommitment": {
"requestType": "SplitCapacityCommitmentRequest",
"responseType": "SplitCapacityCommitmentResponse",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*/capacityCommitments/*}:split",
"(google.api.http).body": "*",
"(google.api.method_signature)": "name,slot_count"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*/capacityCommitments/*}:split",
"body": "*"
}
},
{
"(google.api.method_signature)": "name,slot_count"
}
]
},
"MergeCapacityCommitments": {
"requestType": "MergeCapacityCommitmentsRequest",
"responseType": "CapacityCommitment",
"options": {
"(google.api.http).post": "/v1/{parent=projects/*/locations/*}/capacityCommitments:merge",
"(google.api.http).body": "*",
"(google.api.method_signature)": "parent,capacity_commitment_ids"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*}/capacityCommitments:merge",
"body": "*"
}
},
{
"(google.api.method_signature)": "parent,capacity_commitment_ids"
}
]
},
"CreateAssignment": {
"requestType": "CreateAssignmentRequest",
"responseType": "Assignment",
"options": {
"(google.api.http).post": "/v1/{parent=projects/*/locations/*/reservations/*}/assignments",
"(google.api.http).body": "assignment",
"(google.api.method_signature)": "parent,assignment"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{parent=projects/*/locations/*/reservations/*}/assignments",
"body": "assignment"
}
},
{
"(google.api.method_signature)": "parent,assignment"
}
]
},
"ListAssignments": {
"requestType": "ListAssignmentsRequest",
"responseType": "ListAssignmentsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*/reservations/*}/assignments",
"(google.api.method_signature)": "parent"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*/reservations/*}/assignments"
}
},
{
"(google.api.method_signature)": "parent"
}
]
},
"DeleteAssignment": {
"requestType": "DeleteAssignmentRequest",
"responseType": "google.protobuf.Empty",
"options": {
"(google.api.http).delete": "/v1/{name=projects/*/locations/*/reservations/*/assignments/*}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"delete": "/v1/{name=projects/*/locations/*/reservations/*/assignments/*}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"SearchAssignments": {
"requestType": "SearchAssignmentsRequest",
"responseType": "SearchAssignmentsResponse",
"options": {
"deprecated": true,
"(google.api.http).get": "/v1/{parent=projects/*/locations/*}:searchAssignments",
"(google.api.method_signature)": "parent,query"
},
"parsedOptions": [
{
"deprecated": true
},
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*}:searchAssignments"
}
},
{
"(google.api.method_signature)": "parent,query"
}
]
},
"SearchAllAssignments": {
"requestType": "SearchAllAssignmentsRequest",
"responseType": "SearchAllAssignmentsResponse",
"options": {
"(google.api.http).get": "/v1/{parent=projects/*/locations/*}:searchAllAssignments",
"(google.api.method_signature)": "parent,query"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{parent=projects/*/locations/*}:searchAllAssignments"
}
},
{
"(google.api.method_signature)": "parent,query"
}
]
},
"MoveAssignment": {
"requestType": "MoveAssignmentRequest",
"responseType": "Assignment",
"options": {
"(google.api.http).post": "/v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move",
"(google.api.http).body": "*",
"(google.api.method_signature)": "name,destination_id"
},
"parsedOptions": [
{
"(google.api.http)": {
"post": "/v1/{name=projects/*/locations/*/reservations/*/assignments/*}:move",
"body": "*"
}
},
{
"(google.api.method_signature)": "name,destination_id"
}
]
},
"UpdateAssignment": {
"requestType": "UpdateAssignmentRequest",
"responseType": "Assignment",
"options": {
"(google.api.http).patch": "/v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}",
"(google.api.http).body": "assignment",
"(google.api.method_signature)": "assignment,update_mask"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v1/{assignment.name=projects/*/locations/*/reservations/*/assignments/*}",
"body": "assignment"
}
},
{
"(google.api.method_signature)": "assignment,update_mask"
}
]
},
"GetBiReservation": {
"requestType": "GetBiReservationRequest",
"responseType": "BiReservation",
"options": {
"(google.api.http).get": "/v1/{name=projects/*/locations/*/biReservation}",
"(google.api.method_signature)": "name"
},
"parsedOptions": [
{
"(google.api.http)": {
"get": "/v1/{name=projects/*/locations/*/biReservation}"
}
},
{
"(google.api.method_signature)": "name"
}
]
},
"UpdateBiReservation": {
"requestType": "UpdateBiReservationRequest",
"responseType": "BiReservation",
"options": {
"(google.api.http).patch": "/v1/{bi_reservation.name=projects/*/locations/*/biReservation}",
"(google.api.http).body": "bi_reservation",
"(google.api.method_signature)": "bi_reservation,update_mask"
},
"parsedOptions": [
{
"(google.api.http)": {
"patch": "/v1/{bi_reservation.name=projects/*/locations/*/biReservation}",
"body": "bi_reservation"
}
},
{
"(google.api.method_signature)": "bi_reservation,update_mask"
}
]
}
}
},
"Reservation": {
"options": {
"(google.api.resource).type": "bigqueryreservation.googleapis.com/Reservation",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/reservations/{reservation}"
},
"fields": {
"name": {
"type": "string",
"id": 1
},
"slotCapacity": {
"type": "int64",
"id": 2
},
"ignoreIdleSlots": {
"type": "bool",
"id": 4
},
"autoscale": {
"type": "Autoscale",
"id": 7
},
"concurrency": {
"type": "int64",
"id": 16
},
"creationTime": {
"type": "google.protobuf.Timestamp",
"id": 8,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"updateTime": {
"type": "google.protobuf.Timestamp",
"id": 9,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"multiRegionAuxiliary": {
"type": "bool",
"id": 14
},
"edition": {
"type": "Edition",
"id": 17
},
"primaryLocation": {
"type": "string",
"id": 18,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"(google.api.resource_reference).type": "locations.googleapis.com/Location"
}
},
"secondaryLocation": {
"type": "string",
"id": 19,
"options": {
"(google.api.field_behavior)": "OPTIONAL",
"(google.api.resource_reference).type": "locations.googleapis.com/Location"
}
},
"originalPrimaryLocation": {
"type": "string",
"id": 20,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY",
"(google.api.resource_reference).type": "locations.googleapis.com/Location"
}
},
"replicationStatus": {
"type": "ReplicationStatus",
"id": 24,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
},
"nested": {
"Autoscale": {
"fields": {
"currentSlots": {
"type": "int64",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"maxSlots": {
"type": "int64",
"id": 2
}
}
},
"ReplicationStatus": {
"fields": {
"error": {
"type": "google.rpc.Status",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"lastErrorTime": {
"type": "google.protobuf.Timestamp",
"id": 2,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"lastReplicationTime": {
"type": "google.protobuf.Timestamp",
"id": 3,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
}
}
}
},
"CapacityCommitment": {
"options": {
"(google.api.resource).type": "bigqueryreservation.googleapis.com/CapacityCommitment",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}"
},
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"slotCount": {
"type": "int64",
"id": 2
},
"plan": {
"type": "CommitmentPlan",
"id": 3
},
"state": {
"type": "State",
"id": 4,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"commitmentStartTime": {
"type": "google.protobuf.Timestamp",
"id": 9,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"commitmentEndTime": {
"type": "google.protobuf.Timestamp",
"id": 5,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"failureStatus": {
"type": "google.rpc.Status",
"id": 7,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"renewalPlan": {
"type": "CommitmentPlan",
"id": 8
},
"multiRegionAuxiliary": {
"type": "bool",
"id": 10
},
"edition": {
"type": "Edition",
"id": 12
},
"isFlatRate": {
"type": "bool",
"id": 14,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
}
},
"nested": {
"CommitmentPlan": {
"valuesOptions": {
"FLEX_FLAT_RATE": {
"deprecated": true
},
"TRIAL": {
"deprecated": true
},
"MONTHLY_FLAT_RATE": {
"deprecated": true
},
"ANNUAL_FLAT_RATE": {
"deprecated": true
}
},
"values": {
"COMMITMENT_PLAN_UNSPECIFIED": 0,
"FLEX": 3,
"FLEX_FLAT_RATE": 7,
"TRIAL": 5,
"MONTHLY": 2,
"MONTHLY_FLAT_RATE": 8,
"ANNUAL": 4,
"ANNUAL_FLAT_RATE": 9,
"THREE_YEAR": 10,
"NONE": 6
}
},
"State": {
"values": {
"STATE_UNSPECIFIED": 0,
"PENDING": 1,
"ACTIVE": 2,
"FAILED": 3
}
}
}
},
"CreateReservationRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigqueryreservation.googleapis.com/Reservation"
}
},
"reservationId": {
"type": "string",
"id": 2
},
"reservation": {
"type": "Reservation",
"id": 3
}
}
},
"ListReservationsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigqueryreservation.googleapis.com/Reservation"
}
},
"pageSize": {
"type": "int32",
"id": 2
},
"pageToken": {
"type": "string",
"id": 3
}
}
},
"ListReservationsResponse": {
"fields": {
"reservations": {
"rule": "repeated",
"type": "Reservation",
"id": 1
},
"nextPageToken": {
"type": "string",
"id": 2
}
}
},
"GetReservationRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigqueryreservation.googleapis.com/Reservation"
}
}
}
},
"DeleteReservationRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigqueryreservation.googleapis.com/Reservation"
}
}
}
},
"UpdateReservationRequest": {
"fields": {
"reservation": {
"type": "Reservation",
"id": 1
},
"updateMask": {
"type": "google.protobuf.FieldMask",
"id": 2
}
}
},
"FailoverReservationRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigqueryreservation.googleapis.com/Reservation"
}
}
}
},
"CreateCapacityCommitmentRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigqueryreservation.googleapis.com/CapacityCommitment"
}
},
"capacityCommitment": {
"type": "CapacityCommitment",
"id": 2
},
"enforceSingleAdminProjectPerOrg": {
"type": "bool",
"id": 4
},
"capacityCommitmentId": {
"type": "string",
"id": 5
}
}
},
"ListCapacityCommitmentsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigqueryreservation.googleapis.com/CapacityCommitment"
}
},
"pageSize": {
"type": "int32",
"id": 2
},
"pageToken": {
"type": "string",
"id": 3
}
}
},
"ListCapacityCommitmentsResponse": {
"fields": {
"capacityCommitments": {
"rule": "repeated",
"type": "CapacityCommitment",
"id": 1
},
"nextPageToken": {
"type": "string",
"id": 2
}
}
},
"GetCapacityCommitmentRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigqueryreservation.googleapis.com/CapacityCommitment"
}
}
}
},
"DeleteCapacityCommitmentRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigqueryreservation.googleapis.com/CapacityCommitment"
}
},
"force": {
"type": "bool",
"id": 3
}
}
},
"UpdateCapacityCommitmentRequest": {
"fields": {
"capacityCommitment": {
"type": "CapacityCommitment",
"id": 1
},
"updateMask": {
"type": "google.protobuf.FieldMask",
"id": 2
}
}
},
"SplitCapacityCommitmentRequest": {
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).type": "bigqueryreservation.googleapis.com/CapacityCommitment"
}
},
"slotCount": {
"type": "int64",
"id": 2
}
}
},
"SplitCapacityCommitmentResponse": {
"fields": {
"first": {
"type": "CapacityCommitment",
"id": 1
},
"second": {
"type": "CapacityCommitment",
"id": 2
}
}
},
"MergeCapacityCommitmentsRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.resource_reference).child_type": "bigqueryreservation.googleapis.com/CapacityCommitment"
}
},
"capacityCommitmentIds": {
"rule": "repeated",
"type": "string",
"id": 2
}
}
},
"Assignment": {
"options": {
"(google.api.resource).type": "bigqueryreservation.googleapis.com/Assignment",
"(google.api.resource).pattern": "projects/{project}/locations/{location}/reservations/{reservation}/assignments/{assignment}",
"(google.api.resource).plural": "assignments",
"(google.api.resource).singular": "assignment"
},
"fields": {
"name": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"assignee": {
"type": "string",
"id": 4
},
"jobType": {
"type": "JobType",
"id": 3
},
"state": {
"type": "State",
"id": 6,
"options": {
"(google.api.field_behavior)": "OUTPUT_ONLY"
}
},
"enableGeminiInBigquery": {
"type": "bool",
"id": 10,
"options": {
"(google.api.field_behavior)": "OPTIONAL"
}
}
},
"nested": {
"JobType": {
"values": {
"JOB_TYPE_UNSPECIFIED": 0,
"PIPELINE": 1,
"QUERY": 2,
"ML_EXTERNAL": 3,
"BACKGROUND": 4,
"CONTINUOUS": 6
}
},
"State": {
"values": {
"STATE_UNSPECIFIED": 0,
"PENDING": 1,
"ACTIVE": 2
}
}
}
},
"CreateAssignmentRequest": {
"fields": {
"parent": {
"type": "string",
"id": 1,
"options": {
"(google.api.field_behavior)": "REQUIRED",
"(google.api.resource_reference).child_type": "bigqueryreservation.googleapis.com/Assignment"
}
},
"assignment": {
"type": "Assignment",
"id": 2
},
"assignmentId": {
"type": "string",
"id": 4
}