{ "uuid": "9f8c76e9-9d0d-452c-a656-b6e10c921bd2", "lastMigration": 29, "name": "BigQuery Reservation API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "9e652cc3-436c-4b28-9761-6255c94b77dc", "documentation": "Deletes a assignment. No expansion will happen. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, deletion of the `` assignment won't affect the other assignment ``. After said deletion, queries from `project1` will still use `res1` while queries from `project2` will switch to use on-demand mode.", "method": "delete", "endpoint": "v1/:name", "responses": [ { "uuid": "78ce0662-9687-4ad6-825d-26a051ba9b35", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b5ed3a2c-599b-40c7-a388-046c603227d5", "documentation": "Returns information about the reservation.", "method": "get", "endpoint": "v1/:name", "responses": [ { "uuid": "a5dbfa0b-888c-4b7c-ab4a-74299ca40a1e", "body": "{\n \"concurrency\": \"\",\n \"creationTime\": \"\",\n \"ignoreIdleSlots\": {{faker 'datatype.boolean'}},\n \"multiRegionAuxiliary\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"slotCapacity\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0c94194f-c550-4988-9b9b-b7d78195f7f1", "documentation": "Updates an existing assignment. Only the `priority` field can be updated.", "method": "patch", "endpoint": "v1/:name", "responses": [ { "uuid": "1ca043c1-82ab-4482-a6c9-effbdfbf880c", "body": "{\n \"assignee\": \"\",\n \"jobType\": \"{{oneOf (array 'JOB_TYPE_UNSPECIFIED' 'PIPELINE' 'QUERY' 'ML_EXTERNAL' 'BACKGROUND')}}\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f89e6c30-08a4-457a-9d52-ab565c5ee749", "documentation": "Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.", "method": "post", "endpoint": "v1/:name:move", "responses": [ { "uuid": "a6968c0a-bfcd-4404-b08e-c6b0db140404", "body": "{\n \"assignee\": \"\",\n \"jobType\": \"{{oneOf (array 'JOB_TYPE_UNSPECIFIED' 'PIPELINE' 'QUERY' 'ML_EXTERNAL' 'BACKGROUND')}}\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ed073243-5476-46db-b32b-f532cd418d0c", "documentation": "Splits capacity commitment to two commitments of the same plan and `commitment_end_time`. A common use case is to enable downgrading commitments. For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.", "method": "post", "endpoint": "v1/:name:split", "responses": [ { "uuid": "85fae296-aba9-43fd-a3d7-ffb179affc2a", "body": "{\n \"first\": {\n \"commitmentEndTime\": \"\",\n \"commitmentStartTime\": \"\",\n \"failureStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"multiRegionAuxiliary\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"plan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"renewalPlan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"slotCount\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE' 'FAILED')}}\"\n },\n \"second\": {\n \"commitmentEndTime\": \"\",\n \"commitmentStartTime\": \"\",\n \"failureStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"multiRegionAuxiliary\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"plan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"renewalPlan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"slotCount\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE' 'FAILED')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bff52bc6-e158-4942-8f87-cd9605ff2490", "documentation": "Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following associations between entities and reservations: `` and `` In this example, ListAssignments will just return the above two assignments for reservation `res1`, and no expansion/merge will happen. The wildcard \"-\" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed. **Note** \"-\" cannot be used for projects nor locations.", "method": "get", "endpoint": "v1/:parent/assignments", "responses": [ { "uuid": "db3e3227-eb85-46df-a64b-32207fca56af", "body": "{\n \"assignments\": [\n {\n \"assignee\": \"\",\n \"jobType\": \"{{oneOf (array 'JOB_TYPE_UNSPECIFIED' 'PIPELINE' 'QUERY' 'ML_EXTERNAL' 'BACKGROUND')}}\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d9a4ed8a-9fe5-434c-a6ca-689edf654e5d", "documentation": "Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type. Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query. When creating assignments, it does not matter if other assignments exist at higher levels. Example: * The organization `organizationA` contains two projects, `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and `project2`) could all be created and mapped to the same or different reservations. \"None\" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a \"None\" assignment, use \"none\" as a reservation_id in the parent. Example parent: `projects/myproject/locations/US/reservations/none`. Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation. Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the reservation.", "method": "post", "endpoint": "v1/:parent/assignments", "responses": [ { "uuid": "a2fcf6b8-7e96-4bb7-8b5f-187dbd974a22", "body": "{\n \"assignee\": \"\",\n \"jobType\": \"{{oneOf (array 'JOB_TYPE_UNSPECIFIED' 'PIPELINE' 'QUERY' 'ML_EXTERNAL' 'BACKGROUND')}}\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3762778a-f2d1-4081-a0de-162a46cf84e2", "documentation": "Lists all the capacity commitments for the admin project.", "method": "get", "endpoint": "v1/:parent/capacityCommitments", "responses": [ { "uuid": "dcba0721-c7ea-41ad-bb78-dd829bcd3217", "body": "{\n \"capacityCommitments\": [\n {\n \"commitmentEndTime\": \"\",\n \"commitmentStartTime\": \"\",\n \"failureStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"multiRegionAuxiliary\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"plan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"renewalPlan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"slotCount\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE' 'FAILED')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3e977880-2c3a-460f-a9ac-bb7d28080d4d", "documentation": "Creates a new capacity commitment resource.", "method": "post", "endpoint": "v1/:parent/capacityCommitments", "responses": [ { "uuid": "96962814-4c47-41c2-a571-146b1c8b4ae0", "body": "{\n \"commitmentEndTime\": \"\",\n \"commitmentStartTime\": \"\",\n \"failureStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"multiRegionAuxiliary\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"plan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"renewalPlan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"slotCount\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE' 'FAILED')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "30e5d2ea-576a-4f7b-84df-75a7e2415661", "documentation": "Merges capacity commitments of the same plan into a single commitment. The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments. Attempting to merge capacity commitments of different plan will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.", "method": "post", "endpoint": "v1/:parent/capacityCommitments:merge", "responses": [ { "uuid": "970ecb8a-2288-4d53-91d9-270705b4ef22", "body": "{\n \"commitmentEndTime\": \"\",\n \"commitmentStartTime\": \"\",\n \"failureStatus\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"multiRegionAuxiliary\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"plan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"renewalPlan\": \"{{oneOf (array 'COMMITMENT_PLAN_UNSPECIFIED' 'FLEX' 'TRIAL' 'MONTHLY' 'ANNUAL')}}\",\n \"slotCount\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE' 'FAILED')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "40b16b91-c558-41e3-95ad-5edea3c161ab", "documentation": "Lists all the reservations for the project in the specified location.", "method": "get", "endpoint": "v1/:parent/reservations", "responses": [ { "uuid": "924869cb-8838-4df8-9043-72508166298f", "body": "{\n \"nextPageToken\": \"\",\n \"reservations\": [\n {\n \"concurrency\": \"\",\n \"creationTime\": \"\",\n \"ignoreIdleSlots\": {{faker 'datatype.boolean'}},\n \"multiRegionAuxiliary\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"slotCapacity\": \"\",\n \"updateTime\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f6bc9b65-91d6-4460-aa10-51ca5857e997", "documentation": "Creates a new reservation resource.", "method": "post", "endpoint": "v1/:parent/reservations", "responses": [ { "uuid": "598dd773-2425-4e85-a66e-62c6033188cf", "body": "{\n \"concurrency\": \"\",\n \"creationTime\": \"\",\n \"ignoreIdleSlots\": {{faker 'datatype.boolean'}},\n \"multiRegionAuxiliary\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"slotCapacity\": \"\",\n \"updateTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "131e55dd-3913-4d8a-aad7-a39f68b8d142", "documentation": "Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`.", "method": "get", "endpoint": "v1/:parent:searchAllAssignments", "responses": [ { "uuid": "4743c287-c748-4182-b0ab-9809f3419b59", "body": "{\n \"assignments\": [\n {\n \"assignee\": \"\",\n \"jobType\": \"{{oneOf (array 'JOB_TYPE_UNSPECIFIED' 'PIPELINE' 'QUERY' 'ML_EXTERNAL' 'BACKGROUND')}}\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4b929679-16de-4f2e-bf97-e11c92f77083", "documentation": "Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup (project->folder->organization) happens in this API. 3. Parent here is `projects/*/locations/*`, instead of `projects/*/locations/*reservations/*`. **Note** \"-\" cannot be used for projects nor locations.", "method": "get", "endpoint": "v1/:parent:searchAssignments", "responses": [ { "uuid": "5217f5ab-dd6e-4ad8-b6d5-c3f359de1b93", "body": "{\n \"assignments\": [\n {\n \"assignee\": \"\",\n \"jobType\": \"{{oneOf (array 'JOB_TYPE_UNSPECIFIED' 'PIPELINE' 'QUERY' 'ML_EXTERNAL' 'BACKGROUND')}}\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'PENDING' 'ACTIVE')}}\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "9e652cc3-436c-4b28-9761-6255c94b77dc" }, { "type": "route", "uuid": "b5ed3a2c-599b-40c7-a388-046c603227d5" }, { "type": "route", "uuid": "0c94194f-c550-4988-9b9b-b7d78195f7f1" }, { "type": "route", "uuid": "f89e6c30-08a4-457a-9d52-ab565c5ee749" }, { "type": "route", "uuid": "ed073243-5476-46db-b32b-f532cd418d0c" }, { "type": "route", "uuid": "bff52bc6-e158-4942-8f87-cd9605ff2490" }, { "type": "route", "uuid": "d9a4ed8a-9fe5-434c-a6ca-689edf654e5d" }, { "type": "route", "uuid": "3762778a-f2d1-4081-a0de-162a46cf84e2" }, { "type": "route", "uuid": "3e977880-2c3a-460f-a9ac-bb7d28080d4d" }, { "type": "route", "uuid": "30e5d2ea-576a-4f7b-84df-75a7e2415661" }, { "type": "route", "uuid": "40b16b91-c558-41e3-95ad-5edea3c161ab" }, { "type": "route", "uuid": "f6bc9b65-91d6-4460-aa10-51ca5857e997" }, { "type": "route", "uuid": "131e55dd-3913-4d8a-aad7-a39f68b8d142" }, { "type": "route", "uuid": "4b929679-16de-4f2e-bf97-e11c92f77083" } ] }