| // This is a generated file (see the discoveryapis_generator project). |
| |
| // ignore_for_file: camel_case_types |
| // ignore_for_file: comment_references |
| // ignore_for_file: directives_ordering |
| // ignore_for_file: file_names |
| // ignore_for_file: library_names |
| // ignore_for_file: lines_longer_than_80_chars |
| // ignore_for_file: non_constant_identifier_names |
| // ignore_for_file: prefer_expression_function_bodies |
| // ignore_for_file: prefer_final_locals |
| // ignore_for_file: prefer_interpolation_to_compose_strings |
| // ignore_for_file: unnecessary_brace_in_string_interps |
| // ignore_for_file: unnecessary_cast |
| // ignore_for_file: unnecessary_lambdas |
| // ignore_for_file: unnecessary_parenthesis |
| // ignore_for_file: unnecessary_string_interpolations |
| |
| library googleapis.bigqueryreservation.v1; |
| |
| import 'dart:core' as core; |
| import 'dart:async' as async; |
| import 'dart:convert' as convert; |
| |
| import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
| import 'package:http/http.dart' as http; |
| |
| export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' |
| show ApiRequestError, DetailedApiRequestError; |
| |
| const userAgent = 'dart-api-client bigqueryreservation/v1'; |
| |
| /// A service to modify your BigQuery flat-rate reservations. |
| class BigqueryreservationApi { |
| /// View and manage your data in Google BigQuery |
| static const bigqueryScope = 'https://www.googleapis.com/auth/bigquery'; |
| |
| /// View and manage your data across Google Cloud Platform services |
| static const cloudPlatformScope = |
| 'https://www.googleapis.com/auth/cloud-platform'; |
| |
| final commons.ApiRequester _requester; |
| |
| OperationsResourceApi get operations => OperationsResourceApi(_requester); |
| ProjectsResourceApi get projects => ProjectsResourceApi(_requester); |
| |
| BigqueryreservationApi(http.Client client, |
| {core.String rootUrl = 'https://bigqueryreservation.googleapis.com/', |
| core.String servicePath = ''}) |
| : _requester = |
| commons.ApiRequester(client, rootUrl, servicePath, userAgent); |
| } |
| |
| class OperationsResourceApi { |
| final commons.ApiRequester _requester; |
| |
| OperationsResourceApi(commons.ApiRequester client) : _requester = client; |
| |
| /// Deletes a long-running operation. This method indicates that the client is |
| /// no longer interested in the operation result. It does not cancel the |
| /// operation. If the server doesn't support this method, it returns |
| /// `google.rpc.Code.UNIMPLEMENTED`. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The name of the operation resource to be deleted. |
| /// Value must have pattern "^operations/.*$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Empty> delete( |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'DELETE', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Empty.fromJson(data)); |
| } |
| |
| /// Lists operations that match the specified filter in the request. If the |
| /// server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the |
| /// `name` binding allows API services to override the binding to use |
| /// different resource name schemes, such as `users / * /operations`. To |
| /// override the binding, API services can add a binding such as |
| /// `"/v1/{name=users / * }/operations"` to their service configuration. For |
| /// backwards compatibility, the default name includes the operations |
| /// collection id, however overriding users must ensure the name binding is |
| /// the parent resource, without the operations collection id. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The name of the operation's parent resource. |
| /// Value must have pattern "^operations$". |
| /// |
| /// [filter] - The standard list filter. |
| /// |
| /// [pageSize] - The standard list page size. |
| /// |
| /// [pageToken] - The standard list page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListOperationsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<ListOperationsResponse> list( |
| core.String name, { |
| core.String filter, |
| core.int pageSize, |
| core.String pageToken, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if (filter != null) { |
| _queryParams['filter'] = [filter]; |
| } |
| if (pageSize != null) { |
| _queryParams['pageSize'] = ['${pageSize}']; |
| } |
| if (pageToken != null) { |
| _queryParams['pageToken'] = [pageToken]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => ListOperationsResponse.fromJson(data)); |
| } |
| } |
| |
| class ProjectsResourceApi { |
| final commons.ApiRequester _requester; |
| |
| ProjectsLocationsResourceApi get locations => |
| ProjectsLocationsResourceApi(_requester); |
| |
| ProjectsResourceApi(commons.ApiRequester client) : _requester = client; |
| } |
| |
| class ProjectsLocationsResourceApi { |
| final commons.ApiRequester _requester; |
| |
| ProjectsLocationsCapacityCommitmentsResourceApi get capacityCommitments => |
| ProjectsLocationsCapacityCommitmentsResourceApi(_requester); |
| ProjectsLocationsReservationsResourceApi get reservations => |
| ProjectsLocationsReservationsResourceApi(_requester); |
| |
| ProjectsLocationsResourceApi(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Retrieves a BI reservation. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Name of the requested reservation, for example: |
| /// `projects/{project_id}/locations/{location_id}/bireservation` |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+/biReservation$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [BiReservation]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<BiReservation> getBiReservation( |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => BiReservation.fromJson(data)); |
| } |
| |
| /// 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 / * `. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The resource name with location (project name could |
| /// be the wildcard '-'), e.g.: `projects/-/locations/US`. |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+$". |
| /// |
| /// [pageSize] - The maximum number of items to return per page. |
| /// |
| /// [pageToken] - The next_page_token value returned from a previous List |
| /// request, if any. |
| /// |
| /// [query] - Please specify resource name as assignee in the query. Examples: |
| /// * `assignee=projects/myproject` * `assignee=folders/123` * |
| /// `assignee=organizations/456` |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [SearchAllAssignmentsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<SearchAllAssignmentsResponse> searchAllAssignments( |
| core.String parent, { |
| core.int pageSize, |
| core.String pageToken, |
| core.String query, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (pageSize != null) { |
| _queryParams['pageSize'] = ['${pageSize}']; |
| } |
| if (pageToken != null) { |
| _queryParams['pageToken'] = [pageToken]; |
| } |
| if (query != null) { |
| _queryParams['query'] = [query]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| ':searchAllAssignments'; |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response |
| .then((data) => SearchAllAssignmentsResponse.fromJson(data)); |
| } |
| |
| /// 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. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The resource name of the admin project(containing |
| /// project and location), e.g.: `projects/myproject/locations/US`. |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+$". |
| /// |
| /// [pageSize] - The maximum number of items to return per page. |
| /// |
| /// [pageToken] - The next_page_token value returned from a previous List |
| /// request, if any. |
| /// |
| /// [query] - Please specify resource name as assignee in the query. Examples: |
| /// * `assignee=projects/myproject` * `assignee=folders/123` * |
| /// `assignee=organizations/456` |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [SearchAssignmentsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<SearchAssignmentsResponse> searchAssignments( |
| core.String parent, { |
| core.int pageSize, |
| core.String pageToken, |
| core.String query, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (pageSize != null) { |
| _queryParams['pageSize'] = ['${pageSize}']; |
| } |
| if (pageToken != null) { |
| _queryParams['pageToken'] = [pageToken]; |
| } |
| if (query != null) { |
| _queryParams['query'] = [query]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| ':searchAssignments'; |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => SearchAssignmentsResponse.fromJson(data)); |
| } |
| |
| /// Updates a BI reservation. Only fields specified in the `field_mask` are |
| /// updated. A singleton BI reservation always exists with default size 0. In |
| /// order to reserve BI capacity it needs to be updated to an amount greater |
| /// than 0. In order to release BI capacity reservation size must be set to 0. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The resource name of the singleton BI reservation. Reservation |
| /// names have the form |
| /// `projects/{project_id}/locations/{location_id}/bireservation`. |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+/biReservation$". |
| /// |
| /// [updateMask] - A list of fields to be updated in this request. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [BiReservation]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<BiReservation> updateBiReservation( |
| BiReservation request, |
| core.String name, { |
| core.String updateMask, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if (updateMask != null) { |
| _queryParams['updateMask'] = [updateMask]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'PATCH', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => BiReservation.fromJson(data)); |
| } |
| } |
| |
| class ProjectsLocationsCapacityCommitmentsResourceApi { |
| final commons.ApiRequester _requester; |
| |
| ProjectsLocationsCapacityCommitmentsResourceApi(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates a new capacity commitment resource. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name of the parent reservation. E.g., |
| /// `projects/myproject/locations/US` |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+$". |
| /// |
| /// [enforceSingleAdminProjectPerOrg] - If true, fail the request if another |
| /// project in the organization has a capacity commitment. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [CapacityCommitment]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<CapacityCommitment> create( |
| CapacityCommitment request, |
| core.String parent, { |
| core.bool enforceSingleAdminProjectPerOrg, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (enforceSingleAdminProjectPerOrg != null) { |
| _queryParams['enforceSingleAdminProjectPerOrg'] = [ |
| '${enforceSingleAdminProjectPerOrg}' |
| ]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/capacityCommitments'; |
| |
| final _response = _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => CapacityCommitment.fromJson(data)); |
| } |
| |
| /// Deletes a capacity commitment. Attempting to delete capacity commitment |
| /// before its commitment_end_time will fail with the error code |
| /// `google.rpc.Code.FAILED_PRECONDITION`. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name of the capacity commitment to delete. |
| /// E.g., `projects/myproject/locations/US/capacityCommitments/123` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Empty> delete( |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'DELETE', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Empty.fromJson(data)); |
| } |
| |
| /// Returns information about the capacity commitment. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name of the capacity commitment to retrieve. |
| /// E.g., `projects/myproject/locations/US/capacityCommitments/123` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [CapacityCommitment]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<CapacityCommitment> get( |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => CapacityCommitment.fromJson(data)); |
| } |
| |
| /// Lists all the capacity commitments for the admin project. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Resource name of the parent reservation. E.g., |
| /// `projects/myproject/locations/US` |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+$". |
| /// |
| /// [pageSize] - The maximum number of items to return. |
| /// |
| /// [pageToken] - The next_page_token value returned from a previous List |
| /// request, if any. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListCapacityCommitmentsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<ListCapacityCommitmentsResponse> list( |
| core.String parent, { |
| core.int pageSize, |
| core.String pageToken, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (pageSize != null) { |
| _queryParams['pageSize'] = ['${pageSize}']; |
| } |
| if (pageToken != null) { |
| _queryParams['pageToken'] = [pageToken]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/capacityCommitments'; |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response |
| .then((data) => ListCapacityCommitmentsResponse.fromJson(data)); |
| } |
| |
| /// 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`. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Parent resource that identifies admin project and location |
| /// e.g., `projects/myproject/locations/us` |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [CapacityCommitment]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<CapacityCommitment> merge( |
| MergeCapacityCommitmentsRequest request, |
| core.String parent, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/capacityCommitments:merge'; |
| |
| final _response = _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => CapacityCommitment.fromJson(data)); |
| } |
| |
| /// Updates an existing capacity commitment. Only `plan` and `renewal_plan` |
| /// fields can be updated. Plan can only be changed to a plan of a longer |
| /// commitment period. Attempting to change to a plan with shorter commitment |
| /// period will fail with the error code |
| /// `google.rpc.Code.FAILED_PRECONDITION`. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Output only. The resource name of the capacity commitment, e.g., |
| /// `projects/myproject/locations/US/capacityCommitments/123` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$". |
| /// |
| /// [updateMask] - Standard field mask for the set of fields to be updated. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [CapacityCommitment]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<CapacityCommitment> patch( |
| CapacityCommitment request, |
| core.String name, { |
| core.String updateMask, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if (updateMask != null) { |
| _queryParams['updateMask'] = [updateMask]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'PATCH', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => CapacityCommitment.fromJson(data)); |
| } |
| |
| /// 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 would change the plan of the first one to `FLEX` and then |
| /// delete it. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The resource name e.g.,: |
| /// `projects/myproject/locations/US/capacityCommitments/123` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/capacityCommitments/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [SplitCapacityCommitmentResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<SplitCapacityCommitmentResponse> split( |
| SplitCapacityCommitmentRequest request, |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':split'; |
| |
| final _response = _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response |
| .then((data) => SplitCapacityCommitmentResponse.fromJson(data)); |
| } |
| } |
| |
| class ProjectsLocationsReservationsResourceApi { |
| final commons.ApiRequester _requester; |
| |
| ProjectsLocationsReservationsAssignmentsResourceApi get assignments => |
| ProjectsLocationsReservationsAssignmentsResourceApi(_requester); |
| |
| ProjectsLocationsReservationsResourceApi(commons.ApiRequester client) |
| : _requester = client; |
| |
| /// Creates a new reservation resource. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. Project, location. E.g., |
| /// `projects/myproject/locations/US` |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+$". |
| /// |
| /// [reservationId] - The reservation ID. This field must only contain lower |
| /// case alphanumeric characters or dash. Max length is 64 characters. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Reservation]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Reservation> create( |
| Reservation request, |
| core.String parent, { |
| core.String reservationId, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (reservationId != null) { |
| _queryParams['reservationId'] = [reservationId]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/reservations'; |
| |
| final _response = _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Reservation.fromJson(data)); |
| } |
| |
| /// Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when |
| /// reservation has assignments. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name of the reservation to retrieve. E.g., |
| /// `projects/myproject/locations/US/reservations/team1-prod` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Empty> delete( |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'DELETE', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Empty.fromJson(data)); |
| } |
| |
| /// Returns information about the reservation. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Resource name of the reservation to retrieve. E.g., |
| /// `projects/myproject/locations/US/reservations/team1-prod` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Reservation]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Reservation> get( |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Reservation.fromJson(data)); |
| } |
| |
| /// Lists all the reservations for the project in the specified location. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The parent resource name containing project and |
| /// location, e.g.: `projects/myproject/locations/US` |
| /// Value must have pattern "^projects/[^/]+/locations/[^/]+$". |
| /// |
| /// [pageSize] - The maximum number of items to return per page. |
| /// |
| /// [pageToken] - The next_page_token value returned from a previous List |
| /// request, if any. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListReservationsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<ListReservationsResponse> list( |
| core.String parent, { |
| core.int pageSize, |
| core.String pageToken, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (pageSize != null) { |
| _queryParams['pageSize'] = ['${pageSize}']; |
| } |
| if (pageToken != null) { |
| _queryParams['pageToken'] = [pageToken]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/reservations'; |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => ListReservationsResponse.fromJson(data)); |
| } |
| |
| /// Updates an existing reservation resource. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The resource name of the reservation, e.g., `projects / * |
| /// /locations / * /reservations/team1-prod`. |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$". |
| /// |
| /// [updateMask] - Standard field mask for the set of fields to be updated. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Reservation]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Reservation> patch( |
| Reservation request, |
| core.String name, { |
| core.String updateMask, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if (updateMask != null) { |
| _queryParams['updateMask'] = [updateMask]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'PATCH', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Reservation.fromJson(data)); |
| } |
| } |
| |
| class ProjectsLocationsReservationsAssignmentsResourceApi { |
| final commons.ApiRequester _requester; |
| |
| ProjectsLocationsReservationsAssignmentsResourceApi( |
| commons.ApiRequester client) |
| : _requester = client; |
| |
| /// 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. 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. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The parent resource name of the assignment E.g. |
| /// `projects/myproject/locations/US/reservations/team1-prod` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Assignment]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Assignment> create( |
| Assignment request, |
| core.String parent, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/assignments'; |
| |
| final _response = _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Assignment.fromJson(data)); |
| } |
| |
| /// 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. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. Name of the resource, e.g. |
| /// `projects/myproject/locations/US/reservations/team1-prod/assignments/123` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Empty> delete( |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = _requester.request( |
| _url, |
| 'DELETE', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Empty.fromJson(data)); |
| } |
| |
| /// 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. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Required. The parent resource name e.g.: |
| /// `projects/myproject/locations/US/reservations/team1-prod` Or: |
| /// `projects/myproject/locations/US/reservations/-` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/reservations/[^/]+$". |
| /// |
| /// [pageSize] - The maximum number of items to return per page. |
| /// |
| /// [pageToken] - The next_page_token value returned from a previous List |
| /// request, if any. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListAssignmentsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<ListAssignmentsResponse> list( |
| core.String parent, { |
| core.int pageSize, |
| core.String pageToken, |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (pageSize != null) { |
| _queryParams['pageSize'] = ['${pageSize}']; |
| } |
| if (pageToken != null) { |
| _queryParams['pageToken'] = [pageToken]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/assignments'; |
| |
| final _response = _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => ListAssignmentsResponse.fromJson(data)); |
| } |
| |
| /// 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. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Required. The resource name of the assignment, e.g. |
| /// `projects/myproject/locations/US/reservations/team1-prod/assignments/123` |
| /// Value must have pattern |
| /// "^projects/[^/]+/locations/[^/]+/reservations/[^/]+/assignments/[^/]+$". |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Assignment]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http.Client] completes with an error when making a REST call, |
| /// this method will complete with the same error. |
| async.Future<Assignment> move( |
| MoveAssignmentRequest request, |
| core.String name, { |
| core.String $fields, |
| }) { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':move'; |
| |
| final _response = _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return _response.then((data) => Assignment.fromJson(data)); |
| } |
| } |
| |
| /// A Assignment allows a project to submit jobs of a certain type using slots |
| /// from the specified reservation. |
| class Assignment { |
| /// The resource which will use the reservation. E.g. `projects/myproject`, |
| /// `folders/123`, or `organizations/456`. |
| core.String assignee; |
| |
| /// Which type of jobs will use the reservation. |
| /// Possible string values are: |
| /// - "JOB_TYPE_UNSPECIFIED" : Invalid type. Requests with this value will be |
| /// rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. |
| /// - "PIPELINE" : Pipeline (load/export) jobs from the project will use the |
| /// reservation. |
| /// - "QUERY" : Query jobs from the project will use the reservation. |
| /// - "ML_EXTERNAL" : BigQuery ML jobs that use services external to BigQuery |
| /// for model training. These jobs will not utilize idle slots from other |
| /// reservations. |
| core.String jobType; |
| |
| /// Output only. Name of the resource. E.g.: |
| /// `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. |
| core.String name; |
| |
| /// Output only. State of the assignment. |
| /// Possible string values are: |
| /// - "STATE_UNSPECIFIED" : Invalid state value. |
| /// - "PENDING" : Queries from assignee will be executed as on-demand, if |
| /// related assignment is pending. |
| /// - "ACTIVE" : Assignment is ready. |
| core.String state; |
| |
| Assignment(); |
| |
| Assignment.fromJson(core.Map _json) { |
| if (_json.containsKey('assignee')) { |
| assignee = _json['assignee'] as core.String; |
| } |
| if (_json.containsKey('jobType')) { |
| jobType = _json['jobType'] as core.String; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('state')) { |
| state = _json['state'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (assignee != null) { |
| _json['assignee'] = assignee; |
| } |
| if (jobType != null) { |
| _json['jobType'] = jobType; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (state != null) { |
| _json['state'] = state; |
| } |
| return _json; |
| } |
| } |
| |
| /// Represents a BI Reservation. |
| class BiReservation { |
| /// The resource name of the singleton BI reservation. Reservation names have |
| /// the form `projects/{project_id}/locations/{location_id}/bireservation`. |
| core.String name; |
| |
| /// Size of a reservation, in bytes. |
| core.String size; |
| |
| /// Output only. The last update timestamp of a reservation. |
| core.String updateTime; |
| |
| BiReservation(); |
| |
| BiReservation.fromJson(core.Map _json) { |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('size')) { |
| size = _json['size'] as core.String; |
| } |
| if (_json.containsKey('updateTime')) { |
| updateTime = _json['updateTime'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (size != null) { |
| _json['size'] = size; |
| } |
| if (updateTime != null) { |
| _json['updateTime'] = updateTime; |
| } |
| return _json; |
| } |
| } |
| |
| /// Capacity commitment is a way to purchase compute capacity for BigQuery jobs |
| /// (in the form of slots) with some committed period of usage. Annual |
| /// commitments renew by default. Commitments can be removed after their |
| /// commitment end time passes. In order to remove annual commitment, its plan |
| /// needs to be changed to monthly or flex first. A capacity commitment resource |
| /// exists as a child resource of the admin project. |
| class CapacityCommitment { |
| /// Output only. The end of the current commitment period. It is applicable |
| /// only for ACTIVE capacity commitments. |
| core.String commitmentEndTime; |
| |
| /// Output only. The start of the current commitment period. It is applicable |
| /// only for ACTIVE capacity commitments. |
| core.String commitmentStartTime; |
| |
| /// Output only. For FAILED commitment plan, provides the reason of failure. |
| Status failureStatus; |
| |
| /// Output only. The resource name of the capacity commitment, e.g., |
| /// `projects/myproject/locations/US/capacityCommitments/123` |
| core.String name; |
| |
| /// Capacity commitment commitment plan. |
| /// Possible string values are: |
| /// - "COMMITMENT_PLAN_UNSPECIFIED" : Invalid plan value. Requests with this |
| /// value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. |
| /// - "FLEX" : Flex commitments have committed period of 1 minute after |
| /// becoming ACTIVE. After that, they are not in a committed period anymore |
| /// and can be removed any time. |
| /// - "TRIAL" : Trial commitments have a committed period of 182 days after |
| /// becoming ACTIVE. After that, they are converted to a new commitment based |
| /// on the `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex |
| /// so that it can be deleted right after committed period ends. |
| /// - "MONTHLY" : Monthly commitments have a committed period of 30 days after |
| /// becoming ACTIVE. After that, they are not in a committed period anymore |
| /// and can be removed any time. |
| /// - "ANNUAL" : Annual commitments have a committed period of 365 days after |
| /// becoming ACTIVE. After that they are converted to a new commitment based |
| /// on the renewal_plan. |
| core.String plan; |
| |
| /// The plan this capacity commitment is converted to after |
| /// commitment_end_time passes. Once the plan is changed, committed period is |
| /// extended according to commitment plan. Only applicable for ANNUAL and |
| /// TRIAL commitments. |
| /// Possible string values are: |
| /// - "COMMITMENT_PLAN_UNSPECIFIED" : Invalid plan value. Requests with this |
| /// value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`. |
| /// - "FLEX" : Flex commitments have committed period of 1 minute after |
| /// becoming ACTIVE. After that, they are not in a committed period anymore |
| /// and can be removed any time. |
| /// - "TRIAL" : Trial commitments have a committed period of 182 days after |
| /// becoming ACTIVE. After that, they are converted to a new commitment based |
| /// on the `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex |
| /// so that it can be deleted right after committed period ends. |
| /// - "MONTHLY" : Monthly commitments have a committed period of 30 days after |
| /// becoming ACTIVE. After that, they are not in a committed period anymore |
| /// and can be removed any time. |
| /// - "ANNUAL" : Annual commitments have a committed period of 365 days after |
| /// becoming ACTIVE. After that they are converted to a new commitment based |
| /// on the renewal_plan. |
| core.String renewalPlan; |
| |
| /// Number of slots in this commitment. |
| core.String slotCount; |
| |
| /// Output only. State of the commitment. |
| /// Possible string values are: |
| /// - "STATE_UNSPECIFIED" : Invalid state value. |
| /// - "PENDING" : Capacity commitment is pending provisioning. Pending |
| /// capacity commitment does not contribute to the parent's slot_capacity. |
| /// - "ACTIVE" : Once slots are provisioned, capacity commitment becomes |
| /// active. slot_count is added to the parent's slot_capacity. |
| /// - "FAILED" : Capacity commitment is failed to be activated by the backend. |
| core.String state; |
| |
| CapacityCommitment(); |
| |
| CapacityCommitment.fromJson(core.Map _json) { |
| if (_json.containsKey('commitmentEndTime')) { |
| commitmentEndTime = _json['commitmentEndTime'] as core.String; |
| } |
| if (_json.containsKey('commitmentStartTime')) { |
| commitmentStartTime = _json['commitmentStartTime'] as core.String; |
| } |
| if (_json.containsKey('failureStatus')) { |
| failureStatus = Status.fromJson(_json['failureStatus']); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('plan')) { |
| plan = _json['plan'] as core.String; |
| } |
| if (_json.containsKey('renewalPlan')) { |
| renewalPlan = _json['renewalPlan'] as core.String; |
| } |
| if (_json.containsKey('slotCount')) { |
| slotCount = _json['slotCount'] as core.String; |
| } |
| if (_json.containsKey('state')) { |
| state = _json['state'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (commitmentEndTime != null) { |
| _json['commitmentEndTime'] = commitmentEndTime; |
| } |
| if (commitmentStartTime != null) { |
| _json['commitmentStartTime'] = commitmentStartTime; |
| } |
| if (failureStatus != null) { |
| _json['failureStatus'] = failureStatus.toJson(); |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (plan != null) { |
| _json['plan'] = plan; |
| } |
| if (renewalPlan != null) { |
| _json['renewalPlan'] = renewalPlan; |
| } |
| if (slotCount != null) { |
| _json['slotCount'] = slotCount; |
| } |
| if (state != null) { |
| _json['state'] = state; |
| } |
| return _json; |
| } |
| } |
| |
| /// The metadata for operation returned from ReservationService.CreateSlotPool. |
| class CreateSlotPoolMetadata { |
| /// Resource name of the slot pool that is being created. E.g., |
| /// projects/myproject/locations/us-central1/reservations/foo/slotPools/123 |
| core.String slotPool; |
| |
| CreateSlotPoolMetadata(); |
| |
| CreateSlotPoolMetadata.fromJson(core.Map _json) { |
| if (_json.containsKey('slotPool')) { |
| slotPool = _json['slotPool'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (slotPool != null) { |
| _json['slotPool'] = slotPool; |
| } |
| return _json; |
| } |
| } |
| |
| /// A generic empty message that you can re-use to avoid defining duplicated |
| /// empty messages in your APIs. A typical example is to use it as the request |
| /// or the response type of an API method. For instance: service Foo { rpc |
| /// Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON |
| /// representation for `Empty` is empty JSON object `{}`. |
| class Empty { |
| Empty(); |
| |
| Empty.fromJson( |
| // ignore: avoid_unused_constructor_parameters |
| core.Map _json); |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| return _json; |
| } |
| } |
| |
| /// The response for ReservationService.ListAssignments. |
| class ListAssignmentsResponse { |
| /// List of assignments visible to the user. |
| core.List<Assignment> assignments; |
| |
| /// Token to retrieve the next page of results, or empty if there are no more |
| /// results in the list. |
| core.String nextPageToken; |
| |
| ListAssignmentsResponse(); |
| |
| ListAssignmentsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('assignments')) { |
| assignments = (_json['assignments'] as core.List) |
| .map<Assignment>((value) => Assignment.fromJson(value)) |
| .toList(); |
| } |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (assignments != null) { |
| _json['assignments'] = |
| assignments.map((value) => value.toJson()).toList(); |
| } |
| if (nextPageToken != null) { |
| _json['nextPageToken'] = nextPageToken; |
| } |
| return _json; |
| } |
| } |
| |
| /// The response for ReservationService.ListCapacityCommitments. |
| class ListCapacityCommitmentsResponse { |
| /// List of capacity commitments visible to the user. |
| core.List<CapacityCommitment> capacityCommitments; |
| |
| /// Token to retrieve the next page of results, or empty if there are no more |
| /// results in the list. |
| core.String nextPageToken; |
| |
| ListCapacityCommitmentsResponse(); |
| |
| ListCapacityCommitmentsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('capacityCommitments')) { |
| capacityCommitments = (_json['capacityCommitments'] as core.List) |
| .map<CapacityCommitment>( |
| (value) => CapacityCommitment.fromJson(value)) |
| .toList(); |
| } |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (capacityCommitments != null) { |
| _json['capacityCommitments'] = |
| capacityCommitments.map((value) => value.toJson()).toList(); |
| } |
| if (nextPageToken != null) { |
| _json['nextPageToken'] = nextPageToken; |
| } |
| return _json; |
| } |
| } |
| |
| /// The response message for Operations.ListOperations. |
| class ListOperationsResponse { |
| /// The standard List next-page token. |
| core.String nextPageToken; |
| |
| /// A list of operations that matches the specified filter in the request. |
| core.List<Operation> operations; |
| |
| ListOperationsResponse(); |
| |
| ListOperationsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| if (_json.containsKey('operations')) { |
| operations = (_json['operations'] as core.List) |
| .map<Operation>((value) => Operation.fromJson(value)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (nextPageToken != null) { |
| _json['nextPageToken'] = nextPageToken; |
| } |
| if (operations != null) { |
| _json['operations'] = operations.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// The response for ReservationService.ListReservations. |
| class ListReservationsResponse { |
| /// Token to retrieve the next page of results, or empty if there are no more |
| /// results in the list. |
| core.String nextPageToken; |
| |
| /// List of reservations visible to the user. |
| core.List<Reservation> reservations; |
| |
| ListReservationsResponse(); |
| |
| ListReservationsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| if (_json.containsKey('reservations')) { |
| reservations = (_json['reservations'] as core.List) |
| .map<Reservation>((value) => Reservation.fromJson(value)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (nextPageToken != null) { |
| _json['nextPageToken'] = nextPageToken; |
| } |
| if (reservations != null) { |
| _json['reservations'] = |
| reservations.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// The request for ReservationService.MergeCapacityCommitments. |
| class MergeCapacityCommitmentsRequest { |
| /// Ids of capacity commitments to merge. These capacity commitments must |
| /// exist under admin project and location specified in the parent. ID is the |
| /// last portion of capacity commitment name e.g., 'abc' for |
| /// projects/myproject/locations/US/capacityCommitments/abc |
| core.List<core.String> capacityCommitmentIds; |
| |
| MergeCapacityCommitmentsRequest(); |
| |
| MergeCapacityCommitmentsRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('capacityCommitmentIds')) { |
| capacityCommitmentIds = (_json['capacityCommitmentIds'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (capacityCommitmentIds != null) { |
| _json['capacityCommitmentIds'] = capacityCommitmentIds; |
| } |
| return _json; |
| } |
| } |
| |
| /// The request for ReservationService.MoveAssignment. **Note**: |
| /// "bigquery.reservationAssignments.create" permission is required on the |
| /// destination_id. **Note**: "bigquery.reservationAssignments.create" and |
| /// "bigquery.reservationAssignments.delete" permission are required on the |
| /// related assignee. |
| class MoveAssignmentRequest { |
| /// The new reservation ID, e.g.: |
| /// `projects/myotherproject/locations/US/reservations/team2-prod` |
| core.String destinationId; |
| |
| MoveAssignmentRequest(); |
| |
| MoveAssignmentRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('destinationId')) { |
| destinationId = _json['destinationId'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (destinationId != null) { |
| _json['destinationId'] = destinationId; |
| } |
| return _json; |
| } |
| } |
| |
| /// This resource represents a long-running operation that is the result of a |
| /// network API call. |
| class Operation { |
| /// If the value is `false`, it means the operation is still in progress. If |
| /// `true`, the operation is completed, and either `error` or `response` is |
| /// available. |
| core.bool done; |
| |
| /// The error result of the operation in case of failure or cancellation. |
| Status error; |
| |
| /// Service-specific metadata associated with the operation. It typically |
| /// contains progress information and common metadata such as create time. |
| /// Some services might not provide such metadata. Any method that returns a |
| /// long-running operation should document the metadata type, if any. |
| /// |
| /// The values for Object must be JSON objects. It can consist of `num`, |
| /// `String`, `bool` and `null` as well as `Map` and `List` values. |
| core.Map<core.String, core.Object> metadata; |
| |
| /// The server-assigned name, which is only unique within the same service |
| /// that originally returns it. If you use the default HTTP mapping, the |
| /// `name` should be a resource name ending with `operations/{unique_id}`. |
| core.String name; |
| |
| /// The normal response of the operation in case of success. If the original |
| /// method returns no data on success, such as `Delete`, the response is |
| /// `google.protobuf.Empty`. If the original method is standard |
| /// `Get`/`Create`/`Update`, the response should be the resource. For other |
| /// methods, the response should have the type `XxxResponse`, where `Xxx` is |
| /// the original method name. For example, if the original method name is |
| /// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| /// |
| /// The values for Object must be JSON objects. It can consist of `num`, |
| /// `String`, `bool` and `null` as well as `Map` and `List` values. |
| core.Map<core.String, core.Object> response; |
| |
| Operation(); |
| |
| Operation.fromJson(core.Map _json) { |
| if (_json.containsKey('done')) { |
| done = _json['done'] as core.bool; |
| } |
| if (_json.containsKey('error')) { |
| error = Status.fromJson(_json['error']); |
| } |
| if (_json.containsKey('metadata')) { |
| metadata = commons.mapMap<core.Object, core.Object>( |
| _json['metadata'].cast<core.String, core.Object>(), |
| (core.Object item) => item as core.Object); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('response')) { |
| response = commons.mapMap<core.Object, core.Object>( |
| _json['response'].cast<core.String, core.Object>(), |
| (core.Object item) => item as core.Object); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (done != null) { |
| _json['done'] = done; |
| } |
| if (error != null) { |
| _json['error'] = error.toJson(); |
| } |
| if (metadata != null) { |
| _json['metadata'] = metadata; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (response != null) { |
| _json['response'] = response; |
| } |
| return _json; |
| } |
| } |
| |
| /// A reservation is a mechanism used to guarantee slots to users. |
| class Reservation { |
| /// Output only. Creation time of the reservation. |
| core.String creationTime; |
| |
| /// If false, any query using this reservation will use idle slots from other |
| /// reservations within the same admin project. If true, a query using this |
| /// reservation will execute with the slot capacity specified above at most. |
| core.bool ignoreIdleSlots; |
| |
| /// The resource name of the reservation, e.g., `projects / * /locations / * |
| /// /reservations/team1-prod`. |
| core.String name; |
| |
| /// Minimum slots available to this reservation. A slot is a unit of |
| /// computational power in BigQuery, and serves as the unit of parallelism. |
| /// Queries using this reservation might use more slots during runtime if |
| /// ignore_idle_slots is set to false. If the new reservation's slot capacity |
| /// exceed the parent's slot capacity or if total slot capacity of the new |
| /// reservation and its siblings exceeds the parent's slot capacity, the |
| /// request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. |
| core.String slotCapacity; |
| |
| /// Output only. Last update time of the reservation. |
| core.String updateTime; |
| |
| Reservation(); |
| |
| Reservation.fromJson(core.Map _json) { |
| if (_json.containsKey('creationTime')) { |
| creationTime = _json['creationTime'] as core.String; |
| } |
| if (_json.containsKey('ignoreIdleSlots')) { |
| ignoreIdleSlots = _json['ignoreIdleSlots'] as core.bool; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('slotCapacity')) { |
| slotCapacity = _json['slotCapacity'] as core.String; |
| } |
| if (_json.containsKey('updateTime')) { |
| updateTime = _json['updateTime'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (creationTime != null) { |
| _json['creationTime'] = creationTime; |
| } |
| if (ignoreIdleSlots != null) { |
| _json['ignoreIdleSlots'] = ignoreIdleSlots; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (slotCapacity != null) { |
| _json['slotCapacity'] = slotCapacity; |
| } |
| if (updateTime != null) { |
| _json['updateTime'] = updateTime; |
| } |
| return _json; |
| } |
| } |
| |
| /// The response for ReservationService.SearchAllAssignments. |
| class SearchAllAssignmentsResponse { |
| /// List of assignments visible to the user. |
| core.List<Assignment> assignments; |
| |
| /// Token to retrieve the next page of results, or empty if there are no more |
| /// results in the list. |
| core.String nextPageToken; |
| |
| SearchAllAssignmentsResponse(); |
| |
| SearchAllAssignmentsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('assignments')) { |
| assignments = (_json['assignments'] as core.List) |
| .map<Assignment>((value) => Assignment.fromJson(value)) |
| .toList(); |
| } |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (assignments != null) { |
| _json['assignments'] = |
| assignments.map((value) => value.toJson()).toList(); |
| } |
| if (nextPageToken != null) { |
| _json['nextPageToken'] = nextPageToken; |
| } |
| return _json; |
| } |
| } |
| |
| /// The response for ReservationService.SearchAssignments. |
| class SearchAssignmentsResponse { |
| /// List of assignments visible to the user. |
| core.List<Assignment> assignments; |
| |
| /// Token to retrieve the next page of results, or empty if there are no more |
| /// results in the list. |
| core.String nextPageToken; |
| |
| SearchAssignmentsResponse(); |
| |
| SearchAssignmentsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('assignments')) { |
| assignments = (_json['assignments'] as core.List) |
| .map<Assignment>((value) => Assignment.fromJson(value)) |
| .toList(); |
| } |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (assignments != null) { |
| _json['assignments'] = |
| assignments.map((value) => value.toJson()).toList(); |
| } |
| if (nextPageToken != null) { |
| _json['nextPageToken'] = nextPageToken; |
| } |
| return _json; |
| } |
| } |
| |
| /// The request for ReservationService.SplitCapacityCommitment. |
| class SplitCapacityCommitmentRequest { |
| /// Number of slots in the capacity commitment after the split. |
| core.String slotCount; |
| |
| SplitCapacityCommitmentRequest(); |
| |
| SplitCapacityCommitmentRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('slotCount')) { |
| slotCount = _json['slotCount'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (slotCount != null) { |
| _json['slotCount'] = slotCount; |
| } |
| return _json; |
| } |
| } |
| |
| /// The response for ReservationService.SplitCapacityCommitment. |
| class SplitCapacityCommitmentResponse { |
| /// First capacity commitment, result of a split. |
| CapacityCommitment first; |
| |
| /// Second capacity commitment, result of a split. |
| CapacityCommitment second; |
| |
| SplitCapacityCommitmentResponse(); |
| |
| SplitCapacityCommitmentResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('first')) { |
| first = CapacityCommitment.fromJson(_json['first']); |
| } |
| if (_json.containsKey('second')) { |
| second = CapacityCommitment.fromJson(_json['second']); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (first != null) { |
| _json['first'] = first.toJson(); |
| } |
| if (second != null) { |
| _json['second'] = second.toJson(); |
| } |
| return _json; |
| } |
| } |
| |
| /// The `Status` type defines a logical error model that is suitable for |
| /// different programming environments, including REST APIs and RPC APIs. It is |
| /// used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| /// three pieces of data: error code, error message, and error details. You can |
| /// find out more about this error model and how to work with it in the [API |
| /// Design Guide](https://cloud.google.com/apis/design/errors). |
| class Status { |
| /// The status code, which should be an enum value of google.rpc.Code. |
| core.int code; |
| |
| /// A list of messages that carry the error details. There is a common set of |
| /// message types for APIs to use. |
| /// |
| /// The values for Object must be JSON objects. It can consist of `num`, |
| /// `String`, `bool` and `null` as well as `Map` and `List` values. |
| core.List<core.Map<core.String, core.Object>> details; |
| |
| /// A developer-facing error message, which should be in English. Any |
| /// user-facing error message should be localized and sent in the |
| /// google.rpc.Status.details field, or localized by the client. |
| core.String message; |
| |
| Status(); |
| |
| Status.fromJson(core.Map _json) { |
| if (_json.containsKey('code')) { |
| code = _json['code'] as core.int; |
| } |
| if (_json.containsKey('details')) { |
| details = (_json['details'] as core.List) |
| .map<core.Map<core.String, core.Object>>((value) => |
| commons.mapMap<core.Object, core.Object>( |
| value.cast<core.String, core.Object>(), |
| (core.Object item) => item as core.Object)) |
| .toList(); |
| } |
| if (_json.containsKey('message')) { |
| message = _json['message'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (code != null) { |
| _json['code'] = code; |
| } |
| if (details != null) { |
| _json['details'] = details; |
| } |
| if (message != null) { |
| _json['message'] = message; |
| } |
| return _json; |
| } |
| } |