| Index: generated/googleapis/lib/spanner/v1.dart
|
| diff --git a/generated/googleapis/lib/spanner/v1.dart b/generated/googleapis/lib/spanner/v1.dart
|
| index 1040f3fc1768cbf7485b1dba7896655a68c91424..160deb50050eef16c93f4d95104e919e5921da0b 100644
|
| --- a/generated/googleapis/lib/spanner/v1.dart
|
| +++ b/generated/googleapis/lib/spanner/v1.dart
|
| @@ -9,70 +9,70 @@ 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;
|
| +export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
|
| + show ApiRequestError, DetailedApiRequestError;
|
|
|
| const core.String USER_AGENT = 'dart-api-client spanner/v1';
|
|
|
| -/**
|
| - * Cloud Spanner is a managed, mission-critical, globally consistent and
|
| - * scalable relational database service.
|
| - */
|
| +/// Cloud Spanner is a managed, mission-critical, globally consistent and
|
| +/// scalable relational database service.
|
| class SpannerApi {
|
| - /** View and manage your data across Google Cloud Platform services */
|
| - static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform";
|
| + /// View and manage your data across Google Cloud Platform services
|
| + static const CloudPlatformScope =
|
| + "https://www.googleapis.com/auth/cloud-platform";
|
|
|
| - /** Administer your Spanner databases */
|
| - static const SpannerAdminScope = "https://www.googleapis.com/auth/spanner.admin";
|
| -
|
| - /** View and manage the contents of your Spanner databases */
|
| - static const SpannerDataScope = "https://www.googleapis.com/auth/spanner.data";
|
| + /// Administer your Spanner databases
|
| + static const SpannerAdminScope =
|
| + "https://www.googleapis.com/auth/spanner.admin";
|
|
|
| + /// View and manage the contents of your Spanner databases
|
| + static const SpannerDataScope =
|
| + "https://www.googleapis.com/auth/spanner.data";
|
|
|
| final commons.ApiRequester _requester;
|
|
|
| ProjectsResourceApi get projects => new ProjectsResourceApi(_requester);
|
|
|
| - SpannerApi(http.Client client, {core.String rootUrl: "https://spanner.googleapis.com/", core.String servicePath: ""}) :
|
| - _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| + SpannerApi(http.Client client,
|
| + {core.String rootUrl: "https://spanner.googleapis.com/",
|
| + core.String servicePath: ""})
|
| + : _requester =
|
| + new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| }
|
|
|
| -
|
| class ProjectsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsInstanceConfigsResourceApi get instanceConfigs => new ProjectsInstanceConfigsResourceApi(_requester);
|
| - ProjectsInstancesResourceApi get instances => new ProjectsInstancesResourceApi(_requester);
|
| + ProjectsInstanceConfigsResourceApi get instanceConfigs =>
|
| + new ProjectsInstanceConfigsResourceApi(_requester);
|
| + ProjectsInstancesResourceApi get instances =>
|
| + new ProjectsInstancesResourceApi(_requester);
|
|
|
| - ProjectsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| + ProjectsResourceApi(commons.ApiRequester client) : _requester = client;
|
| }
|
|
|
| -
|
| class ProjectsInstanceConfigsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsInstanceConfigsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Gets information about a particular instance configuration.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Required. The name of the requested instance configuration. Values
|
| - * are of
|
| - * the form `projects/<project>/instanceConfigs/<config>`.
|
| - * Value must have pattern "^projects/[^/]+/instanceConfigs/[^/]+$".
|
| - *
|
| - * Completes with a [InstanceConfig].
|
| - *
|
| - * 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.
|
| - */
|
| + ProjectsInstanceConfigsResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Gets information about a particular instance configuration.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Required. The name of the requested instance configuration.
|
| + /// Values are of
|
| + /// the form `projects/<project>/instanceConfigs/<config>`.
|
| + /// Value must have pattern "^projects/[^/]+/instanceConfigs/[^/]+$".
|
| + ///
|
| + /// Completes with a [InstanceConfig].
|
| + ///
|
| + /// 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<InstanceConfig> get(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -87,44 +87,42 @@ class ProjectsInstanceConfigsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new InstanceConfig.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Lists the supported instance configurations for a given project.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [parent] - Required. The name of the project for which a list of supported
|
| - * instance
|
| - * configurations is requested. Values are of the form
|
| - * `projects/<project>`.
|
| - * Value must have pattern "^projects/[^/]+$".
|
| - *
|
| - * [pageToken] - If non-empty, `page_token` should contain a
|
| - * next_page_token
|
| - * from a previous ListInstanceConfigsResponse.
|
| - *
|
| - * [pageSize] - Number of instance configurations to be returned in the
|
| - * response. If 0 or
|
| - * less, defaults to the server's maximum allowed page size.
|
| - *
|
| - * Completes with a [ListInstanceConfigsResponse].
|
| - *
|
| - * 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<ListInstanceConfigsResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
|
| + /// Lists the supported instance configurations for a given project.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [parent] - Required. The name of the project for which a list of
|
| + /// supported instance
|
| + /// configurations is requested. Values are of the form
|
| + /// `projects/<project>`.
|
| + /// Value must have pattern "^projects/[^/]+$".
|
| + ///
|
| + /// [pageToken] - If non-empty, `page_token` should contain a
|
| + /// next_page_token
|
| + /// from a previous ListInstanceConfigsResponse.
|
| + ///
|
| + /// [pageSize] - Number of instance configurations to be returned in the
|
| + /// response. If 0 or
|
| + /// less, defaults to the server's maximum allowed page size.
|
| + ///
|
| + /// Completes with a [ListInstanceConfigsResponse].
|
| + ///
|
| + /// 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<ListInstanceConfigsResponse> list(core.String parent,
|
| + {core.String pageToken, core.int pageSize}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -142,84 +140,85 @@ class ProjectsInstanceConfigsResourceApi {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/instanceConfigs';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$parent') +
|
| + '/instanceConfigs';
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new ListInstanceConfigsResponse.fromJson(data));
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response
|
| + .then((data) => new ListInstanceConfigsResponse.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class ProjectsInstancesResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsInstancesDatabasesResourceApi get databases => new ProjectsInstancesDatabasesResourceApi(_requester);
|
| - ProjectsInstancesOperationsResourceApi get operations => new ProjectsInstancesOperationsResourceApi(_requester);
|
| -
|
| - ProjectsInstancesResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Creates an instance and begins preparing it to begin serving. The
|
| - * returned long-running operation
|
| - * can be used to track the progress of preparing the new
|
| - * instance. The instance name is assigned by the caller. If the
|
| - * named instance already exists, `CreateInstance` returns
|
| - * `ALREADY_EXISTS`.
|
| - *
|
| - * Immediately upon completion of this request:
|
| - *
|
| - * * The instance is readable via the API, with all requested attributes
|
| - * but no allocated resources. Its state is `CREATING`.
|
| - *
|
| - * Until completion of the returned operation:
|
| - *
|
| - * * Cancelling the operation renders the instance immediately unreadable
|
| - * via the API.
|
| - * * The instance can be deleted.
|
| - * * All other attempts to modify the instance are rejected.
|
| - *
|
| - * Upon completion of the returned operation:
|
| - *
|
| - * * Billing for all successfully-allocated resources begins (some types
|
| - * may have lower than the requested levels).
|
| - * * Databases can be created in the instance.
|
| - * * The instance's allocated resource levels are readable via the API.
|
| - * * The instance's state becomes `READY`.
|
| - *
|
| - * The returned long-running operation will
|
| - * have a name of the format `<instance_name>/operations/<operation_id>` and
|
| - * can be used to track creation of the instance. The
|
| - * metadata field type is
|
| - * CreateInstanceMetadata.
|
| - * The response field type is
|
| - * Instance, if successful.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [parent] - Required. The name of the project in which to create the
|
| - * instance. Values
|
| - * are of the form `projects/<project>`.
|
| - * Value must have pattern "^projects/[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * 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<Operation> create(CreateInstanceRequest request, core.String parent) {
|
| + ProjectsInstancesDatabasesResourceApi get databases =>
|
| + new ProjectsInstancesDatabasesResourceApi(_requester);
|
| + ProjectsInstancesOperationsResourceApi get operations =>
|
| + new ProjectsInstancesOperationsResourceApi(_requester);
|
| +
|
| + ProjectsInstancesResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Creates an instance and begins preparing it to begin serving. The
|
| + /// returned long-running operation
|
| + /// can be used to track the progress of preparing the new
|
| + /// instance. The instance name is assigned by the caller. If the
|
| + /// named instance already exists, `CreateInstance` returns
|
| + /// `ALREADY_EXISTS`.
|
| + ///
|
| + /// Immediately upon completion of this request:
|
| + ///
|
| + /// * The instance is readable via the API, with all requested attributes
|
| + /// but no allocated resources. Its state is `CREATING`.
|
| + ///
|
| + /// Until completion of the returned operation:
|
| + ///
|
| + /// * Cancelling the operation renders the instance immediately unreadable
|
| + /// via the API.
|
| + /// * The instance can be deleted.
|
| + /// * All other attempts to modify the instance are rejected.
|
| + ///
|
| + /// Upon completion of the returned operation:
|
| + ///
|
| + /// * Billing for all successfully-allocated resources begins (some types
|
| + /// may have lower than the requested levels).
|
| + /// * Databases can be created in the instance.
|
| + /// * The instance's allocated resource levels are readable via the API.
|
| + /// * The instance's state becomes `READY`.
|
| + ///
|
| + /// The returned long-running operation will
|
| + /// have a name of the format `<instance_name>/operations/<operation_id>` and
|
| + /// can be used to track creation of the instance. The
|
| + /// metadata field type is
|
| + /// CreateInstanceMetadata.
|
| + /// The response field type is
|
| + /// Instance, if successful.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [parent] - Required. The name of the project in which to create the
|
| + /// instance. Values
|
| + /// are of the form `projects/<project>`.
|
| + /// Value must have pattern "^projects/[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// 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<Operation> create(
|
| + CreateInstanceRequest request, core.String parent) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -234,46 +233,44 @@ class ProjectsInstancesResourceApi {
|
| throw new core.ArgumentError("Parameter parent is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/instances';
|
| + _url =
|
| + 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/instances';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Deletes an instance.
|
| - *
|
| - * Immediately upon completion of the request:
|
| - *
|
| - * * Billing ceases for all of the instance's reserved resources.
|
| - *
|
| - * Soon afterward:
|
| - *
|
| - * * The instance and *all of its databases* immediately and
|
| - * irrevocably disappear from the API. All data in the databases
|
| - * is permanently deleted.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Required. The name of the instance to be deleted. Values are of
|
| - * the form
|
| - * `projects/<project>/instances/<instance>`
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| - *
|
| - * 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.
|
| - */
|
| + /// Deletes an instance.
|
| + ///
|
| + /// Immediately upon completion of the request:
|
| + ///
|
| + /// * Billing ceases for all of the instance's reserved resources.
|
| + ///
|
| + /// Soon afterward:
|
| + ///
|
| + /// * The instance and *all of its databases* immediately and
|
| + /// irrevocably disappear from the API. All data in the databases
|
| + /// is permanently deleted.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Required. The name of the instance to be deleted. Values are of
|
| + /// the form
|
| + /// `projects/<project>/instances/<instance>`
|
| + /// Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| + ///
|
| + /// 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) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -288,34 +285,31 @@ class ProjectsInstancesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "DELETE",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "DELETE",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Gets information about a particular instance.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Required. The name of the requested instance. Values are of the
|
| - * form
|
| - * `projects/<project>/instances/<instance>`.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| - *
|
| - * Completes with a [Instance].
|
| - *
|
| - * 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.
|
| - */
|
| + /// Gets information about a particular instance.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Required. The name of the requested instance. Values are of the
|
| + /// form
|
| + /// `projects/<project>/instances/<instance>`.
|
| + /// Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| + ///
|
| + /// Completes with a [Instance].
|
| + ///
|
| + /// 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<Instance> get(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -330,42 +324,41 @@ class ProjectsInstancesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Instance.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Gets the access control policy for an instance resource. Returns an empty
|
| - * policy if an instance exists but does not have a policy set.
|
| - *
|
| - * Authorization requires `spanner.instances.getIamPolicy` on
|
| - * resource.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [resource] - REQUIRED: The Cloud Spanner resource for which the policy is
|
| - * being retrieved. The format is `projects/<project ID>/instances/<instance
|
| - * ID>` for instance resources and `projects/<project ID>/instances/<instance
|
| - * ID>/databases/<database ID>` for database resources.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| - *
|
| - * Completes with a [Policy].
|
| - *
|
| - * 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<Policy> getIamPolicy(GetIamPolicyRequest request, core.String resource) {
|
| + /// Gets the access control policy for an instance resource. Returns an empty
|
| + /// policy if an instance exists but does not have a policy set.
|
| + ///
|
| + /// Authorization requires `spanner.instances.getIamPolicy` on
|
| + /// resource.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [resource] - REQUIRED: The Cloud Spanner resource for which the policy is
|
| + /// being retrieved. The format is `projects/<project ID>/instances/<instance
|
| + /// ID>` for instance resources and `projects/<project
|
| + /// ID>/instances/<instance ID>/databases/<database ID>` for database
|
| + /// resources.
|
| + /// Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| + ///
|
| + /// Completes with a [Policy].
|
| + ///
|
| + /// 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<Policy> getIamPolicy(
|
| + GetIamPolicyRequest request, core.String resource) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -380,66 +373,66 @@ class ProjectsInstancesResourceApi {
|
| throw new core.ArgumentError("Parameter resource is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':getIamPolicy';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$resource') +
|
| + ':getIamPolicy';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Policy.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Lists all instances in the given project.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [parent] - Required. The name of the project for which a list of instances
|
| - * is
|
| - * requested. Values are of the form `projects/<project>`.
|
| - * Value must have pattern "^projects/[^/]+$".
|
| - *
|
| - * [pageToken] - If non-empty, `page_token` should contain a
|
| - * next_page_token from a
|
| - * previous ListInstancesResponse.
|
| - *
|
| - * [pageSize] - Number of instances to be returned in the response. If 0 or
|
| - * less, defaults
|
| - * to the server's maximum allowed page size.
|
| - *
|
| - * [filter] - An expression for filtering the results of the request. Filter
|
| - * rules are
|
| - * case insensitive. The fields eligible for filtering are:
|
| - *
|
| - * * name
|
| - * * display_name
|
| - * * labels.key where key is the name of a label
|
| - *
|
| - * Some examples of using filters are:
|
| - *
|
| - * * name:* --> The instance has a name.
|
| - * * name:Howl --> The instance's name contains the string "howl".
|
| - * * name:HOWL --> Equivalent to above.
|
| - * * NAME:howl --> Equivalent to above.
|
| - * * labels.env:* --> The instance has the label "env".
|
| - * * labels.env:dev --> The instance has the label "env" and the value of
|
| - * the label contains the string "dev".
|
| - * * name:howl labels.env:dev --> The instance's name contains "howl" and
|
| - * it has the label "env" with its value
|
| - * containing "dev".
|
| - *
|
| - * Completes with a [ListInstancesResponse].
|
| - *
|
| - * 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<ListInstancesResponse> list(core.String parent, {core.String pageToken, core.int pageSize, core.String filter}) {
|
| + /// Lists all instances in the given project.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [parent] - Required. The name of the project for which a list of
|
| + /// instances is
|
| + /// requested. Values are of the form `projects/<project>`.
|
| + /// Value must have pattern "^projects/[^/]+$".
|
| + ///
|
| + /// [pageToken] - If non-empty, `page_token` should contain a
|
| + /// next_page_token from a
|
| + /// previous ListInstancesResponse.
|
| + ///
|
| + /// [pageSize] - Number of instances to be returned in the response. If 0 or
|
| + /// less, defaults
|
| + /// to the server's maximum allowed page size.
|
| + ///
|
| + /// [filter] - An expression for filtering the results of the request. Filter
|
| + /// rules are
|
| + /// case insensitive. The fields eligible for filtering are:
|
| + ///
|
| + /// * name
|
| + /// * display_name
|
| + /// * labels.key where key is the name of a label
|
| + ///
|
| + /// Some examples of using filters are:
|
| + ///
|
| + /// * name:* --> The instance has a name.
|
| + /// * name:Howl --> The instance's name contains the string "howl".
|
| + /// * name:HOWL --> Equivalent to above.
|
| + /// * NAME:howl --> Equivalent to above.
|
| + /// * labels.env:* --> The instance has the label "env".
|
| + /// * labels.env:dev --> The instance has the label "env" and the value of
|
| + /// the label contains the string "dev".
|
| + /// * name:howl labels.env:dev --> The instance's name contains "howl" and
|
| + /// it has the label "env" with its value
|
| + /// containing "dev".
|
| + ///
|
| + /// Completes with a [ListInstancesResponse].
|
| + ///
|
| + /// 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<ListInstancesResponse> list(core.String parent,
|
| + {core.String pageToken, core.int pageSize, core.String filter}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -460,80 +453,79 @@ class ProjectsInstancesResourceApi {
|
| _queryParams["filter"] = [filter];
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/instances';
|
| + _url =
|
| + 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/instances';
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ListInstancesResponse.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Updates an instance, and begins allocating or releasing resources
|
| - * as requested. The returned long-running
|
| - * operation can be used to track the
|
| - * progress of updating the instance. If the named instance does not
|
| - * exist, returns `NOT_FOUND`.
|
| - *
|
| - * Immediately upon completion of this request:
|
| - *
|
| - * * For resource types for which a decrease in the instance's allocation
|
| - * has been requested, billing is based on the newly-requested level.
|
| - *
|
| - * Until completion of the returned operation:
|
| - *
|
| - * * Cancelling the operation sets its metadata's
|
| - * cancel_time, and begins
|
| - * restoring resources to their pre-request values. The operation
|
| - * is guaranteed to succeed at undoing all resource changes,
|
| - * after which point it terminates with a `CANCELLED` status.
|
| - * * All other attempts to modify the instance are rejected.
|
| - * * Reading the instance via the API continues to give the pre-request
|
| - * resource levels.
|
| - *
|
| - * Upon completion of the returned operation:
|
| - *
|
| - * * Billing begins for all successfully-allocated resources (some types
|
| - * may have lower than the requested levels).
|
| - * * All newly-reserved resources are available for serving the instance's
|
| - * tables.
|
| - * * The instance's new resource levels are readable via the API.
|
| - *
|
| - * The returned long-running operation will
|
| - * have a name of the format `<instance_name>/operations/<operation_id>` and
|
| - * can be used to track the instance modification. The
|
| - * metadata field type is
|
| - * UpdateInstanceMetadata.
|
| - * The response field type is
|
| - * Instance, if successful.
|
| - *
|
| - * Authorization requires `spanner.instances.update` permission on
|
| - * resource name.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Required. A unique identifier for the instance, which cannot be
|
| - * changed
|
| - * after the instance is created. Values are of the form
|
| - * `projects/<project>/instances/a-z*[a-z0-9]`. The final
|
| - * segment of the name must be between 6 and 30 characters in length.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * 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<Operation> patch(UpdateInstanceRequest request, core.String name) {
|
| + /// Updates an instance, and begins allocating or releasing resources
|
| + /// as requested. The returned long-running
|
| + /// operation can be used to track the
|
| + /// progress of updating the instance. If the named instance does not
|
| + /// exist, returns `NOT_FOUND`.
|
| + ///
|
| + /// Immediately upon completion of this request:
|
| + ///
|
| + /// * For resource types for which a decrease in the instance's allocation
|
| + /// has been requested, billing is based on the newly-requested level.
|
| + ///
|
| + /// Until completion of the returned operation:
|
| + ///
|
| + /// * Cancelling the operation sets its metadata's
|
| + /// cancel_time, and begins
|
| + /// restoring resources to their pre-request values. The operation
|
| + /// is guaranteed to succeed at undoing all resource changes,
|
| + /// after which point it terminates with a `CANCELLED` status.
|
| + /// * All other attempts to modify the instance are rejected.
|
| + /// * Reading the instance via the API continues to give the pre-request
|
| + /// resource levels.
|
| + ///
|
| + /// Upon completion of the returned operation:
|
| + ///
|
| + /// * Billing begins for all successfully-allocated resources (some types
|
| + /// may have lower than the requested levels).
|
| + /// * All newly-reserved resources are available for serving the instance's
|
| + /// tables.
|
| + /// * The instance's new resource levels are readable via the API.
|
| + ///
|
| + /// The returned long-running operation will
|
| + /// have a name of the format `<instance_name>/operations/<operation_id>` and
|
| + /// can be used to track the instance modification. The
|
| + /// metadata field type is
|
| + /// UpdateInstanceMetadata.
|
| + /// The response field type is
|
| + /// Instance, if successful.
|
| + ///
|
| + /// Authorization requires `spanner.instances.update` permission on
|
| + /// resource name.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Required. A unique identifier for the instance, which cannot be
|
| + /// changed
|
| + /// after the instance is created. Values are of the form
|
| + /// `projects/<project>/instances/a-z*[a-z0-9]`. The final
|
| + /// segment of the name must be between 6 and 30 characters in length.
|
| + /// Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// 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<Operation> patch(
|
| + UpdateInstanceRequest request, core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -550,42 +542,40 @@ class ProjectsInstancesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "PATCH",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "PATCH",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Sets the access control policy on an instance resource. Replaces any
|
| - * existing policy.
|
| - *
|
| - * Authorization requires `spanner.instances.setIamPolicy` on
|
| - * resource.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [resource] - REQUIRED: The Cloud Spanner resource for which the policy is
|
| - * being set. The format is `projects/<project ID>/instances/<instance ID>`
|
| - * for instance resources and `projects/<project ID>/instances/<instance
|
| - * ID>/databases/<database ID>` for databases resources.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| - *
|
| - * Completes with a [Policy].
|
| - *
|
| - * 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<Policy> setIamPolicy(SetIamPolicyRequest request, core.String resource) {
|
| + /// Sets the access control policy on an instance resource. Replaces any
|
| + /// existing policy.
|
| + ///
|
| + /// Authorization requires `spanner.instances.setIamPolicy` on
|
| + /// resource.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [resource] - REQUIRED: The Cloud Spanner resource for which the policy is
|
| + /// being set. The format is `projects/<project ID>/instances/<instance ID>`
|
| + /// for instance resources and `projects/<project ID>/instances/<instance
|
| + /// ID>/databases/<database ID>` for databases resources.
|
| + /// Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| + ///
|
| + /// Completes with a [Policy].
|
| + ///
|
| + /// 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<Policy> setIamPolicy(
|
| + SetIamPolicyRequest request, core.String resource) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -600,45 +590,48 @@ class ProjectsInstancesResourceApi {
|
| throw new core.ArgumentError("Parameter resource is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':setIamPolicy';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$resource') +
|
| + ':setIamPolicy';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Policy.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Returns permissions that the caller has on the specified instance resource.
|
| - *
|
| - * Attempting this RPC on a non-existent Cloud Spanner instance resource will
|
| - * result in a NOT_FOUND error if the user has `spanner.instances.list`
|
| - * permission on the containing Google Cloud Project. Otherwise returns an
|
| - * empty set of permissions.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [resource] - REQUIRED: The Cloud Spanner resource for which permissions are
|
| - * being tested. The format is `projects/<project ID>/instances/<instance ID>`
|
| - * for instance resources and `projects/<project ID>/instances/<instance
|
| - * ID>/databases/<database ID>` for database resources.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| - *
|
| - * Completes with a [TestIamPermissionsResponse].
|
| - *
|
| - * 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<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request, core.String resource) {
|
| + /// Returns permissions that the caller has on the specified instance
|
| + /// resource.
|
| + ///
|
| + /// Attempting this RPC on a non-existent Cloud Spanner instance resource
|
| + /// will
|
| + /// result in a NOT_FOUND error if the user has `spanner.instances.list`
|
| + /// permission on the containing Google Cloud Project. Otherwise returns an
|
| + /// empty set of permissions.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [resource] - REQUIRED: The Cloud Spanner resource for which permissions
|
| + /// are being tested. The format is `projects/<project
|
| + /// ID>/instances/<instance ID>` for instance resources and
|
| + /// `projects/<project ID>/instances/<instance ID>/databases/<database ID>`
|
| + /// for database resources.
|
| + /// Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| + ///
|
| + /// Completes with a [TestIamPermissionsResponse].
|
| + ///
|
| + /// 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<TestIamPermissionsResponse> testIamPermissions(
|
| + TestIamPermissionsRequest request, core.String resource) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -653,58 +646,60 @@ class ProjectsInstancesResourceApi {
|
| throw new core.ArgumentError("Parameter resource is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':testIamPermissions';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$resource') +
|
| + ':testIamPermissions';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new TestIamPermissionsResponse.fromJson(data));
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response
|
| + .then((data) => new TestIamPermissionsResponse.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class ProjectsInstancesDatabasesResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsInstancesDatabasesOperationsResourceApi get operations => new ProjectsInstancesDatabasesOperationsResourceApi(_requester);
|
| - ProjectsInstancesDatabasesSessionsResourceApi get sessions => new ProjectsInstancesDatabasesSessionsResourceApi(_requester);
|
| -
|
| - ProjectsInstancesDatabasesResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Creates a new Cloud Spanner database and starts to prepare it for serving.
|
| - * The returned long-running operation will
|
| - * have a name of the format `<database_name>/operations/<operation_id>` and
|
| - * can be used to track preparation of the database. The
|
| - * metadata field type is
|
| - * CreateDatabaseMetadata. The
|
| - * response field type is
|
| - * Database, if successful.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [parent] - Required. The name of the instance that will serve the new
|
| - * database.
|
| - * Values are of the form `projects/<project>/instances/<instance>`.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * 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<Operation> create(CreateDatabaseRequest request, core.String parent) {
|
| + ProjectsInstancesDatabasesOperationsResourceApi get operations =>
|
| + new ProjectsInstancesDatabasesOperationsResourceApi(_requester);
|
| + ProjectsInstancesDatabasesSessionsResourceApi get sessions =>
|
| + new ProjectsInstancesDatabasesSessionsResourceApi(_requester);
|
| +
|
| + ProjectsInstancesDatabasesResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Creates a new Cloud Spanner database and starts to prepare it for
|
| + /// serving.
|
| + /// The returned long-running operation will
|
| + /// have a name of the format `<database_name>/operations/<operation_id>` and
|
| + /// can be used to track preparation of the database. The
|
| + /// metadata field type is
|
| + /// CreateDatabaseMetadata. The
|
| + /// response field type is
|
| + /// Database, if successful.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [parent] - Required. The name of the instance that will serve the new
|
| + /// database.
|
| + /// Values are of the form `projects/<project>/instances/<instance>`.
|
| + /// Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// 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<Operation> create(
|
| + CreateDatabaseRequest request, core.String parent) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -719,34 +714,33 @@ class ProjectsInstancesDatabasesResourceApi {
|
| throw new core.ArgumentError("Parameter parent is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/databases';
|
| + _url =
|
| + 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/databases';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Drops (aka deletes) a Cloud Spanner database.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [database] - Required. The database to be dropped.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| - *
|
| - * 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.
|
| - */
|
| + /// Drops (aka deletes) a Cloud Spanner database.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [database] - Required. The database to be dropped.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| + ///
|
| + /// 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> dropDatabase(core.String database) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -761,34 +755,32 @@ class ProjectsInstancesDatabasesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$database');
|
|
|
| - var _response = _requester.request(_url,
|
| - "DELETE",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "DELETE",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Gets the state of a Cloud Spanner database.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Required. The name of the requested database. Values are of the
|
| - * form
|
| - * `projects/<project>/instances/<instance>/databases/<database>`.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| - *
|
| - * Completes with a [Database].
|
| - *
|
| - * 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.
|
| - */
|
| + /// Gets the state of a Cloud Spanner database.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Required. The name of the requested database. Values are of the
|
| + /// form
|
| + /// `projects/<project>/instances/<instance>/databases/<database>`.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| + ///
|
| + /// Completes with a [Database].
|
| + ///
|
| + /// 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<Database> get(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -803,34 +795,33 @@ class ProjectsInstancesDatabasesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Database.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Returns the schema of a Cloud Spanner database as a list of formatted
|
| - * DDL statements. This method does not show pending schema updates, those may
|
| - * be queried using the Operations API.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [database] - Required. The database whose schema we wish to get.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| - *
|
| - * Completes with a [GetDatabaseDdlResponse].
|
| - *
|
| - * 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.
|
| - */
|
| + /// Returns the schema of a Cloud Spanner database as a list of formatted
|
| + /// DDL statements. This method does not show pending schema updates, those
|
| + /// may
|
| + /// be queried using the Operations API.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [database] - Required. The database whose schema we wish to get.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| + ///
|
| + /// Completes with a [GetDatabaseDdlResponse].
|
| + ///
|
| + /// 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<GetDatabaseDdlResponse> getDdl(core.String database) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -845,42 +836,42 @@ class ProjectsInstancesDatabasesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$database') + '/ddl';
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new GetDatabaseDdlResponse.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Gets the access control policy for a database resource. Returns an empty
|
| - * policy if a database exists but does not have a policy set.
|
| - *
|
| - * Authorization requires `spanner.databases.getIamPolicy` permission on
|
| - * resource.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [resource] - REQUIRED: The Cloud Spanner resource for which the policy is
|
| - * being retrieved. The format is `projects/<project ID>/instances/<instance
|
| - * ID>` for instance resources and `projects/<project ID>/instances/<instance
|
| - * ID>/databases/<database ID>` for database resources.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| - *
|
| - * Completes with a [Policy].
|
| - *
|
| - * 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<Policy> getIamPolicy(GetIamPolicyRequest request, core.String resource) {
|
| + /// Gets the access control policy for a database resource. Returns an empty
|
| + /// policy if a database exists but does not have a policy set.
|
| + ///
|
| + /// Authorization requires `spanner.databases.getIamPolicy` permission on
|
| + /// resource.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [resource] - REQUIRED: The Cloud Spanner resource for which the policy is
|
| + /// being retrieved. The format is `projects/<project ID>/instances/<instance
|
| + /// ID>` for instance resources and `projects/<project
|
| + /// ID>/instances/<instance ID>/databases/<database ID>` for database
|
| + /// resources.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| + ///
|
| + /// Completes with a [Policy].
|
| + ///
|
| + /// 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<Policy> getIamPolicy(
|
| + GetIamPolicyRequest request, core.String resource) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -895,44 +886,44 @@ class ProjectsInstancesDatabasesResourceApi {
|
| throw new core.ArgumentError("Parameter resource is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':getIamPolicy';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$resource') +
|
| + ':getIamPolicy';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Policy.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Lists Cloud Spanner databases.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [parent] - Required. The instance whose databases should be listed.
|
| - * Values are of the form `projects/<project>/instances/<instance>`.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| - *
|
| - * [pageToken] - If non-empty, `page_token` should contain a
|
| - * next_page_token from a
|
| - * previous ListDatabasesResponse.
|
| - *
|
| - * [pageSize] - Number of databases to be returned in the response. If 0 or
|
| - * less,
|
| - * defaults to the server's maximum allowed page size.
|
| - *
|
| - * Completes with a [ListDatabasesResponse].
|
| - *
|
| - * 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<ListDatabasesResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
|
| + /// Lists Cloud Spanner databases.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [parent] - Required. The instance whose databases should be listed.
|
| + /// Values are of the form `projects/<project>/instances/<instance>`.
|
| + /// Value must have pattern "^projects/[^/]+/instances/[^/]+$".
|
| + ///
|
| + /// [pageToken] - If non-empty, `page_token` should contain a
|
| + /// next_page_token from a
|
| + /// previous ListDatabasesResponse.
|
| + ///
|
| + /// [pageSize] - Number of databases to be returned in the response. If 0 or
|
| + /// less,
|
| + /// defaults to the server's maximum allowed page size.
|
| + ///
|
| + /// Completes with a [ListDatabasesResponse].
|
| + ///
|
| + /// 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<ListDatabasesResponse> list(core.String parent,
|
| + {core.String pageToken, core.int pageSize}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -950,44 +941,44 @@ class ProjectsInstancesDatabasesResourceApi {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/databases';
|
| + _url =
|
| + 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/databases';
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ListDatabasesResponse.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Sets the access control policy on a database resource. Replaces any
|
| - * existing policy.
|
| - *
|
| - * Authorization requires `spanner.databases.setIamPolicy` permission on
|
| - * resource.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [resource] - REQUIRED: The Cloud Spanner resource for which the policy is
|
| - * being set. The format is `projects/<project ID>/instances/<instance ID>`
|
| - * for instance resources and `projects/<project ID>/instances/<instance
|
| - * ID>/databases/<database ID>` for databases resources.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| - *
|
| - * Completes with a [Policy].
|
| - *
|
| - * 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<Policy> setIamPolicy(SetIamPolicyRequest request, core.String resource) {
|
| + /// Sets the access control policy on a database resource. Replaces any
|
| + /// existing policy.
|
| + ///
|
| + /// Authorization requires `spanner.databases.setIamPolicy` permission on
|
| + /// resource.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [resource] - REQUIRED: The Cloud Spanner resource for which the policy is
|
| + /// being set. The format is `projects/<project ID>/instances/<instance ID>`
|
| + /// for instance resources and `projects/<project ID>/instances/<instance
|
| + /// ID>/databases/<database ID>` for databases resources.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| + ///
|
| + /// Completes with a [Policy].
|
| + ///
|
| + /// 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<Policy> setIamPolicy(
|
| + SetIamPolicyRequest request, core.String resource) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1002,45 +993,49 @@ class ProjectsInstancesDatabasesResourceApi {
|
| throw new core.ArgumentError("Parameter resource is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':setIamPolicy';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$resource') +
|
| + ':setIamPolicy';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Policy.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Returns permissions that the caller has on the specified database resource.
|
| - *
|
| - * Attempting this RPC on a non-existent Cloud Spanner database will result in
|
| - * a NOT_FOUND error if the user has `spanner.databases.list` permission on
|
| - * the containing Cloud Spanner instance. Otherwise returns an empty set of
|
| - * permissions.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [resource] - REQUIRED: The Cloud Spanner resource for which permissions are
|
| - * being tested. The format is `projects/<project ID>/instances/<instance ID>`
|
| - * for instance resources and `projects/<project ID>/instances/<instance
|
| - * ID>/databases/<database ID>` for database resources.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| - *
|
| - * Completes with a [TestIamPermissionsResponse].
|
| - *
|
| - * 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<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request, core.String resource) {
|
| + /// Returns permissions that the caller has on the specified database
|
| + /// resource.
|
| + ///
|
| + /// Attempting this RPC on a non-existent Cloud Spanner database will result
|
| + /// in
|
| + /// a NOT_FOUND error if the user has `spanner.databases.list` permission on
|
| + /// the containing Cloud Spanner instance. Otherwise returns an empty set of
|
| + /// permissions.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [resource] - REQUIRED: The Cloud Spanner resource for which permissions
|
| + /// are being tested. The format is `projects/<project
|
| + /// ID>/instances/<instance ID>` for instance resources and
|
| + /// `projects/<project ID>/instances/<instance ID>/databases/<database ID>`
|
| + /// for database resources.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| + ///
|
| + /// Completes with a [TestIamPermissionsResponse].
|
| + ///
|
| + /// 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<TestIamPermissionsResponse> testIamPermissions(
|
| + TestIamPermissionsRequest request, core.String resource) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1055,43 +1050,45 @@ class ProjectsInstancesDatabasesResourceApi {
|
| throw new core.ArgumentError("Parameter resource is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':testIamPermissions';
|
| -
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new TestIamPermissionsResponse.fromJson(data));
|
| - }
|
| -
|
| - /**
|
| - * Updates the schema of a Cloud Spanner database by
|
| - * creating/altering/dropping tables, columns, indexes, etc. The returned
|
| - * long-running operation will have a name of
|
| - * the format `<database_name>/operations/<operation_id>` and can be used to
|
| - * track execution of the schema change(s). The
|
| - * metadata field type is
|
| - * UpdateDatabaseDdlMetadata. The operation has no response.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [database] - Required. The database to update.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * 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<Operation> updateDdl(UpdateDatabaseDdlRequest request, core.String database) {
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$resource') +
|
| + ':testIamPermissions';
|
| +
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response
|
| + .then((data) => new TestIamPermissionsResponse.fromJson(data));
|
| + }
|
| +
|
| + /// Updates the schema of a Cloud Spanner database by
|
| + /// creating/altering/dropping tables, columns, indexes, etc. The returned
|
| + /// long-running operation will have a name of
|
| + /// the format `<database_name>/operations/<operation_id>` and can be used to
|
| + /// track execution of the schema change(s). The
|
| + /// metadata field type is
|
| + /// UpdateDatabaseDdlMetadata. The operation has no response.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [database] - Required. The database to update.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// 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<Operation> updateDdl(
|
| + UpdateDatabaseDdlRequest request, core.String database) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1108,51 +1105,46 @@ class ProjectsInstancesDatabasesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$database') + '/ddl';
|
|
|
| - var _response = _requester.request(_url,
|
| - "PATCH",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "PATCH",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class ProjectsInstancesDatabasesOperationsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsInstancesDatabasesOperationsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Starts asynchronous cancellation on a long-running operation. The server
|
| - * makes a best effort to cancel the operation, but success is not
|
| - * guaranteed. If the server doesn't support this method, it returns
|
| - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
| - * Operations.GetOperation or
|
| - * other methods to check whether the cancellation succeeded or whether the
|
| - * operation completed despite cancellation. On successful cancellation,
|
| - * the operation is not deleted; instead, it becomes an operation with
|
| - * an Operation.error value with a google.rpc.Status.code of 1,
|
| - * corresponding to `Code.CANCELLED`.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - The name of the operation resource to be cancelled.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$".
|
| - *
|
| - * 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.
|
| - */
|
| + ProjectsInstancesDatabasesOperationsResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Starts asynchronous cancellation on a long-running operation. The server
|
| + /// makes a best effort to cancel the operation, but success is not
|
| + /// guaranteed. If the server doesn't support this method, it returns
|
| + /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
| + /// Operations.GetOperation or
|
| + /// other methods to check whether the cancellation succeeded or whether the
|
| + /// operation completed despite cancellation. On successful cancellation,
|
| + /// the operation is not deleted; instead, it becomes an operation with
|
| + /// an Operation.error value with a google.rpc.Status.code of 1,
|
| + /// corresponding to `Code.CANCELLED`.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - The name of the operation resource to be cancelled.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$".
|
| + ///
|
| + /// 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> cancel(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1167,36 +1159,34 @@ class ProjectsInstancesDatabasesOperationsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * 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
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$".
|
| - *
|
| - * 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.
|
| - */
|
| + /// 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
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$".
|
| + ///
|
| + /// 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) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1211,35 +1201,33 @@ class ProjectsInstancesDatabasesOperationsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "DELETE",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "DELETE",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Gets the latest state of a long-running operation. Clients can use this
|
| - * method to poll the operation result at intervals as recommended by the API
|
| - * service.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - The name of the operation resource.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * 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.
|
| - */
|
| + /// Gets the latest state of a long-running operation. Clients can use this
|
| + /// method to poll the operation result at intervals as recommended by the
|
| + /// API
|
| + /// service.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - The name of the operation resource.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// 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<Operation> get(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1254,49 +1242,48 @@ class ProjectsInstancesDatabasesOperationsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.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
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$".
|
| - *
|
| - * [pageToken] - The standard list page token.
|
| - *
|
| - * [pageSize] - The standard list page size.
|
| - *
|
| - * [filter] - The standard list filter.
|
| - *
|
| - * 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 pageToken, core.int pageSize, core.String filter}) {
|
| + /// 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
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$".
|
| + ///
|
| + /// [filter] - The standard list filter.
|
| + ///
|
| + /// [pageToken] - The standard list page token.
|
| + ///
|
| + /// [pageSize] - The standard list page size.
|
| + ///
|
| + /// 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.String pageToken, core.int pageSize}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1307,60 +1294,56 @@ class ProjectsInstancesDatabasesOperationsResourceApi {
|
| if (name == null) {
|
| throw new core.ArgumentError("Parameter name is required.");
|
| }
|
| + if (filter != null) {
|
| + _queryParams["filter"] = [filter];
|
| + }
|
| if (pageToken != null) {
|
| _queryParams["pageToken"] = [pageToken];
|
| }
|
| if (pageSize != null) {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
| - if (filter != null) {
|
| - _queryParams["filter"] = [filter];
|
| - }
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ListOperationsResponse.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class ProjectsInstancesDatabasesSessionsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsInstancesDatabasesSessionsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Begins a new transaction. This step can often be skipped:
|
| - * Read, ExecuteSql and
|
| - * Commit can begin a new transaction as a
|
| - * side-effect.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [session] - Required. The session in which the transaction runs.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * Completes with a [Transaction].
|
| - *
|
| - * 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<Transaction> beginTransaction(BeginTransactionRequest request, core.String session) {
|
| + ProjectsInstancesDatabasesSessionsResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Begins a new transaction. This step can often be skipped:
|
| + /// Read, ExecuteSql and
|
| + /// Commit can begin a new transaction as a
|
| + /// side-effect.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [session] - Required. The session in which the transaction runs.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// Completes with a [Transaction].
|
| + ///
|
| + /// 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<Transaction> beginTransaction(
|
| + BeginTransactionRequest request, core.String session) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1375,46 +1358,46 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
| throw new core.ArgumentError("Parameter session is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':beginTransaction';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$session') +
|
| + ':beginTransaction';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Transaction.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Commits a transaction. The request includes the mutations to be
|
| - * applied to rows in the database.
|
| - *
|
| - * `Commit` might return an `ABORTED` error. This can occur at any time;
|
| - * commonly, the cause is conflicts with concurrent
|
| - * transactions. However, it can also happen for a variety of other
|
| - * reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
|
| - * the transaction from the beginning, re-using the same session.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [session] - Required. The session in which the transaction to be committed
|
| - * is running.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * Completes with a [CommitResponse].
|
| - *
|
| - * 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<CommitResponse> commit(CommitRequest request, core.String session) {
|
| + /// Commits a transaction. The request includes the mutations to be
|
| + /// applied to rows in the database.
|
| + ///
|
| + /// `Commit` might return an `ABORTED` error. This can occur at any time;
|
| + /// commonly, the cause is conflicts with concurrent
|
| + /// transactions. However, it can also happen for a variety of other
|
| + /// reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
|
| + /// the transaction from the beginning, re-using the same session.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [session] - Required. The session in which the transaction to be
|
| + /// committed is running.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// Completes with a [CommitResponse].
|
| + ///
|
| + /// 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<CommitResponse> commit(
|
| + CommitRequest request, core.String session) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1429,52 +1412,52 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
| throw new core.ArgumentError("Parameter session is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':commit';
|
| + _url =
|
| + 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':commit';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new CommitResponse.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Creates a new session. A session can be used to perform
|
| - * transactions that read and/or modify data in a Cloud Spanner database.
|
| - * Sessions are meant to be reused for many consecutive
|
| - * transactions.
|
| - *
|
| - * Sessions can only execute one transaction at a time. To execute
|
| - * multiple concurrent read-write/write-only transactions, create
|
| - * multiple sessions. Note that standalone reads and queries use a
|
| - * transaction internally, and count toward the one transaction
|
| - * limit.
|
| - *
|
| - * Cloud Spanner limits the number of sessions that can exist at any given
|
| - * time; thus, it is a good idea to delete idle and/or unneeded sessions.
|
| - * Aside from explicit deletes, Cloud Spanner can delete sessions for which no
|
| - * operations are sent for more than an hour. If a session is deleted,
|
| - * requests to it return `NOT_FOUND`.
|
| - *
|
| - * Idle sessions can be kept alive by sending a trivial SQL query
|
| - * periodically, e.g., `"SELECT 1"`.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [database] - Required. The database in which the new session is created.
|
| - * Value must have pattern "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| - *
|
| - * Completes with a [Session].
|
| - *
|
| - * 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.
|
| - */
|
| + /// Creates a new session. A session can be used to perform
|
| + /// transactions that read and/or modify data in a Cloud Spanner database.
|
| + /// Sessions are meant to be reused for many consecutive
|
| + /// transactions.
|
| + ///
|
| + /// Sessions can only execute one transaction at a time. To execute
|
| + /// multiple concurrent read-write/write-only transactions, create
|
| + /// multiple sessions. Note that standalone reads and queries use a
|
| + /// transaction internally, and count toward the one transaction
|
| + /// limit.
|
| + ///
|
| + /// Cloud Spanner limits the number of sessions that can exist at any given
|
| + /// time; thus, it is a good idea to delete idle and/or unneeded sessions.
|
| + /// Aside from explicit deletes, Cloud Spanner can delete sessions for which
|
| + /// no
|
| + /// operations are sent for more than an hour. If a session is deleted,
|
| + /// requests to it return `NOT_FOUND`.
|
| + ///
|
| + /// Idle sessions can be kept alive by sending a trivial SQL query
|
| + /// periodically, e.g., `"SELECT 1"`.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [database] - Required. The database in which the new session is created.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+$".
|
| + ///
|
| + /// Completes with a [Session].
|
| + ///
|
| + /// 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<Session> create(core.String database) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1487,35 +1470,34 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
| throw new core.ArgumentError("Parameter database is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$database') + '/sessions';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$database') +
|
| + '/sessions';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Session.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Ends a session, releasing server resources associated with it.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Required. The name of the session to delete.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * 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.
|
| - */
|
| + /// Ends a session, releasing server resources associated with it.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Required. The name of the session to delete.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// 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) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1530,47 +1512,45 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "DELETE",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "DELETE",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Executes an SQL query, returning all rows in a single reply. This
|
| - * method cannot be used to return a result set larger than 10 MiB;
|
| - * if the query yields more data than that, the query fails with
|
| - * a `FAILED_PRECONDITION` error.
|
| - *
|
| - * Queries inside read-write transactions might return `ABORTED`. If
|
| - * this occurs, the application should restart the transaction from
|
| - * the beginning. See Transaction for more details.
|
| - *
|
| - * Larger result sets can be fetched in streaming fashion by calling
|
| - * ExecuteStreamingSql instead.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [session] - Required. The session in which the SQL query should be
|
| - * performed.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * Completes with a [ResultSet].
|
| - *
|
| - * 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<ResultSet> executeSql(ExecuteSqlRequest request, core.String session) {
|
| + /// Executes an SQL query, returning all rows in a single reply. This
|
| + /// method cannot be used to return a result set larger than 10 MiB;
|
| + /// if the query yields more data than that, the query fails with
|
| + /// a `FAILED_PRECONDITION` error.
|
| + ///
|
| + /// Queries inside read-write transactions might return `ABORTED`. If
|
| + /// this occurs, the application should restart the transaction from
|
| + /// the beginning. See Transaction for more details.
|
| + ///
|
| + /// Larger result sets can be fetched in streaming fashion by calling
|
| + /// ExecuteStreamingSql instead.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [session] - Required. The session in which the SQL query should be
|
| + /// performed.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// Completes with a [ResultSet].
|
| + ///
|
| + /// 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<ResultSet> executeSql(
|
| + ExecuteSqlRequest request, core.String session) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1585,43 +1565,43 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
| throw new core.ArgumentError("Parameter session is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':executeSql';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$session') +
|
| + ':executeSql';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ResultSet.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Like ExecuteSql, except returns the result
|
| - * set as a stream. Unlike ExecuteSql, there
|
| - * is no limit on the size of the returned result set. However, no
|
| - * individual row in the result set can exceed 100 MiB, and no
|
| - * column value can exceed 10 MiB.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [session] - Required. The session in which the SQL query should be
|
| - * performed.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * Completes with a [PartialResultSet].
|
| - *
|
| - * 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<PartialResultSet> executeStreamingSql(ExecuteSqlRequest request, core.String session) {
|
| + /// Like ExecuteSql, except returns the result
|
| + /// set as a stream. Unlike ExecuteSql, there
|
| + /// is no limit on the size of the returned result set. However, no
|
| + /// individual row in the result set can exceed 100 MiB, and no
|
| + /// column value can exceed 10 MiB.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [session] - Required. The session in which the SQL query should be
|
| + /// performed.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// Completes with a [PartialResultSet].
|
| + ///
|
| + /// 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<PartialResultSet> executeStreamingSql(
|
| + ExecuteSqlRequest request, core.String session) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1636,37 +1616,36 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
| throw new core.ArgumentError("Parameter session is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':executeStreamingSql';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$session') +
|
| + ':executeStreamingSql';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new PartialResultSet.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Gets a session. Returns `NOT_FOUND` if the session does not exist.
|
| - * This is mainly useful for determining whether a session is still
|
| - * alive.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Required. The name of the session to retrieve.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * Completes with a [Session].
|
| - *
|
| - * 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.
|
| - */
|
| + /// Gets a session. Returns `NOT_FOUND` if the session does not exist.
|
| + /// This is mainly useful for determining whether a session is still
|
| + /// alive.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Required. The name of the session to retrieve.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// Completes with a [Session].
|
| + ///
|
| + /// 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<Session> get(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1681,47 +1660,44 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Session.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Reads rows from the database using key lookups and scans, as a
|
| - * simple key/value style alternative to
|
| - * ExecuteSql. This method cannot be used to
|
| - * return a result set larger than 10 MiB; if the read matches more
|
| - * data than that, the read fails with a `FAILED_PRECONDITION`
|
| - * error.
|
| - *
|
| - * Reads inside read-write transactions might return `ABORTED`. If
|
| - * this occurs, the application should restart the transaction from
|
| - * the beginning. See Transaction for more details.
|
| - *
|
| - * Larger result sets can be yielded in streaming fashion by calling
|
| - * StreamingRead instead.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [session] - Required. The session in which the read should be performed.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * Completes with a [ResultSet].
|
| - *
|
| - * 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.
|
| - */
|
| + /// Reads rows from the database using key lookups and scans, as a
|
| + /// simple key/value style alternative to
|
| + /// ExecuteSql. This method cannot be used to
|
| + /// return a result set larger than 10 MiB; if the read matches more
|
| + /// data than that, the read fails with a `FAILED_PRECONDITION`
|
| + /// error.
|
| + ///
|
| + /// Reads inside read-write transactions might return `ABORTED`. If
|
| + /// this occurs, the application should restart the transaction from
|
| + /// the beginning. See Transaction for more details.
|
| + ///
|
| + /// Larger result sets can be yielded in streaming fashion by calling
|
| + /// StreamingRead instead.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [session] - Required. The session in which the read should be performed.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// Completes with a [ResultSet].
|
| + ///
|
| + /// 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<ResultSet> read(ReadRequest request, core.String session) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1739,43 +1715,40 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':read';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ResultSet.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Rolls back a transaction, releasing any locks it holds. It is a good
|
| - * idea to call this for any transaction that includes one or more
|
| - * Read or ExecuteSql requests and
|
| - * ultimately decides not to commit.
|
| - *
|
| - * `Rollback` returns `OK` if it successfully aborts the transaction, the
|
| - * transaction was already aborted, or the transaction is not
|
| - * found. `Rollback` never returns `ABORTED`.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [session] - Required. The session in which the transaction to roll back is
|
| - * running.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * 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.
|
| - */
|
| + /// Rolls back a transaction, releasing any locks it holds. It is a good
|
| + /// idea to call this for any transaction that includes one or more
|
| + /// Read or ExecuteSql requests and
|
| + /// ultimately decides not to commit.
|
| + ///
|
| + /// `Rollback` returns `OK` if it successfully aborts the transaction, the
|
| + /// transaction was already aborted, or the transaction is not
|
| + /// found. `Rollback` never returns `ABORTED`.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [session] - Required. The session in which the transaction to roll back
|
| + /// is running.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// 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> rollback(RollbackRequest request, core.String session) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1791,42 +1764,41 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
| throw new core.ArgumentError("Parameter session is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':rollback';
|
| + _url =
|
| + 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':rollback';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Like Read, except returns the result set as a
|
| - * stream. Unlike Read, there is no limit on the
|
| - * size of the returned result set. However, no individual row in
|
| - * the result set can exceed 100 MiB, and no column value can exceed
|
| - * 10 MiB.
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [session] - Required. The session in which the read should be performed.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| - *
|
| - * Completes with a [PartialResultSet].
|
| - *
|
| - * 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<PartialResultSet> streamingRead(ReadRequest request, core.String session) {
|
| + /// Like Read, except returns the result set as a
|
| + /// stream. Unlike Read, there is no limit on the
|
| + /// size of the returned result set. However, no individual row in
|
| + /// the result set can exceed 100 MiB, and no column value can exceed
|
| + /// 10 MiB.
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [session] - Required. The session in which the read should be performed.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$".
|
| + ///
|
| + /// Completes with a [PartialResultSet].
|
| + ///
|
| + /// 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<PartialResultSet> streamingRead(
|
| + ReadRequest request, core.String session) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -1841,53 +1813,50 @@ class ProjectsInstancesDatabasesSessionsResourceApi {
|
| throw new core.ArgumentError("Parameter session is required.");
|
| }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$session') + ':streamingRead';
|
| + _url = 'v1/' +
|
| + commons.Escaper.ecapeVariableReserved('$session') +
|
| + ':streamingRead';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new PartialResultSet.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class ProjectsInstancesOperationsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsInstancesOperationsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Starts asynchronous cancellation on a long-running operation. The server
|
| - * makes a best effort to cancel the operation, but success is not
|
| - * guaranteed. If the server doesn't support this method, it returns
|
| - * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
| - * Operations.GetOperation or
|
| - * other methods to check whether the cancellation succeeded or whether the
|
| - * operation completed despite cancellation. On successful cancellation,
|
| - * the operation is not deleted; instead, it becomes an operation with
|
| - * an Operation.error value with a google.rpc.Status.code of 1,
|
| - * corresponding to `Code.CANCELLED`.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - The name of the operation resource to be cancelled.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/operations/[^/]+$".
|
| - *
|
| - * 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.
|
| - */
|
| + ProjectsInstancesOperationsResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Starts asynchronous cancellation on a long-running operation. The server
|
| + /// makes a best effort to cancel the operation, but success is not
|
| + /// guaranteed. If the server doesn't support this method, it returns
|
| + /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
| + /// Operations.GetOperation or
|
| + /// other methods to check whether the cancellation succeeded or whether the
|
| + /// operation completed despite cancellation. On successful cancellation,
|
| + /// the operation is not deleted; instead, it becomes an operation with
|
| + /// an Operation.error value with a google.rpc.Status.code of 1,
|
| + /// corresponding to `Code.CANCELLED`.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - The name of the operation resource to be cancelled.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/operations/[^/]+$".
|
| + ///
|
| + /// 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> cancel(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1902,36 +1871,34 @@ class ProjectsInstancesOperationsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel';
|
|
|
| - var _response = _requester.request(_url,
|
| - "POST",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "POST",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * 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
|
| - * "^projects/[^/]+/instances/[^/]+/operations/[^/]+$".
|
| - *
|
| - * 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.
|
| - */
|
| + /// 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
|
| + /// "^projects/[^/]+/instances/[^/]+/operations/[^/]+$".
|
| + ///
|
| + /// 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) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1946,35 +1913,33 @@ class ProjectsInstancesOperationsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "DELETE",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "DELETE",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Empty.fromJson(data));
|
| }
|
|
|
| - /**
|
| - * Gets the latest state of a long-running operation. Clients can use this
|
| - * method to poll the operation result at intervals as recommended by the API
|
| - * service.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - The name of the operation resource.
|
| - * Value must have pattern
|
| - * "^projects/[^/]+/instances/[^/]+/operations/[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * 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.
|
| - */
|
| + /// Gets the latest state of a long-running operation. Clients can use this
|
| + /// method to poll the operation result at intervals as recommended by the
|
| + /// API
|
| + /// service.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - The name of the operation resource.
|
| + /// Value must have pattern
|
| + /// "^projects/[^/]+/instances/[^/]+/operations/[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// 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<Operation> get(core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| @@ -1989,48 +1954,47 @@ class ProjectsInstancesOperationsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new Operation.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 "^projects/[^/]+/instances/[^/]+/operations$".
|
| - *
|
| - * [filter] - The standard list filter.
|
| - *
|
| - * [pageToken] - The standard list page token.
|
| - *
|
| - * [pageSize] - The standard list page size.
|
| - *
|
| - * 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.String pageToken, core.int pageSize}) {
|
| + /// 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 "^projects/[^/]+/instances/[^/]+/operations$".
|
| + ///
|
| + /// [filter] - The standard list filter.
|
| + ///
|
| + /// [pageToken] - The standard list page token.
|
| + ///
|
| + /// [pageSize] - The standard list page size.
|
| + ///
|
| + /// 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.String pageToken, core.int pageSize}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -2053,210 +2017,19 @@ class ProjectsInstancesOperationsResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| return _response.then((data) => new ListOperationsResponse.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| -
|
| -/**
|
| - * Specifies the audit configuration for a service.
|
| - * The configuration determines which permission types are logged, and what
|
| - * identities, if any, are exempted from logging.
|
| - * An AuditConfig must have one or more AuditLogConfigs.
|
| - *
|
| - * If there are AuditConfigs for both `allServices` and a specific service,
|
| - * the union of the two AuditConfigs is used for that service: the log_types
|
| - * specified in each AuditConfig are enabled, and the exempted_members in each
|
| - * AuditConfig are exempted.
|
| - *
|
| - * Example Policy with multiple AuditConfigs:
|
| - *
|
| - * {
|
| - * "audit_configs": [
|
| - * {
|
| - * "service": "allServices"
|
| - * "audit_log_configs": [
|
| - * {
|
| - * "log_type": "DATA_READ",
|
| - * "exempted_members": [
|
| - * "user:foo@gmail.com"
|
| - * ]
|
| - * },
|
| - * {
|
| - * "log_type": "DATA_WRITE",
|
| - * },
|
| - * {
|
| - * "log_type": "ADMIN_READ",
|
| - * }
|
| - * ]
|
| - * },
|
| - * {
|
| - * "service": "fooservice.googleapis.com"
|
| - * "audit_log_configs": [
|
| - * {
|
| - * "log_type": "DATA_READ",
|
| - * },
|
| - * {
|
| - * "log_type": "DATA_WRITE",
|
| - * "exempted_members": [
|
| - * "user:bar@gmail.com"
|
| - * ]
|
| - * }
|
| - * ]
|
| - * }
|
| - * ]
|
| - * }
|
| - *
|
| - * For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
|
| - * logging. It also exempts foo@gmail.com from DATA_READ logging, and
|
| - * bar@gmail.com from DATA_WRITE logging.
|
| - */
|
| -class AuditConfig {
|
| - /**
|
| - * The configuration for logging of each type of permission.
|
| - * Next ID: 4
|
| - */
|
| - core.List<AuditLogConfig> auditLogConfigs;
|
| - core.List<core.String> exemptedMembers;
|
| - /**
|
| - * Specifies a service that will be enabled for audit logging.
|
| - * For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
|
| - * `allServices` is a special value that covers all services.
|
| - */
|
| - core.String service;
|
| -
|
| - AuditConfig();
|
| -
|
| - AuditConfig.fromJson(core.Map _json) {
|
| - if (_json.containsKey("auditLogConfigs")) {
|
| - auditLogConfigs = _json["auditLogConfigs"].map((value) => new AuditLogConfig.fromJson(value)).toList();
|
| - }
|
| - if (_json.containsKey("exemptedMembers")) {
|
| - exemptedMembers = _json["exemptedMembers"];
|
| - }
|
| - if (_json.containsKey("service")) {
|
| - service = _json["service"];
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (auditLogConfigs != null) {
|
| - _json["auditLogConfigs"] = auditLogConfigs.map((value) => (value).toJson()).toList();
|
| - }
|
| - if (exemptedMembers != null) {
|
| - _json["exemptedMembers"] = exemptedMembers;
|
| - }
|
| - if (service != null) {
|
| - _json["service"] = service;
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/**
|
| - * Provides the configuration for logging a type of permissions.
|
| - * Example:
|
| - *
|
| - * {
|
| - * "audit_log_configs": [
|
| - * {
|
| - * "log_type": "DATA_READ",
|
| - * "exempted_members": [
|
| - * "user:foo@gmail.com"
|
| - * ]
|
| - * },
|
| - * {
|
| - * "log_type": "DATA_WRITE",
|
| - * }
|
| - * ]
|
| - * }
|
| - *
|
| - * This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
|
| - * foo@gmail.com from DATA_READ logging.
|
| - */
|
| -class AuditLogConfig {
|
| - /**
|
| - * Specifies the identities that do not cause logging for this type of
|
| - * permission.
|
| - * Follows the same format of Binding.members.
|
| - */
|
| - core.List<core.String> exemptedMembers;
|
| - /**
|
| - * The log type that this config enables.
|
| - * Possible string values are:
|
| - * - "LOG_TYPE_UNSPECIFIED" : Default case. Should never be this.
|
| - * - "ADMIN_READ" : Admin reads. Example: CloudIAM getIamPolicy
|
| - * - "DATA_WRITE" : Data writes. Example: CloudSQL Users create
|
| - * - "DATA_READ" : Data reads. Example: CloudSQL Users list
|
| - */
|
| - core.String logType;
|
| -
|
| - AuditLogConfig();
|
| -
|
| - AuditLogConfig.fromJson(core.Map _json) {
|
| - if (_json.containsKey("exemptedMembers")) {
|
| - exemptedMembers = _json["exemptedMembers"];
|
| - }
|
| - if (_json.containsKey("logType")) {
|
| - logType = _json["logType"];
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (exemptedMembers != null) {
|
| - _json["exemptedMembers"] = exemptedMembers;
|
| - }
|
| - if (logType != null) {
|
| - _json["logType"] = logType;
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/** Authorization-related information used by Cloud Audit Logging. */
|
| -class AuthorizationLoggingOptions {
|
| - /**
|
| - * The type of the permission that was checked.
|
| - * Possible string values are:
|
| - * - "PERMISSION_TYPE_UNSPECIFIED" : Default. Should not be used.
|
| - * - "ADMIN_READ" : A read of admin (meta) data.
|
| - * - "ADMIN_WRITE" : A write of admin (meta) data.
|
| - * - "DATA_READ" : A read of standard data.
|
| - * - "DATA_WRITE" : A write of standard data.
|
| - */
|
| - core.String permissionType;
|
| -
|
| - AuthorizationLoggingOptions();
|
| -
|
| - AuthorizationLoggingOptions.fromJson(core.Map _json) {
|
| - if (_json.containsKey("permissionType")) {
|
| - permissionType = _json["permissionType"];
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (permissionType != null) {
|
| - _json["permissionType"] = permissionType;
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/** The request for BeginTransaction. */
|
| +/// The request for BeginTransaction.
|
| class BeginTransactionRequest {
|
| - /** Required. Options for the new transaction. */
|
| + /// Required. Options for the new transaction.
|
| TransactionOptions options;
|
|
|
| BeginTransactionRequest();
|
| @@ -2268,7 +2041,8 @@ class BeginTransactionRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (options != null) {
|
| _json["options"] = (options).toJson();
|
| }
|
| @@ -2276,54 +2050,40 @@ class BeginTransactionRequest {
|
| }
|
| }
|
|
|
| -/** Associates `members` with a `role`. */
|
| +/// Associates `members` with a `role`.
|
| class Binding {
|
| - /**
|
| - * The condition that is associated with this binding.
|
| - * NOTE: an unsatisfied condition will not allow user access via current
|
| - * binding. Different bindings, including their conditions, are examined
|
| - * independently.
|
| - * This field is GOOGLE_INTERNAL.
|
| - */
|
| - Expr condition;
|
| - /**
|
| - * Specifies the identities requesting access for a Cloud Platform resource.
|
| - * `members` can have the following values:
|
| - *
|
| - * * `allUsers`: A special identifier that represents anyone who is
|
| - * on the internet; with or without a Google account.
|
| - *
|
| - * * `allAuthenticatedUsers`: A special identifier that represents anyone
|
| - * who is authenticated with a Google account or a service account.
|
| - *
|
| - * * `user:{emailid}`: An email address that represents a specific Google
|
| - * account. For example, `alice@gmail.com` or `joe@example.com`.
|
| - *
|
| - *
|
| - * * `serviceAccount:{emailid}`: An email address that represents a service
|
| - * account. For example, `my-other-app@appspot.gserviceaccount.com`.
|
| - *
|
| - * * `group:{emailid}`: An email address that represents a Google group.
|
| - * For example, `admins@example.com`.
|
| - *
|
| - *
|
| - * * `domain:{domain}`: A Google Apps domain name that represents all the
|
| - * users of that domain. For example, `google.com` or `example.com`.
|
| - */
|
| + /// Specifies the identities requesting access for a Cloud Platform resource.
|
| + /// `members` can have the following values:
|
| + ///
|
| + /// * `allUsers`: A special identifier that represents anyone who is
|
| + /// on the internet; with or without a Google account.
|
| + ///
|
| + /// * `allAuthenticatedUsers`: A special identifier that represents anyone
|
| + /// who is authenticated with a Google account or a service account.
|
| + ///
|
| + /// * `user:{emailid}`: An email address that represents a specific Google
|
| + /// account. For example, `alice@gmail.com` or `joe@example.com`.
|
| + ///
|
| + ///
|
| + /// * `serviceAccount:{emailid}`: An email address that represents a service
|
| + /// account. For example, `my-other-app@appspot.gserviceaccount.com`.
|
| + ///
|
| + /// * `group:{emailid}`: An email address that represents a Google group.
|
| + /// For example, `admins@example.com`.
|
| + ///
|
| + ///
|
| + /// * `domain:{domain}`: A Google Apps domain name that represents all the
|
| + /// users of that domain. For example, `google.com` or `example.com`.
|
| core.List<core.String> members;
|
| - /**
|
| - * Role that is assigned to `members`.
|
| - * For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
| - * Required
|
| - */
|
| +
|
| + /// Role that is assigned to `members`.
|
| + /// For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
| + /// Required
|
| core.String role;
|
|
|
| Binding();
|
|
|
| Binding.fromJson(core.Map _json) {
|
| - if (_json.containsKey("condition")) {
|
| - condition = new Expr.fromJson(_json["condition"]);
|
| - }
|
| if (_json.containsKey("members")) {
|
| members = _json["members"];
|
| }
|
| @@ -2333,10 +2093,8 @@ class Binding {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (condition != null) {
|
| - _json["condition"] = (condition).toJson();
|
| - }
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (members != null) {
|
| _json["members"] = members;
|
| }
|
| @@ -2347,30 +2105,26 @@ class Binding {
|
| }
|
| }
|
|
|
| -/**
|
| - * Metadata associated with a parent-child relationship appearing in a
|
| - * PlanNode.
|
| - */
|
| +/// Metadata associated with a parent-child relationship appearing in a
|
| +/// PlanNode.
|
| class ChildLink {
|
| - /** The node to which the link points. */
|
| + /// The node to which the link points.
|
| core.int childIndex;
|
| - /**
|
| - * The type of the link. For example, in Hash Joins this could be used to
|
| - * distinguish between the build child and the probe child, or in the case
|
| - * of the child being an output variable, to represent the tag associated
|
| - * with the output variable.
|
| - */
|
| +
|
| + /// The type of the link. For example, in Hash Joins this could be used to
|
| + /// distinguish between the build child and the probe child, or in the case
|
| + /// of the child being an output variable, to represent the tag associated
|
| + /// with the output variable.
|
| core.String type;
|
| - /**
|
| - * Only present if the child node is SCALAR and corresponds
|
| - * to an output variable of the parent node. The field carries the name of
|
| - * the output variable.
|
| - * For example, a `TableScan` operator that reads rows from a table will
|
| - * have child links to the `SCALAR` nodes representing the output variables
|
| - * created for each column that is read by the operator. The corresponding
|
| - * `variable` fields will be set to the variable names assigned to the
|
| - * columns.
|
| - */
|
| +
|
| + /// Only present if the child node is SCALAR and corresponds
|
| + /// to an output variable of the parent node. The field carries the name of
|
| + /// the output variable.
|
| + /// For example, a `TableScan` operator that reads rows from a table will
|
| + /// have child links to the `SCALAR` nodes representing the output variables
|
| + /// created for each column that is read by the operator. The corresponding
|
| + /// `variable` fields will be set to the variable names assigned to the
|
| + /// columns.
|
| core.String variable;
|
|
|
| ChildLink();
|
| @@ -2388,7 +2142,8 @@ class ChildLink {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (childIndex != null) {
|
| _json["childIndex"] = childIndex;
|
| }
|
| @@ -2402,80 +2157,46 @@ class ChildLink {
|
| }
|
| }
|
|
|
| -/** Write a Cloud Audit log */
|
| -class CloudAuditOptions {
|
| - /** Information used by the Cloud Audit Logging pipeline. */
|
| - AuthorizationLoggingOptions authorizationLoggingOptions;
|
| - /**
|
| - * The log_name to populate in the Cloud Audit Record.
|
| - * Possible string values are:
|
| - * - "UNSPECIFIED_LOG_NAME" : Default. Should not be used.
|
| - * - "ADMIN_ACTIVITY" : Corresponds to "cloudaudit.googleapis.com/activity"
|
| - * - "DATA_ACCESS" : Corresponds to "cloudaudit.googleapis.com/data_access"
|
| - */
|
| - core.String logName;
|
| -
|
| - CloudAuditOptions();
|
| -
|
| - CloudAuditOptions.fromJson(core.Map _json) {
|
| - if (_json.containsKey("authorizationLoggingOptions")) {
|
| - authorizationLoggingOptions = new AuthorizationLoggingOptions.fromJson(_json["authorizationLoggingOptions"]);
|
| - }
|
| - if (_json.containsKey("logName")) {
|
| - logName = _json["logName"];
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (authorizationLoggingOptions != null) {
|
| - _json["authorizationLoggingOptions"] = (authorizationLoggingOptions).toJson();
|
| - }
|
| - if (logName != null) {
|
| - _json["logName"] = logName;
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/** The request for Commit. */
|
| +/// The request for Commit.
|
| class CommitRequest {
|
| - /**
|
| - * The mutations to be executed when this transaction commits. All
|
| - * mutations are applied atomically, in the order they appear in
|
| - * this list.
|
| - */
|
| + /// The mutations to be executed when this transaction commits. All
|
| + /// mutations are applied atomically, in the order they appear in
|
| + /// this list.
|
| core.List<Mutation> mutations;
|
| - /**
|
| - * Execute mutations in a temporary transaction. Note that unlike
|
| - * commit of a previously-started transaction, commit with a
|
| - * temporary transaction is non-idempotent. That is, if the
|
| - * `CommitRequest` is sent to Cloud Spanner more than once (for
|
| - * instance, due to retries in the application, or in the
|
| - * transport library), it is possible that the mutations are
|
| - * executed more than once. If this is undesirable, use
|
| - * BeginTransaction and
|
| - * Commit instead.
|
| - */
|
| +
|
| + /// Execute mutations in a temporary transaction. Note that unlike
|
| + /// commit of a previously-started transaction, commit with a
|
| + /// temporary transaction is non-idempotent. That is, if the
|
| + /// `CommitRequest` is sent to Cloud Spanner more than once (for
|
| + /// instance, due to retries in the application, or in the
|
| + /// transport library), it is possible that the mutations are
|
| + /// executed more than once. If this is undesirable, use
|
| + /// BeginTransaction and
|
| + /// Commit instead.
|
| TransactionOptions singleUseTransaction;
|
| - /** Commit a previously-started transaction. */
|
| +
|
| + /// Commit a previously-started transaction.
|
| core.String transactionId;
|
| core.List<core.int> get transactionIdAsBytes {
|
| return convert.BASE64.decode(transactionId);
|
| }
|
|
|
| void set transactionIdAsBytes(core.List<core.int> _bytes) {
|
| - transactionId = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + transactionId =
|
| + convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| }
|
|
|
| CommitRequest();
|
|
|
| CommitRequest.fromJson(core.Map _json) {
|
| if (_json.containsKey("mutations")) {
|
| - mutations = _json["mutations"].map((value) => new Mutation.fromJson(value)).toList();
|
| + mutations = _json["mutations"]
|
| + .map((value) => new Mutation.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("singleUseTransaction")) {
|
| - singleUseTransaction = new TransactionOptions.fromJson(_json["singleUseTransaction"]);
|
| + singleUseTransaction =
|
| + new TransactionOptions.fromJson(_json["singleUseTransaction"]);
|
| }
|
| if (_json.containsKey("transactionId")) {
|
| transactionId = _json["transactionId"];
|
| @@ -2483,7 +2204,8 @@ class CommitRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (mutations != null) {
|
| _json["mutations"] = mutations.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -2497,9 +2219,9 @@ class CommitRequest {
|
| }
|
| }
|
|
|
| -/** The response for Commit. */
|
| +/// The response for Commit.
|
| class CommitResponse {
|
| - /** The Cloud Spanner timestamp at which the transaction committed. */
|
| + /// The Cloud Spanner timestamp at which the transaction committed.
|
| core.String commitTimestamp;
|
|
|
| CommitResponse();
|
| @@ -2511,7 +2233,8 @@ class CommitResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (commitTimestamp != null) {
|
| _json["commitTimestamp"] = commitTimestamp;
|
| }
|
| @@ -2519,158 +2242,10 @@ class CommitResponse {
|
| }
|
| }
|
|
|
| -/** A condition to be met. */
|
| -class Condition {
|
| - /**
|
| - * Trusted attributes supplied by the IAM system.
|
| - * Possible string values are:
|
| - * - "NO_ATTR" : Default non-attribute.
|
| - * - "AUTHORITY" : Either principal or (if present) authority selector.
|
| - * - "ATTRIBUTION" : The principal (even if an authority selector is present),
|
| - * which
|
| - * must only be used for attribution, not authorization.
|
| - * - "SECURITY_REALM" : Any of the security realms in the IAMContext
|
| - * (go/security-realms).
|
| - * When used with IN, the condition indicates "any of the request's realms
|
| - * match one of the given values; with NOT_IN, "none of the realms match
|
| - * any of the given values". It is not permitted to grant access based on
|
| - * the *absence* of a realm, so realm conditions can only be used in
|
| - * a "positive" context (e.g., ALLOW/IN or DENY/NOT_IN).
|
| - * - "APPROVER" : An approver (distinct from the requester) that has
|
| - * authorized this
|
| - * request.
|
| - * When used with IN, the condition indicates that one of the approvers
|
| - * associated with the request matches the specified principal, or is a
|
| - * member of the specified group. Approvers can only grant additional
|
| - * access, and are thus only used in a strictly positive context
|
| - * (e.g. ALLOW/IN or DENY/NOT_IN).
|
| - * - "JUSTIFICATION_TYPE" : What types of justifications have been supplied
|
| - * with this request.
|
| - * String values should match enum names from tech.iam.JustificationType,
|
| - * e.g. "MANUAL_STRING". It is not permitted to grant access based on
|
| - * the *absence* of a justification, so justification conditions can only
|
| - * be used in a "positive" context (e.g., ALLOW/IN or DENY/NOT_IN).
|
| - *
|
| - * Multiple justifications, e.g., a Buganizer ID and a manually-entered
|
| - * reason, are normal and supported.
|
| - */
|
| - core.String iam;
|
| - /**
|
| - * An operator to apply the subject with.
|
| - * Possible string values are:
|
| - * - "NO_OP" : Default no-op.
|
| - * - "EQUALS" : DEPRECATED. Use IN instead.
|
| - * - "NOT_EQUALS" : DEPRECATED. Use NOT_IN instead.
|
| - * - "IN" : The condition is true if the subject (or any element of it if it
|
| - * is
|
| - * a set) matches any of the supplied values.
|
| - * - "NOT_IN" : The condition is true if the subject (or every element of it
|
| - * if it is
|
| - * a set) matches none of the supplied values.
|
| - * - "DISCHARGED" : Subject is discharged
|
| - */
|
| - core.String op;
|
| - /** Trusted attributes discharged by the service. */
|
| - core.String svc;
|
| - /**
|
| - * Trusted attributes supplied by any service that owns resources and uses
|
| - * the IAM system for access control.
|
| - * Possible string values are:
|
| - * - "NO_ATTR" : Default non-attribute type
|
| - * - "REGION" : Region of the resource
|
| - * - "SERVICE" : Service name
|
| - * - "NAME" : Resource name
|
| - * - "IP" : IP address of the caller
|
| - */
|
| - core.String sys;
|
| - /** DEPRECATED. Use 'values' instead. */
|
| - core.String value;
|
| - /** The objects of the condition. This is mutually exclusive with 'value'. */
|
| - core.List<core.String> values;
|
| -
|
| - Condition();
|
| -
|
| - Condition.fromJson(core.Map _json) {
|
| - if (_json.containsKey("iam")) {
|
| - iam = _json["iam"];
|
| - }
|
| - if (_json.containsKey("op")) {
|
| - op = _json["op"];
|
| - }
|
| - if (_json.containsKey("svc")) {
|
| - svc = _json["svc"];
|
| - }
|
| - if (_json.containsKey("sys")) {
|
| - sys = _json["sys"];
|
| - }
|
| - if (_json.containsKey("value")) {
|
| - value = _json["value"];
|
| - }
|
| - if (_json.containsKey("values")) {
|
| - values = _json["values"];
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (iam != null) {
|
| - _json["iam"] = iam;
|
| - }
|
| - if (op != null) {
|
| - _json["op"] = op;
|
| - }
|
| - if (svc != null) {
|
| - _json["svc"] = svc;
|
| - }
|
| - if (sys != null) {
|
| - _json["sys"] = sys;
|
| - }
|
| - if (value != null) {
|
| - _json["value"] = value;
|
| - }
|
| - if (values != null) {
|
| - _json["values"] = values;
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/** Options for counters */
|
| -class CounterOptions {
|
| - /** The field value to attribute. */
|
| - core.String field;
|
| - /** The metric to update. */
|
| - core.String metric;
|
| -
|
| - CounterOptions();
|
| -
|
| - CounterOptions.fromJson(core.Map _json) {
|
| - if (_json.containsKey("field")) {
|
| - field = _json["field"];
|
| - }
|
| - if (_json.containsKey("metric")) {
|
| - metric = _json["metric"];
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (field != null) {
|
| - _json["field"] = field;
|
| - }
|
| - if (metric != null) {
|
| - _json["metric"] = metric;
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/**
|
| - * Metadata type for the operation returned by
|
| - * CreateDatabase.
|
| - */
|
| +/// Metadata type for the operation returned by
|
| +/// CreateDatabase.
|
| class CreateDatabaseMetadata {
|
| - /** The database being created. */
|
| + /// The database being created.
|
| core.String database;
|
|
|
| CreateDatabaseMetadata();
|
| @@ -2682,7 +2257,8 @@ class CreateDatabaseMetadata {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (database != null) {
|
| _json["database"] = database;
|
| }
|
| @@ -2690,22 +2266,19 @@ class CreateDatabaseMetadata {
|
| }
|
| }
|
|
|
| -/** The request for CreateDatabase. */
|
| +/// The request for CreateDatabase.
|
| class CreateDatabaseRequest {
|
| - /**
|
| - * Required. A `CREATE DATABASE` statement, which specifies the ID of the
|
| - * new database. The database ID must conform to the regular expression
|
| - * `a-z*[a-z0-9]` and be between 2 and 30 characters in length.
|
| - * If the database ID is a reserved word or if it contains a hyphen, the
|
| - * database ID must be enclosed in backticks (`` ` ``).
|
| - */
|
| + /// Required. A `CREATE DATABASE` statement, which specifies the ID of the
|
| + /// new database. The database ID must conform to the regular expression
|
| + /// `a-z*[a-z0-9]` and be between 2 and 30 characters in length.
|
| + /// If the database ID is a reserved word or if it contains a hyphen, the
|
| + /// database ID must be enclosed in backticks (`` ` ``).
|
| core.String createStatement;
|
| - /**
|
| - * An optional list of DDL statements to run inside the newly created
|
| - * database. Statements can create tables, indexes, etc. These
|
| - * statements execute atomically with the creation of the database:
|
| - * if there is an error in any statement, the database is not created.
|
| - */
|
| +
|
| + /// An optional list of DDL statements to run inside the newly created
|
| + /// database. Statements can create tables, indexes, etc. These
|
| + /// statements execute atomically with the creation of the database:
|
| + /// if there is an error in any statement, the database is not created.
|
| core.List<core.String> extraStatements;
|
|
|
| CreateDatabaseRequest();
|
| @@ -2720,7 +2293,8 @@ class CreateDatabaseRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (createStatement != null) {
|
| _json["createStatement"] = createStatement;
|
| }
|
| @@ -2731,26 +2305,23 @@ class CreateDatabaseRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Metadata type for the operation returned by
|
| - * CreateInstance.
|
| - */
|
| +/// Metadata type for the operation returned by
|
| +/// CreateInstance.
|
| class CreateInstanceMetadata {
|
| - /**
|
| - * The time at which this operation was cancelled. If set, this operation is
|
| - * in the process of undoing itself (which is guaranteed to succeed) and
|
| - * cannot be cancelled again.
|
| - */
|
| + /// The time at which this operation was cancelled. If set, this operation is
|
| + /// in the process of undoing itself (which is guaranteed to succeed) and
|
| + /// cannot be cancelled again.
|
| core.String cancelTime;
|
| - /** The time at which this operation failed or was completed successfully. */
|
| +
|
| + /// The time at which this operation failed or was completed successfully.
|
| core.String endTime;
|
| - /** The instance being created. */
|
| +
|
| + /// The instance being created.
|
| Instance instance;
|
| - /**
|
| - * The time at which the
|
| - * CreateInstance request was
|
| - * received.
|
| - */
|
| +
|
| + /// The time at which the
|
| + /// CreateInstance request was
|
| + /// received.
|
| core.String startTime;
|
|
|
| CreateInstanceMetadata();
|
| @@ -2771,7 +2342,8 @@ class CreateInstanceMetadata {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (cancelTime != null) {
|
| _json["cancelTime"] = cancelTime;
|
| }
|
| @@ -2788,18 +2360,15 @@ class CreateInstanceMetadata {
|
| }
|
| }
|
|
|
| -/** The request for CreateInstance. */
|
| +/// The request for CreateInstance.
|
| class CreateInstanceRequest {
|
| - /**
|
| - * Required. The instance to create. The name may be omitted, but if
|
| - * specified must be `<parent>/instances/<instance_id>`.
|
| - */
|
| + /// Required. The instance to create. The name may be omitted, but if
|
| + /// specified must be `<parent>/instances/<instance_id>`.
|
| Instance instance;
|
| - /**
|
| - * Required. The ID of the instance to create. Valid identifiers are of the
|
| - * form `a-z*[a-z0-9]` and must be between 6 and 30 characters in
|
| - * length.
|
| - */
|
| +
|
| + /// Required. The ID of the instance to create. Valid identifiers are of the
|
| + /// form `a-z*[a-z0-9]` and must be between 6 and 30 characters in
|
| + /// length.
|
| core.String instanceId;
|
|
|
| CreateInstanceRequest();
|
| @@ -2814,7 +2383,8 @@ class CreateInstanceRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (instance != null) {
|
| _json["instance"] = (instance).toJson();
|
| }
|
| @@ -2825,39 +2395,22 @@ class CreateInstanceRequest {
|
| }
|
| }
|
|
|
| -/** Write a Data Access (Gin) log */
|
| -class DataAccessOptions {
|
| -
|
| - DataAccessOptions();
|
| -
|
| - DataAccessOptions.fromJson(core.Map _json) {
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/** A Cloud Spanner database. */
|
| +/// A Cloud Spanner database.
|
| class Database {
|
| - /**
|
| - * Required. The name of the database. Values are of the form
|
| - * `projects/<project>/instances/<instance>/databases/<database>`,
|
| - * where `<database>` is as specified in the `CREATE DATABASE`
|
| - * statement. This name can be passed to other API methods to
|
| - * identify the database.
|
| - */
|
| + /// Required. The name of the database. Values are of the form
|
| + /// `projects/<project>/instances/<instance>/databases/<database>`,
|
| + /// where `<database>` is as specified in the `CREATE DATABASE`
|
| + /// statement. This name can be passed to other API methods to
|
| + /// identify the database.
|
| core.String name;
|
| - /**
|
| - * Output only. The current database state.
|
| - * Possible string values are:
|
| - * - "STATE_UNSPECIFIED" : Not specified.
|
| - * - "CREATING" : The database is still being created. Operations on the
|
| - * database may fail
|
| - * with `FAILED_PRECONDITION` in this state.
|
| - * - "READY" : The database is fully created and ready for use.
|
| - */
|
| +
|
| + /// Output only. The current database state.
|
| + /// Possible string values are:
|
| + /// - "STATE_UNSPECIFIED" : Not specified.
|
| + /// - "CREATING" : The database is still being created. Operations on the
|
| + /// database may fail
|
| + /// with `FAILED_PRECONDITION` in this state.
|
| + /// - "READY" : The database is fully created and ready for use.
|
| core.String state;
|
|
|
| Database();
|
| @@ -2872,7 +2425,8 @@ class Database {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (name != null) {
|
| _json["name"] = name;
|
| }
|
| @@ -2883,11 +2437,12 @@ class Database {
|
| }
|
| }
|
|
|
| -/** Arguments to delete operations. */
|
| +/// Arguments to delete operations.
|
| class Delete {
|
| - /** Required. The primary keys of the rows within table to delete. */
|
| + /// Required. The primary keys of the rows within table to delete.
|
| KeySet keySet;
|
| - /** Required. The table whose rows will be deleted. */
|
| +
|
| + /// Required. The table whose rows will be deleted.
|
| core.String table;
|
|
|
| Delete();
|
| @@ -2902,7 +2457,8 @@ class Delete {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (keySet != null) {
|
| _json["keySet"] = (keySet).toJson();
|
| }
|
| @@ -2913,110 +2469,104 @@ class Delete {
|
| }
|
| }
|
|
|
| -/**
|
| - * 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 `{}`.
|
| - */
|
| +/// 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(core.Map _json) {
|
| - }
|
| + Empty.fromJson(core.Map _json) {}
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * The request for ExecuteSql and
|
| - * ExecuteStreamingSql.
|
| - */
|
| +/// The request for ExecuteSql and
|
| +/// ExecuteStreamingSql.
|
| class ExecuteSqlRequest {
|
| - /**
|
| - * It is not always possible for Cloud Spanner to infer the right SQL type
|
| - * from a JSON value. For example, values of type `BYTES` and values
|
| - * of type `STRING` both appear in params as JSON strings.
|
| - *
|
| - * In these cases, `param_types` can be used to specify the exact
|
| - * SQL type for some or all of the SQL query parameters. See the
|
| - * definition of Type for more information
|
| - * about SQL types.
|
| - */
|
| + /// It is not always possible for Cloud Spanner to infer the right SQL type
|
| + /// from a JSON value. For example, values of type `BYTES` and values
|
| + /// of type `STRING` both appear in params as JSON strings.
|
| + ///
|
| + /// In these cases, `param_types` can be used to specify the exact
|
| + /// SQL type for some or all of the SQL query parameters. See the
|
| + /// definition of Type for more information
|
| + /// about SQL types.
|
| core.Map<core.String, Type> paramTypes;
|
| - /**
|
| - * The SQL query string can contain parameter placeholders. A parameter
|
| - * placeholder consists of `'@'` followed by the parameter
|
| - * name. Parameter names consist of any combination of letters,
|
| - * numbers, and underscores.
|
| - *
|
| - * Parameters can appear anywhere that a literal value is expected. The same
|
| - * parameter name can be used more than once, for example:
|
| - * `"WHERE id > @msg_id AND id < @msg_id + 100"`
|
| - *
|
| - * It is an error to execute an SQL query with unbound parameters.
|
| - *
|
| - * Parameter values are specified using `params`, which is a JSON
|
| - * object whose keys are parameter names, and whose values are the
|
| - * corresponding parameter values.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// The SQL query string can contain parameter placeholders. A parameter
|
| + /// placeholder consists of `'@'` followed by the parameter
|
| + /// name. Parameter names consist of any combination of letters,
|
| + /// numbers, and underscores.
|
| + ///
|
| + /// Parameters can appear anywhere that a literal value is expected. The
|
| + /// same
|
| + /// parameter name can be used more than once, for example:
|
| + /// `"WHERE id > @msg_id AND id < @msg_id + 100"`
|
| + ///
|
| + /// It is an error to execute an SQL query with unbound parameters.
|
| + ///
|
| + /// Parameter values are specified using `params`, which is a JSON
|
| + /// object whose keys are parameter names, and whose values are the
|
| + /// corresponding parameter values.
|
| + ///
|
| + /// 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> params;
|
| - /**
|
| - * Used to control the amount of debugging information returned in
|
| - * ResultSetStats.
|
| - * Possible string values are:
|
| - * - "NORMAL" : The default mode where only the query result, without any
|
| - * information
|
| - * about the query plan is returned.
|
| - * - "PLAN" : This mode returns only the query plan, without any result rows
|
| - * or
|
| - * execution statistics information.
|
| - * - "PROFILE" : This mode returns both the query plan and the execution
|
| - * statistics along
|
| - * with the result rows.
|
| - */
|
| +
|
| + /// Used to control the amount of debugging information returned in
|
| + /// ResultSetStats.
|
| + /// Possible string values are:
|
| + /// - "NORMAL" : The default mode where only the query result, without any
|
| + /// information
|
| + /// about the query plan is returned.
|
| + /// - "PLAN" : This mode returns only the query plan, without any result rows
|
| + /// or
|
| + /// execution statistics information.
|
| + /// - "PROFILE" : This mode returns both the query plan and the execution
|
| + /// statistics along
|
| + /// with the result rows.
|
| core.String queryMode;
|
| - /**
|
| - * If this request is resuming a previously interrupted SQL query
|
| - * execution, `resume_token` should be copied from the last
|
| - * PartialResultSet yielded before the interruption. Doing this
|
| - * enables the new SQL query execution to resume where the last one left
|
| - * off. The rest of the request parameters must exactly match the
|
| - * request that yielded this token.
|
| - */
|
| +
|
| + /// If this request is resuming a previously interrupted SQL query
|
| + /// execution, `resume_token` should be copied from the last
|
| + /// PartialResultSet yielded before the interruption. Doing this
|
| + /// enables the new SQL query execution to resume where the last one left
|
| + /// off. The rest of the request parameters must exactly match the
|
| + /// request that yielded this token.
|
| core.String resumeToken;
|
| core.List<core.int> get resumeTokenAsBytes {
|
| return convert.BASE64.decode(resumeToken);
|
| }
|
|
|
| void set resumeTokenAsBytes(core.List<core.int> _bytes) {
|
| - resumeToken = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + resumeToken =
|
| + convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| }
|
| - /** Required. The SQL query string. */
|
| +
|
| + /// Required. The SQL query string.
|
| core.String sql;
|
| - /**
|
| - * The transaction to use. If none is provided, the default is a
|
| - * temporary read-only transaction with strong concurrency.
|
| - */
|
| +
|
| + /// The transaction to use. If none is provided, the default is a
|
| + /// temporary read-only transaction with strong concurrency.
|
| TransactionSelector transaction;
|
|
|
| ExecuteSqlRequest();
|
|
|
| ExecuteSqlRequest.fromJson(core.Map _json) {
|
| if (_json.containsKey("paramTypes")) {
|
| - paramTypes = commons.mapMap<core.Map<core.String, core.Object>, Type>(_json["paramTypes"], (core.Map<core.String, core.Object> item) => new Type.fromJson(item));
|
| + paramTypes = commons.mapMap<core.Map<core.String, core.Object>, Type>(
|
| + _json["paramTypes"],
|
| + (core.Map<core.String, core.Object> item) => new Type.fromJson(item));
|
| }
|
| if (_json.containsKey("params")) {
|
| params = _json["params"];
|
| @@ -3036,9 +2586,12 @@ class ExecuteSqlRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (paramTypes != null) {
|
| - _json["paramTypes"] = commons.mapMap<Type, core.Map<core.String, core.Object>>(paramTypes, (Type item) => (item).toJson());
|
| + _json["paramTypes"] =
|
| + commons.mapMap<Type, core.Map<core.String, core.Object>>(
|
| + paramTypes, (Type item) => (item).toJson());
|
| }
|
| if (params != null) {
|
| _json["params"] = params;
|
| @@ -3059,87 +2612,18 @@ class ExecuteSqlRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Represents an expression text. Example:
|
| - *
|
| - * title: "User account presence"
|
| - * description: "Determines whether the request has a user account"
|
| - * expression: "size(request.user) > 0"
|
| - */
|
| -class Expr {
|
| - /**
|
| - * An optional description of the expression. This is a longer text which
|
| - * describes the expression, e.g. when hovered over it in a UI.
|
| - */
|
| - core.String description;
|
| - /**
|
| - * Textual representation of an expression in
|
| - * Common Expression Language syntax.
|
| - *
|
| - * The application context of the containing message determines which
|
| - * well-known feature set of CEL is supported.
|
| - */
|
| - core.String expression;
|
| - /**
|
| - * An optional string indicating the location of the expression for error
|
| - * reporting, e.g. a file name and a position in the file.
|
| - */
|
| - core.String location;
|
| - /**
|
| - * An optional title for the expression, i.e. a short string describing
|
| - * its purpose. This can be used e.g. in UIs which allow to enter the
|
| - * expression.
|
| - */
|
| - core.String title;
|
| -
|
| - Expr();
|
| -
|
| - Expr.fromJson(core.Map _json) {
|
| - if (_json.containsKey("description")) {
|
| - description = _json["description"];
|
| - }
|
| - if (_json.containsKey("expression")) {
|
| - expression = _json["expression"];
|
| - }
|
| - if (_json.containsKey("location")) {
|
| - location = _json["location"];
|
| - }
|
| - if (_json.containsKey("title")) {
|
| - title = _json["title"];
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (description != null) {
|
| - _json["description"] = description;
|
| - }
|
| - if (expression != null) {
|
| - _json["expression"] = expression;
|
| - }
|
| - if (location != null) {
|
| - _json["location"] = location;
|
| - }
|
| - if (title != null) {
|
| - _json["title"] = title;
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/** Message representing a single field of a struct. */
|
| +/// Message representing a single field of a struct.
|
| class Field {
|
| - /**
|
| - * The name of the field. For reads, this is the column name. For
|
| - * SQL queries, it is the column alias (e.g., `"Word"` in the
|
| - * query `"SELECT 'hello' AS Word"`), or the column name (e.g.,
|
| - * `"ColName"` in the query `"SELECT ColName FROM Table"`). Some
|
| - * columns might have an empty name (e.g., !"SELECT
|
| - * UPPER(ColName)"`). Note that a query result can contain
|
| - * multiple fields with the same name.
|
| - */
|
| + /// The name of the field. For reads, this is the column name. For
|
| + /// SQL queries, it is the column alias (e.g., `"Word"` in the
|
| + /// query `"SELECT 'hello' AS Word"`), or the column name (e.g.,
|
| + /// `"ColName"` in the query `"SELECT ColName FROM Table"`). Some
|
| + /// columns might have an empty name (e.g., !"SELECT
|
| + /// UPPER(ColName)"`). Note that a query result can contain
|
| + /// multiple fields with the same name.
|
| core.String name;
|
| - /** The type of the field. */
|
| +
|
| + /// The type of the field.
|
| Type type;
|
|
|
| Field();
|
| @@ -3154,7 +2638,8 @@ class Field {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (name != null) {
|
| _json["name"] = name;
|
| }
|
| @@ -3165,12 +2650,10 @@ class Field {
|
| }
|
| }
|
|
|
| -/** The response for GetDatabaseDdl. */
|
| +/// The response for GetDatabaseDdl.
|
| class GetDatabaseDdlResponse {
|
| - /**
|
| - * A list of formatted DDL statements defining the schema of the database
|
| - * specified in the request.
|
| - */
|
| + /// A list of formatted DDL statements defining the schema of the database
|
| + /// specified in the request.
|
| core.List<core.String> statements;
|
|
|
| GetDatabaseDdlResponse();
|
| @@ -3182,7 +2665,8 @@ class GetDatabaseDdlResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (statements != null) {
|
| _json["statements"] = statements;
|
| }
|
| @@ -3190,101 +2674,97 @@ class GetDatabaseDdlResponse {
|
| }
|
| }
|
|
|
| -/** Request message for `GetIamPolicy` method. */
|
| +/// Request message for `GetIamPolicy` method.
|
| class GetIamPolicyRequest {
|
| -
|
| GetIamPolicyRequest();
|
|
|
| - GetIamPolicyRequest.fromJson(core.Map _json) {
|
| - }
|
| + GetIamPolicyRequest.fromJson(core.Map _json) {}
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * An isolated set of Cloud Spanner resources on which databases can be hosted.
|
| - */
|
| +/// An isolated set of Cloud Spanner resources on which databases can be
|
| +/// hosted.
|
| class Instance {
|
| - /**
|
| - * Required. The name of the instance's configuration. Values are of the form
|
| - * `projects/<project>/instanceConfigs/<configuration>`. See
|
| - * also InstanceConfig and
|
| - * ListInstanceConfigs.
|
| - */
|
| + /// Required. The name of the instance's configuration. Values are of the
|
| + /// form
|
| + /// `projects/<project>/instanceConfigs/<configuration>`. See
|
| + /// also InstanceConfig and
|
| + /// ListInstanceConfigs.
|
| core.String config;
|
| - /**
|
| - * Required. The descriptive name for this instance as it appears in UIs.
|
| - * Must be unique per project and between 4 and 30 characters in length.
|
| - */
|
| +
|
| + /// Required. The descriptive name for this instance as it appears in UIs.
|
| + /// Must be unique per project and between 4 and 30 characters in length.
|
| core.String displayName;
|
| - /**
|
| - * Cloud Labels are a flexible and lightweight mechanism for organizing cloud
|
| - * resources into groups that reflect a customer's organizational needs and
|
| - * deployment strategies. Cloud Labels can be used to filter collections of
|
| - * resources. They can be used to control how resource metrics are aggregated.
|
| - * And they can be used as arguments to policy management rules (e.g. route,
|
| - * firewall, load balancing, etc.).
|
| - *
|
| - * * Label keys must be between 1 and 63 characters long and must conform to
|
| - * the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
|
| - * * Label values must be between 0 and 63 characters long and must conform
|
| - * to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
|
| - * * No more than 64 labels can be associated with a given resource.
|
| - *
|
| - * See https://goo.gl/xmQnxf for more information on and examples of labels.
|
| - *
|
| - * If you plan to use labels in your own code, please note that additional
|
| - * characters may be allowed in the future. And so you are advised to use an
|
| - * internal label representation, such as JSON, which doesn't rely upon
|
| - * specific characters being disallowed. For example, representing labels
|
| - * as the string: name + "_" + value would prove problematic if we were to
|
| - * allow "_" in a future release.
|
| - */
|
| +
|
| + /// Cloud Labels are a flexible and lightweight mechanism for organizing
|
| + /// cloud
|
| + /// resources into groups that reflect a customer's organizational needs and
|
| + /// deployment strategies. Cloud Labels can be used to filter collections of
|
| + /// resources. They can be used to control how resource metrics are
|
| + /// aggregated.
|
| + /// And they can be used as arguments to policy management rules (e.g. route,
|
| + /// firewall, load balancing, etc.).
|
| + ///
|
| + /// * Label keys must be between 1 and 63 characters long and must conform to
|
| + /// the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.
|
| + /// * Label values must be between 0 and 63 characters long and must conform
|
| + /// to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
|
| + /// * No more than 64 labels can be associated with a given resource.
|
| + ///
|
| + /// See https://goo.gl/xmQnxf for more information on and examples of labels.
|
| + ///
|
| + /// If you plan to use labels in your own code, please note that additional
|
| + /// characters may be allowed in the future. And so you are advised to use an
|
| + /// internal label representation, such as JSON, which doesn't rely upon
|
| + /// specific characters being disallowed. For example, representing labels
|
| + /// as the string: name + "_" + value would prove problematic if we were to
|
| + /// allow "_" in a future release.
|
| core.Map<core.String, core.String> labels;
|
| - /**
|
| - * Required. A unique identifier for the instance, which cannot be changed
|
| - * after the instance is created. Values are of the form
|
| - * `projects/<project>/instances/a-z*[a-z0-9]`. The final
|
| - * segment of the name must be between 6 and 30 characters in length.
|
| - */
|
| +
|
| + /// Required. A unique identifier for the instance, which cannot be changed
|
| + /// after the instance is created. Values are of the form
|
| + /// `projects/<project>/instances/a-z*[a-z0-9]`. The final
|
| + /// segment of the name must be between 6 and 30 characters in length.
|
| core.String name;
|
| - /**
|
| - * Required. The number of nodes allocated to this instance. This may be zero
|
| - * in API responses for instances that are not yet in state `READY`.
|
| - *
|
| - * Each Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of
|
| - * writes (writing single rows at 1KB data per row), and 2 TiB storage.
|
| - *
|
| - * For optimal performance, we recommend provisioning enough nodes to keep
|
| - * overall CPU utilization under 75%.
|
| - *
|
| - * A minimum of 3 nodes is recommended for production environments. This
|
| - * minimum is required for SLAs to apply to your instance.
|
| - *
|
| - * Note that Cloud Spanner performance is highly dependent on workload, schema
|
| - * design, and dataset characteristics. The performance numbers above are
|
| - * estimates, and assume [best
|
| - * practices](https://cloud.google.com/spanner/docs/bulk-loading)
|
| - * are followed.
|
| - */
|
| +
|
| + /// Required. The number of nodes allocated to this instance. This may be
|
| + /// zero
|
| + /// in API responses for instances that are not yet in state `READY`.
|
| + ///
|
| + /// Each Spanner node can provide up to 10,000 QPS of reads or 2000 QPS of
|
| + /// writes (writing single rows at 1KB data per row), and 2 TiB storage.
|
| + ///
|
| + /// For optimal performance, we recommend provisioning enough nodes to keep
|
| + /// overall CPU utilization under 75%.
|
| + ///
|
| + /// A minimum of 3 nodes is recommended for production environments. This
|
| + /// minimum is required for SLAs to apply to your instance.
|
| + ///
|
| + /// Note that Cloud Spanner performance is highly dependent on workload,
|
| + /// schema
|
| + /// design, and dataset characteristics. The performance numbers above are
|
| + /// estimates, and assume [best
|
| + /// practices](https://cloud.google.com/spanner/docs/bulk-loading)
|
| + /// are followed.
|
| core.int nodeCount;
|
| - /**
|
| - * Output only. The current instance state. For
|
| - * CreateInstance, the state must be
|
| - * either omitted or set to `CREATING`. For
|
| - * UpdateInstance, the state must be
|
| - * either omitted or set to `READY`.
|
| - * Possible string values are:
|
| - * - "STATE_UNSPECIFIED" : Not specified.
|
| - * - "CREATING" : The instance is still being created. Resources may not be
|
| - * available yet, and operations such as database creation may not
|
| - * work.
|
| - * - "READY" : The instance is fully created and ready to do work such as
|
| - * creating databases.
|
| - */
|
| +
|
| + /// Output only. The current instance state. For
|
| + /// CreateInstance, the state must be
|
| + /// either omitted or set to `CREATING`. For
|
| + /// UpdateInstance, the state must be
|
| + /// either omitted or set to `READY`.
|
| + /// Possible string values are:
|
| + /// - "STATE_UNSPECIFIED" : Not specified.
|
| + /// - "CREATING" : The instance is still being created. Resources may not be
|
| + /// available yet, and operations such as database creation may not
|
| + /// work.
|
| + /// - "READY" : The instance is fully created and ready to do work such as
|
| + /// creating databases.
|
| core.String state;
|
|
|
| Instance();
|
| @@ -3311,7 +2791,8 @@ class Instance {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (config != null) {
|
| _json["config"] = config;
|
| }
|
| @@ -3334,18 +2815,15 @@ class Instance {
|
| }
|
| }
|
|
|
| -/**
|
| - * A possible configuration for a Cloud Spanner instance. Configurations
|
| - * define the geographic placement of nodes and their replication.
|
| - */
|
| +/// A possible configuration for a Cloud Spanner instance. Configurations
|
| +/// define the geographic placement of nodes and their replication.
|
| class InstanceConfig {
|
| - /** The name of this instance configuration as it appears in UIs. */
|
| + /// The name of this instance configuration as it appears in UIs.
|
| core.String displayName;
|
| - /**
|
| - * A unique identifier for the instance configuration. Values
|
| - * are of the form
|
| - * `projects/<project>/instanceConfigs/a-z*`
|
| - */
|
| +
|
| + /// A unique identifier for the instance configuration. Values
|
| + /// are of the form
|
| + /// `projects/<project>/instanceConfigs/a-z*`
|
| core.String name;
|
|
|
| InstanceConfig();
|
| @@ -3360,7 +2838,8 @@ class InstanceConfig {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (displayName != null) {
|
| _json["displayName"] = displayName;
|
| }
|
| @@ -3371,126 +2850,119 @@ class InstanceConfig {
|
| }
|
| }
|
|
|
| -/**
|
| - * KeyRange represents a range of rows in a table or index.
|
| - *
|
| - * A range has a start key and an end key. These keys can be open or
|
| - * closed, indicating if the range includes rows with that key.
|
| - *
|
| - * Keys are represented by lists, where the ith value in the list
|
| - * corresponds to the ith component of the table or index primary key.
|
| - * Individual values are encoded as described here.
|
| - *
|
| - * For example, consider the following table definition:
|
| - *
|
| - * CREATE TABLE UserEvents (
|
| - * UserName STRING(MAX),
|
| - * EventDate STRING(10)
|
| - * ) PRIMARY KEY(UserName, EventDate);
|
| - *
|
| - * The following keys name rows in this table:
|
| - *
|
| - * "Bob", "2014-09-23"
|
| - *
|
| - * Since the `UserEvents` table's `PRIMARY KEY` clause names two
|
| - * columns, each `UserEvents` key has two elements; the first is the
|
| - * `UserName`, and the second is the `EventDate`.
|
| - *
|
| - * Key ranges with multiple components are interpreted
|
| - * lexicographically by component using the table or index key's declared
|
| - * sort order. For example, the following range returns all events for
|
| - * user `"Bob"` that occurred in the year 2015:
|
| - *
|
| - * "start_closed": ["Bob", "2015-01-01"]
|
| - * "end_closed": ["Bob", "2015-12-31"]
|
| - *
|
| - * Start and end keys can omit trailing key components. This affects the
|
| - * inclusion and exclusion of rows that exactly match the provided key
|
| - * components: if the key is closed, then rows that exactly match the
|
| - * provided components are included; if the key is open, then rows
|
| - * that exactly match are not included.
|
| - *
|
| - * For example, the following range includes all events for `"Bob"` that
|
| - * occurred during and after the year 2000:
|
| - *
|
| - * "start_closed": ["Bob", "2000-01-01"]
|
| - * "end_closed": ["Bob"]
|
| - *
|
| - * The next example retrieves all events for `"Bob"`:
|
| - *
|
| - * "start_closed": ["Bob"]
|
| - * "end_closed": ["Bob"]
|
| - *
|
| - * To retrieve events before the year 2000:
|
| - *
|
| - * "start_closed": ["Bob"]
|
| - * "end_open": ["Bob", "2000-01-01"]
|
| - *
|
| - * The following range includes all rows in the table:
|
| - *
|
| - * "start_closed": []
|
| - * "end_closed": []
|
| - *
|
| - * This range returns all users whose `UserName` begins with any
|
| - * character from A to C:
|
| - *
|
| - * "start_closed": ["A"]
|
| - * "end_open": ["D"]
|
| - *
|
| - * This range returns all users whose `UserName` begins with B:
|
| - *
|
| - * "start_closed": ["B"]
|
| - * "end_open": ["C"]
|
| - *
|
| - * Key ranges honor column sort order. For example, suppose a table is
|
| - * defined as follows:
|
| - *
|
| - * CREATE TABLE DescendingSortedTable {
|
| - * Key INT64,
|
| - * ...
|
| - * ) PRIMARY KEY(Key DESC);
|
| - *
|
| - * The following range retrieves all rows with key values between 1
|
| - * and 100 inclusive:
|
| - *
|
| - * "start_closed": ["100"]
|
| - * "end_closed": ["1"]
|
| - *
|
| - * Note that 100 is passed as the start, and 1 is passed as the end,
|
| - * because `Key` is a descending column in the schema.
|
| - */
|
| +/// KeyRange represents a range of rows in a table or index.
|
| +///
|
| +/// A range has a start key and an end key. These keys can be open or
|
| +/// closed, indicating if the range includes rows with that key.
|
| +///
|
| +/// Keys are represented by lists, where the ith value in the list
|
| +/// corresponds to the ith component of the table or index primary key.
|
| +/// Individual values are encoded as described here.
|
| +///
|
| +/// For example, consider the following table definition:
|
| +///
|
| +/// CREATE TABLE UserEvents (
|
| +/// UserName STRING(MAX),
|
| +/// EventDate STRING(10)
|
| +/// ) PRIMARY KEY(UserName, EventDate);
|
| +///
|
| +/// The following keys name rows in this table:
|
| +///
|
| +/// "Bob", "2014-09-23"
|
| +///
|
| +/// Since the `UserEvents` table's `PRIMARY KEY` clause names two
|
| +/// columns, each `UserEvents` key has two elements; the first is the
|
| +/// `UserName`, and the second is the `EventDate`.
|
| +///
|
| +/// Key ranges with multiple components are interpreted
|
| +/// lexicographically by component using the table or index key's declared
|
| +/// sort order. For example, the following range returns all events for
|
| +/// user `"Bob"` that occurred in the year 2015:
|
| +///
|
| +/// "start_closed": ["Bob", "2015-01-01"]
|
| +/// "end_closed": ["Bob", "2015-12-31"]
|
| +///
|
| +/// Start and end keys can omit trailing key components. This affects the
|
| +/// inclusion and exclusion of rows that exactly match the provided key
|
| +/// components: if the key is closed, then rows that exactly match the
|
| +/// provided components are included; if the key is open, then rows
|
| +/// that exactly match are not included.
|
| +///
|
| +/// For example, the following range includes all events for `"Bob"` that
|
| +/// occurred during and after the year 2000:
|
| +///
|
| +/// "start_closed": ["Bob", "2000-01-01"]
|
| +/// "end_closed": ["Bob"]
|
| +///
|
| +/// The next example retrieves all events for `"Bob"`:
|
| +///
|
| +/// "start_closed": ["Bob"]
|
| +/// "end_closed": ["Bob"]
|
| +///
|
| +/// To retrieve events before the year 2000:
|
| +///
|
| +/// "start_closed": ["Bob"]
|
| +/// "end_open": ["Bob", "2000-01-01"]
|
| +///
|
| +/// The following range includes all rows in the table:
|
| +///
|
| +/// "start_closed": []
|
| +/// "end_closed": []
|
| +///
|
| +/// This range returns all users whose `UserName` begins with any
|
| +/// character from A to C:
|
| +///
|
| +/// "start_closed": ["A"]
|
| +/// "end_open": ["D"]
|
| +///
|
| +/// This range returns all users whose `UserName` begins with B:
|
| +///
|
| +/// "start_closed": ["B"]
|
| +/// "end_open": ["C"]
|
| +///
|
| +/// Key ranges honor column sort order. For example, suppose a table is
|
| +/// defined as follows:
|
| +///
|
| +/// CREATE TABLE DescendingSortedTable {
|
| +/// Key INT64,
|
| +/// ...
|
| +/// ) PRIMARY KEY(Key DESC);
|
| +///
|
| +/// The following range retrieves all rows with key values between 1
|
| +/// and 100 inclusive:
|
| +///
|
| +/// "start_closed": ["100"]
|
| +/// "end_closed": ["1"]
|
| +///
|
| +/// Note that 100 is passed as the start, and 1 is passed as the end,
|
| +/// because `Key` is a descending column in the schema.
|
| class KeyRange {
|
| - /**
|
| - * If the end is closed, then the range includes all rows whose
|
| - * first `len(end_closed)` key columns exactly match `end_closed`.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| + /// If the end is closed, then the range includes all rows whose
|
| + /// first `len(end_closed)` key columns exactly match `end_closed`.
|
| + ///
|
| + /// 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.Object> endClosed;
|
| - /**
|
| - * If the end is open, then the range excludes rows whose first
|
| - * `len(end_open)` key columns exactly match `end_open`.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// If the end is open, then the range excludes rows whose first
|
| + /// `len(end_open)` key columns exactly match `end_open`.
|
| + ///
|
| + /// 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.Object> endOpen;
|
| - /**
|
| - * If the start is closed, then the range includes all rows whose
|
| - * first `len(start_closed)` key columns exactly match `start_closed`.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// If the start is closed, then the range includes all rows whose
|
| + /// first `len(start_closed)` key columns exactly match `start_closed`.
|
| + ///
|
| + /// 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.Object> startClosed;
|
| - /**
|
| - * If the start is open, then the range excludes rows whose first
|
| - * `len(start_open)` key columns exactly match `start_open`.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// If the start is open, then the range excludes rows whose first
|
| + /// `len(start_open)` key columns exactly match `start_open`.
|
| + ///
|
| + /// 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.Object> startOpen;
|
|
|
| KeyRange();
|
| @@ -3511,7 +2983,8 @@ class KeyRange {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (endClosed != null) {
|
| _json["endClosed"] = endClosed;
|
| }
|
| @@ -3528,36 +3001,30 @@ class KeyRange {
|
| }
|
| }
|
|
|
| -/**
|
| - * `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All
|
| - * the keys are expected to be in the same table or index. The keys need
|
| - * not be sorted in any particular way.
|
| - *
|
| - * If the same key is specified multiple times in the set (for example
|
| - * if two ranges, two keys, or a key and a range overlap), Cloud Spanner
|
| - * behaves as if the key were only specified once.
|
| - */
|
| +/// `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All
|
| +/// the keys are expected to be in the same table or index. The keys need
|
| +/// not be sorted in any particular way.
|
| +///
|
| +/// If the same key is specified multiple times in the set (for example
|
| +/// if two ranges, two keys, or a key and a range overlap), Cloud Spanner
|
| +/// behaves as if the key were only specified once.
|
| class KeySet {
|
| - /**
|
| - * For convenience `all` can be set to `true` to indicate that this
|
| - * `KeySet` matches all keys in the table or index. Note that any keys
|
| - * specified in `keys` or `ranges` are only yielded once.
|
| - */
|
| + /// For convenience `all` can be set to `true` to indicate that this
|
| + /// `KeySet` matches all keys in the table or index. Note that any keys
|
| + /// specified in `keys` or `ranges` are only yielded once.
|
| core.bool all;
|
| - /**
|
| - * A list of specific keys. Entries in `keys` should have exactly as
|
| - * many elements as there are columns in the primary or index key
|
| - * with which this `KeySet` is used. Individual key values are
|
| - * encoded as described here.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// A list of specific keys. Entries in `keys` should have exactly as
|
| + /// many elements as there are columns in the primary or index key
|
| + /// with which this `KeySet` is used. Individual key values are
|
| + /// encoded as described here.
|
| + ///
|
| + /// 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.List<core.Object>> keys;
|
| - /**
|
| - * A list of key ranges. See KeyRange for more information about
|
| - * key range specifications.
|
| - */
|
| +
|
| + /// A list of key ranges. See KeyRange for more information about
|
| + /// key range specifications.
|
| core.List<KeyRange> ranges;
|
|
|
| KeySet();
|
| @@ -3570,12 +3037,14 @@ class KeySet {
|
| keys = _json["keys"];
|
| }
|
| if (_json.containsKey("ranges")) {
|
| - ranges = _json["ranges"].map((value) => new KeyRange.fromJson(value)).toList();
|
| + ranges =
|
| + _json["ranges"].map((value) => new KeyRange.fromJson(value)).toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (all != null) {
|
| _json["all"] = all;
|
| }
|
| @@ -3589,22 +3058,23 @@ class KeySet {
|
| }
|
| }
|
|
|
| -/** The response for ListDatabases. */
|
| +/// The response for ListDatabases.
|
| class ListDatabasesResponse {
|
| - /** Databases that matched the request. */
|
| + /// Databases that matched the request.
|
| core.List<Database> databases;
|
| - /**
|
| - * `next_page_token` can be sent in a subsequent
|
| - * ListDatabases call to fetch more
|
| - * of the matching databases.
|
| - */
|
| +
|
| + /// `next_page_token` can be sent in a subsequent
|
| + /// ListDatabases call to fetch more
|
| + /// of the matching databases.
|
| core.String nextPageToken;
|
|
|
| ListDatabasesResponse();
|
|
|
| ListDatabasesResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("databases")) {
|
| - databases = _json["databases"].map((value) => new Database.fromJson(value)).toList();
|
| + databases = _json["databases"]
|
| + .map((value) => new Database.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("nextPageToken")) {
|
| nextPageToken = _json["nextPageToken"];
|
| @@ -3612,7 +3082,8 @@ class ListDatabasesResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (databases != null) {
|
| _json["databases"] = databases.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -3623,22 +3094,23 @@ class ListDatabasesResponse {
|
| }
|
| }
|
|
|
| -/** The response for ListInstanceConfigs. */
|
| +/// The response for ListInstanceConfigs.
|
| class ListInstanceConfigsResponse {
|
| - /** The list of requested instance configurations. */
|
| + /// The list of requested instance configurations.
|
| core.List<InstanceConfig> instanceConfigs;
|
| - /**
|
| - * `next_page_token` can be sent in a subsequent
|
| - * ListInstanceConfigs call to
|
| - * fetch more of the matching instance configurations.
|
| - */
|
| +
|
| + /// `next_page_token` can be sent in a subsequent
|
| + /// ListInstanceConfigs call to
|
| + /// fetch more of the matching instance configurations.
|
| core.String nextPageToken;
|
|
|
| ListInstanceConfigsResponse();
|
|
|
| ListInstanceConfigsResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("instanceConfigs")) {
|
| - instanceConfigs = _json["instanceConfigs"].map((value) => new InstanceConfig.fromJson(value)).toList();
|
| + instanceConfigs = _json["instanceConfigs"]
|
| + .map((value) => new InstanceConfig.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("nextPageToken")) {
|
| nextPageToken = _json["nextPageToken"];
|
| @@ -3646,9 +3118,11 @@ class ListInstanceConfigsResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (instanceConfigs != null) {
|
| - _json["instanceConfigs"] = instanceConfigs.map((value) => (value).toJson()).toList();
|
| + _json["instanceConfigs"] =
|
| + instanceConfigs.map((value) => (value).toJson()).toList();
|
| }
|
| if (nextPageToken != null) {
|
| _json["nextPageToken"] = nextPageToken;
|
| @@ -3657,22 +3131,23 @@ class ListInstanceConfigsResponse {
|
| }
|
| }
|
|
|
| -/** The response for ListInstances. */
|
| +/// The response for ListInstances.
|
| class ListInstancesResponse {
|
| - /** The list of requested instances. */
|
| + /// The list of requested instances.
|
| core.List<Instance> instances;
|
| - /**
|
| - * `next_page_token` can be sent in a subsequent
|
| - * ListInstances call to fetch more
|
| - * of the matching instances.
|
| - */
|
| +
|
| + /// `next_page_token` can be sent in a subsequent
|
| + /// ListInstances call to fetch more
|
| + /// of the matching instances.
|
| core.String nextPageToken;
|
|
|
| ListInstancesResponse();
|
|
|
| ListInstancesResponse.fromJson(core.Map _json) {
|
| if (_json.containsKey("instances")) {
|
| - instances = _json["instances"].map((value) => new Instance.fromJson(value)).toList();
|
| + instances = _json["instances"]
|
| + .map((value) => new Instance.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("nextPageToken")) {
|
| nextPageToken = _json["nextPageToken"];
|
| @@ -3680,7 +3155,8 @@ class ListInstancesResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (instances != null) {
|
| _json["instances"] = instances.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -3691,11 +3167,12 @@ class ListInstancesResponse {
|
| }
|
| }
|
|
|
| -/** The response message for Operations.ListOperations. */
|
| +/// The response message for Operations.ListOperations.
|
| class ListOperationsResponse {
|
| - /** The standard List next-page token. */
|
| + /// The standard List next-page token.
|
| core.String nextPageToken;
|
| - /** A list of operations that matches the specified filter in the request. */
|
| +
|
| + /// A list of operations that matches the specified filter in the request.
|
| core.List<Operation> operations;
|
|
|
| ListOperationsResponse();
|
| @@ -3705,117 +3182,51 @@ class ListOperationsResponse {
|
| nextPageToken = _json["nextPageToken"];
|
| }
|
| if (_json.containsKey("operations")) {
|
| - operations = _json["operations"].map((value) => new Operation.fromJson(value)).toList();
|
| + operations = _json["operations"]
|
| + .map((value) => new Operation.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (nextPageToken != null) {
|
| _json["nextPageToken"] = nextPageToken;
|
| }
|
| if (operations != null) {
|
| - _json["operations"] = operations.map((value) => (value).toJson()).toList();
|
| + _json["operations"] =
|
| + operations.map((value) => (value).toJson()).toList();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * Specifies what kind of log the caller must write
|
| - * Increment a streamz counter with the specified metric and field names.
|
| - *
|
| - * Metric names should start with a '/', generally be lowercase-only,
|
| - * and end in "_count". Field names should not contain an initial slash.
|
| - * The actual exported metric names will have "/iam/policy" prepended.
|
| - *
|
| - * Field names correspond to IAM request parameters and field values are
|
| - * their respective values.
|
| - *
|
| - * At present the only supported field names are
|
| - * - "iam_principal", corresponding to IAMContext.principal;
|
| - * - "" (empty string), resulting in one aggretated counter with no field.
|
| - *
|
| - * Examples:
|
| - * counter { metric: "/debug_access_count" field: "iam_principal" }
|
| - * ==> increment counter /iam/policy/backend_debug_access_count
|
| - * {iam_principal=[value of IAMContext.principal]}
|
| - *
|
| - * At this time we do not support:
|
| - * * multiple field names (though this may be supported in the future)
|
| - * * decrementing the counter
|
| - * * incrementing it by anything other than 1
|
| - */
|
| -class LogConfig {
|
| - /** Cloud audit options. */
|
| - CloudAuditOptions cloudAudit;
|
| - /** Counter options. */
|
| - CounterOptions counter;
|
| - /** Data access options. */
|
| - DataAccessOptions dataAccess;
|
| -
|
| - LogConfig();
|
| -
|
| - LogConfig.fromJson(core.Map _json) {
|
| - if (_json.containsKey("cloudAudit")) {
|
| - cloudAudit = new CloudAuditOptions.fromJson(_json["cloudAudit"]);
|
| - }
|
| - if (_json.containsKey("counter")) {
|
| - counter = new CounterOptions.fromJson(_json["counter"]);
|
| - }
|
| - if (_json.containsKey("dataAccess")) {
|
| - dataAccess = new DataAccessOptions.fromJson(_json["dataAccess"]);
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (cloudAudit != null) {
|
| - _json["cloudAudit"] = (cloudAudit).toJson();
|
| - }
|
| - if (counter != null) {
|
| - _json["counter"] = (counter).toJson();
|
| - }
|
| - if (dataAccess != null) {
|
| - _json["dataAccess"] = (dataAccess).toJson();
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/**
|
| - * A modification to one or more Cloud Spanner rows. Mutations can be
|
| - * applied to a Cloud Spanner database by sending them in a
|
| - * Commit call.
|
| - */
|
| +/// A modification to one or more Cloud Spanner rows. Mutations can be
|
| +/// applied to a Cloud Spanner database by sending them in a
|
| +/// Commit call.
|
| class Mutation {
|
| - /**
|
| - * Delete rows from a table. Succeeds whether or not the named
|
| - * rows were present.
|
| - */
|
| + /// Delete rows from a table. Succeeds whether or not the named
|
| + /// rows were present.
|
| Delete delete;
|
| - /**
|
| - * Insert new rows in a table. If any of the rows already exist,
|
| - * the write or transaction fails with error `ALREADY_EXISTS`.
|
| - */
|
| +
|
| + /// Insert new rows in a table. If any of the rows already exist,
|
| + /// the write or transaction fails with error `ALREADY_EXISTS`.
|
| Write insert;
|
| - /**
|
| - * Like insert, except that if the row already exists, then
|
| - * its column values are overwritten with the ones provided. Any
|
| - * column values not explicitly written are preserved.
|
| - */
|
| +
|
| + /// Like insert, except that if the row already exists, then
|
| + /// its column values are overwritten with the ones provided. Any
|
| + /// column values not explicitly written are preserved.
|
| Write insertOrUpdate;
|
| - /**
|
| - * Like insert, except that if the row already exists, it is
|
| - * deleted, and the column values provided are inserted
|
| - * instead. Unlike insert_or_update, this means any values not
|
| - * explicitly written become `NULL`.
|
| - */
|
| +
|
| + /// Like insert, except that if the row already exists, it is
|
| + /// deleted, and the column values provided are inserted
|
| + /// instead. Unlike insert_or_update, this means any values not
|
| + /// explicitly written become `NULL`.
|
| Write replace;
|
| - /**
|
| - * Update existing rows in a table. If any of the rows does not
|
| - * already exist, the transaction fails with error `NOT_FOUND`.
|
| - */
|
| +
|
| + /// Update existing rows in a table. If any of the rows does not
|
| + /// already exist, the transaction fails with error `NOT_FOUND`.
|
| Write update;
|
|
|
| Mutation();
|
| @@ -3839,7 +3250,8 @@ class Mutation {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (delete != null) {
|
| _json["delete"] = (delete).toJson();
|
| }
|
| @@ -3859,48 +3271,43 @@ class Mutation {
|
| }
|
| }
|
|
|
| -/**
|
| - * This resource represents a long-running operation that is the result of a
|
| - * network API call.
|
| - */
|
| +/// 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.
|
| - */
|
| + /// 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. */
|
| +
|
| + /// 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.
|
| - */
|
| +
|
| + /// 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 have the format of `operations/some/unique/name`.
|
| - */
|
| +
|
| + /// 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 have the format of `operations/some/unique/name`.
|
| 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.
|
| - */
|
| +
|
| + /// 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();
|
| @@ -3924,7 +3331,8 @@ class Operation {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (done != null) {
|
| _json["done"] = done;
|
| }
|
| @@ -3944,123 +3352,116 @@ class Operation {
|
| }
|
| }
|
|
|
| -/**
|
| - * Partial results from a streaming read or SQL query. Streaming reads and
|
| - * SQL queries better tolerate large result sets, large rows, and large
|
| - * values, but are a little trickier to consume.
|
| - */
|
| +/// Partial results from a streaming read or SQL query. Streaming reads and
|
| +/// SQL queries better tolerate large result sets, large rows, and large
|
| +/// values, but are a little trickier to consume.
|
| class PartialResultSet {
|
| - /**
|
| - * If true, then the final value in values is chunked, and must
|
| - * be combined with more values from subsequent `PartialResultSet`s
|
| - * to obtain a complete field value.
|
| - */
|
| + /// If true, then the final value in values is chunked, and must
|
| + /// be combined with more values from subsequent `PartialResultSet`s
|
| + /// to obtain a complete field value.
|
| core.bool chunkedValue;
|
| - /**
|
| - * Metadata about the result set, such as row type information.
|
| - * Only present in the first response.
|
| - */
|
| +
|
| + /// Metadata about the result set, such as row type information.
|
| + /// Only present in the first response.
|
| ResultSetMetadata metadata;
|
| - /**
|
| - * Streaming calls might be interrupted for a variety of reasons, such
|
| - * as TCP connection loss. If this occurs, the stream of results can
|
| - * be resumed by re-sending the original request and including
|
| - * `resume_token`. Note that executing any other transaction in the
|
| - * same session invalidates the token.
|
| - */
|
| +
|
| + /// Streaming calls might be interrupted for a variety of reasons, such
|
| + /// as TCP connection loss. If this occurs, the stream of results can
|
| + /// be resumed by re-sending the original request and including
|
| + /// `resume_token`. Note that executing any other transaction in the
|
| + /// same session invalidates the token.
|
| core.String resumeToken;
|
| core.List<core.int> get resumeTokenAsBytes {
|
| return convert.BASE64.decode(resumeToken);
|
| }
|
|
|
| void set resumeTokenAsBytes(core.List<core.int> _bytes) {
|
| - resumeToken = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| - }
|
| - /**
|
| - * Query plan and execution statistics for the query that produced this
|
| - * streaming result set. These can be requested by setting
|
| - * ExecuteSqlRequest.query_mode and are sent
|
| - * only once with the last response in the stream.
|
| - */
|
| + resumeToken =
|
| + convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + }
|
| +
|
| + /// Query plan and execution statistics for the query that produced this
|
| + /// streaming result set. These can be requested by setting
|
| + /// ExecuteSqlRequest.query_mode and are sent
|
| + /// only once with the last response in the stream.
|
| ResultSetStats stats;
|
| - /**
|
| - * A streamed result set consists of a stream of values, which might
|
| - * be split into many `PartialResultSet` messages to accommodate
|
| - * large rows and/or large values. Every N complete values defines a
|
| - * row, where N is equal to the number of entries in
|
| - * metadata.row_type.fields.
|
| - *
|
| - * Most values are encoded based on type as described
|
| - * here.
|
| - *
|
| - * It is possible that the last value in values is "chunked",
|
| - * meaning that the rest of the value is sent in subsequent
|
| - * `PartialResultSet`(s). This is denoted by the chunked_value
|
| - * field. Two or more chunked values can be merged to form a
|
| - * complete value as follows:
|
| - *
|
| - * * `bool/number/null`: cannot be chunked
|
| - * * `string`: concatenate the strings
|
| - * * `list`: concatenate the lists. If the last element in a list is a
|
| - * `string`, `list`, or `object`, merge it with the first element in
|
| - * the next list by applying these rules recursively.
|
| - * * `object`: concatenate the (field name, field value) pairs. If a
|
| - * field name is duplicated, then apply these rules recursively
|
| - * to merge the field values.
|
| - *
|
| - * Some examples of merging:
|
| - *
|
| - * # Strings are concatenated.
|
| - * "foo", "bar" => "foobar"
|
| - *
|
| - * # Lists of non-strings are concatenated.
|
| - * [2, 3], [4] => [2, 3, 4]
|
| - *
|
| - * # Lists are concatenated, but the last and first elements are merged
|
| - * # because they are strings.
|
| - * ["a", "b"], ["c", "d"] => ["a", "bc", "d"]
|
| - *
|
| - * # Lists are concatenated, but the last and first elements are merged
|
| - * # because they are lists. Recursively, the last and first elements
|
| - * # of the inner lists are merged because they are strings.
|
| - * ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]
|
| - *
|
| - * # Non-overlapping object fields are combined.
|
| - * {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}
|
| - *
|
| - * # Overlapping object fields are merged.
|
| - * {"a": "1"}, {"a": "2"} => {"a": "12"}
|
| - *
|
| - * # Examples of merging objects containing lists of strings.
|
| - * {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}
|
| - *
|
| - * For a more complete example, suppose a streaming SQL query is
|
| - * yielding a result set whose rows contain a single string
|
| - * field. The following `PartialResultSet`s might be yielded:
|
| - *
|
| - * {
|
| - * "metadata": { ... }
|
| - * "values": ["Hello", "W"]
|
| - * "chunked_value": true
|
| - * "resume_token": "Af65..."
|
| - * }
|
| - * {
|
| - * "values": ["orl"]
|
| - * "chunked_value": true
|
| - * "resume_token": "Bqp2..."
|
| - * }
|
| - * {
|
| - * "values": ["d"]
|
| - * "resume_token": "Zx1B..."
|
| - * }
|
| - *
|
| - * This sequence of `PartialResultSet`s encodes two rows, one
|
| - * containing the field value `"Hello"`, and a second containing the
|
| - * field value `"World" = "W" + "orl" + "d"`.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// A streamed result set consists of a stream of values, which might
|
| + /// be split into many `PartialResultSet` messages to accommodate
|
| + /// large rows and/or large values. Every N complete values defines a
|
| + /// row, where N is equal to the number of entries in
|
| + /// metadata.row_type.fields.
|
| + ///
|
| + /// Most values are encoded based on type as described
|
| + /// here.
|
| + ///
|
| + /// It is possible that the last value in values is "chunked",
|
| + /// meaning that the rest of the value is sent in subsequent
|
| + /// `PartialResultSet`(s). This is denoted by the chunked_value
|
| + /// field. Two or more chunked values can be merged to form a
|
| + /// complete value as follows:
|
| + ///
|
| + /// * `bool/number/null`: cannot be chunked
|
| + /// * `string`: concatenate the strings
|
| + /// * `list`: concatenate the lists. If the last element in a list is a
|
| + /// `string`, `list`, or `object`, merge it with the first element in
|
| + /// the next list by applying these rules recursively.
|
| + /// * `object`: concatenate the (field name, field value) pairs. If a
|
| + /// field name is duplicated, then apply these rules recursively
|
| + /// to merge the field values.
|
| + ///
|
| + /// Some examples of merging:
|
| + ///
|
| + /// # Strings are concatenated.
|
| + /// "foo", "bar" => "foobar"
|
| + ///
|
| + /// # Lists of non-strings are concatenated.
|
| + /// [2, 3], [4] => [2, 3, 4]
|
| + ///
|
| + /// # Lists are concatenated, but the last and first elements are merged
|
| + /// # because they are strings.
|
| + /// ["a", "b"], ["c", "d"] => ["a", "bc", "d"]
|
| + ///
|
| + /// # Lists are concatenated, but the last and first elements are merged
|
| + /// # because they are lists. Recursively, the last and first elements
|
| + /// # of the inner lists are merged because they are strings.
|
| + /// ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"]
|
| + ///
|
| + /// # Non-overlapping object fields are combined.
|
| + /// {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"}
|
| + ///
|
| + /// # Overlapping object fields are merged.
|
| + /// {"a": "1"}, {"a": "2"} => {"a": "12"}
|
| + ///
|
| + /// # Examples of merging objects containing lists of strings.
|
| + /// {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]}
|
| + ///
|
| + /// For a more complete example, suppose a streaming SQL query is
|
| + /// yielding a result set whose rows contain a single string
|
| + /// field. The following `PartialResultSet`s might be yielded:
|
| + ///
|
| + /// {
|
| + /// "metadata": { ... }
|
| + /// "values": ["Hello", "W"]
|
| + /// "chunked_value": true
|
| + /// "resume_token": "Af65..."
|
| + /// }
|
| + /// {
|
| + /// "values": ["orl"]
|
| + /// "chunked_value": true
|
| + /// "resume_token": "Bqp2..."
|
| + /// }
|
| + /// {
|
| + /// "values": ["d"]
|
| + /// "resume_token": "Zx1B..."
|
| + /// }
|
| + ///
|
| + /// This sequence of `PartialResultSet`s encodes two rows, one
|
| + /// containing the field value `"Hello"`, and a second containing the
|
| + /// field value `"World" = "W" + "orl" + "d"`.
|
| + ///
|
| + /// 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.Object> values;
|
|
|
| PartialResultSet();
|
| @@ -4084,7 +3485,8 @@ class PartialResultSet {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (chunkedValue != null) {
|
| _json["chunkedValue"] = chunkedValue;
|
| }
|
| @@ -4104,65 +3506,68 @@ class PartialResultSet {
|
| }
|
| }
|
|
|
| -/** Node information for nodes appearing in a QueryPlan.plan_nodes. */
|
| +/// Node information for nodes appearing in a QueryPlan.plan_nodes.
|
| class PlanNode {
|
| - /** List of child node `index`es and their relationship to this parent. */
|
| + /// List of child node `index`es and their relationship to this parent.
|
| core.List<ChildLink> childLinks;
|
| - /** The display name for the node. */
|
| +
|
| + /// The display name for the node.
|
| core.String displayName;
|
| - /**
|
| - * The execution statistics associated with the node, contained in a group of
|
| - * key-value pairs. Only present if the plan was returned as a result of a
|
| - * profile query. For example, number of executions, number of rows/time per
|
| - * execution etc.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// The execution statistics associated with the node, contained in a group
|
| + /// of
|
| + /// key-value pairs. Only present if the plan was returned as a result of a
|
| + /// profile query. For example, number of executions, number of rows/time per
|
| + /// execution etc.
|
| + ///
|
| + /// 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> executionStats;
|
| - /** The `PlanNode`'s index in node list. */
|
| +
|
| + /// The `PlanNode`'s index in node list.
|
| core.int index;
|
| - /**
|
| - * Used to determine the type of node. May be needed for visualizing
|
| - * different kinds of nodes differently. For example, If the node is a
|
| - * SCALAR node, it will have a condensed representation
|
| - * which can be used to directly embed a description of the node in its
|
| - * parent.
|
| - * Possible string values are:
|
| - * - "KIND_UNSPECIFIED" : Not specified.
|
| - * - "RELATIONAL" : Denotes a Relational operator node in the expression tree.
|
| - * Relational
|
| - * operators represent iterative processing of rows during query execution.
|
| - * For example, a `TableScan` operation that reads rows from a table.
|
| - * - "SCALAR" : Denotes a Scalar node in the expression tree. Scalar nodes
|
| - * represent
|
| - * non-iterable entities in the query plan. For example, constants or
|
| - * arithmetic operators appearing inside predicate expressions or references
|
| - * to column names.
|
| - */
|
| +
|
| + /// Used to determine the type of node. May be needed for visualizing
|
| + /// different kinds of nodes differently. For example, If the node is a
|
| + /// SCALAR node, it will have a condensed representation
|
| + /// which can be used to directly embed a description of the node in its
|
| + /// parent.
|
| + /// Possible string values are:
|
| + /// - "KIND_UNSPECIFIED" : Not specified.
|
| + /// - "RELATIONAL" : Denotes a Relational operator node in the expression
|
| + /// tree. Relational
|
| + /// operators represent iterative processing of rows during query execution.
|
| + /// For example, a `TableScan` operation that reads rows from a table.
|
| + /// - "SCALAR" : Denotes a Scalar node in the expression tree. Scalar nodes
|
| + /// represent
|
| + /// non-iterable entities in the query plan. For example, constants or
|
| + /// arithmetic operators appearing inside predicate expressions or references
|
| + /// to column names.
|
| core.String kind;
|
| - /**
|
| - * Attributes relevant to the node contained in a group of key-value pairs.
|
| - * For example, a Parameter Reference node could have the following
|
| - * information in its metadata:
|
| - *
|
| - * {
|
| - * "parameter_reference": "param1",
|
| - * "parameter_type": "array"
|
| - * }
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// Attributes relevant to the node contained in a group of key-value pairs.
|
| + /// For example, a Parameter Reference node could have the following
|
| + /// information in its metadata:
|
| + ///
|
| + /// {
|
| + /// "parameter_reference": "param1",
|
| + /// "parameter_type": "array"
|
| + /// }
|
| + ///
|
| + /// 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;
|
| - /** Condensed representation for SCALAR nodes. */
|
| +
|
| + /// Condensed representation for SCALAR nodes.
|
| ShortRepresentation shortRepresentation;
|
|
|
| PlanNode();
|
|
|
| PlanNode.fromJson(core.Map _json) {
|
| if (_json.containsKey("childLinks")) {
|
| - childLinks = _json["childLinks"].map((value) => new ChildLink.fromJson(value)).toList();
|
| + childLinks = _json["childLinks"]
|
| + .map((value) => new ChildLink.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("displayName")) {
|
| displayName = _json["displayName"];
|
| @@ -4180,14 +3585,17 @@ class PlanNode {
|
| metadata = _json["metadata"];
|
| }
|
| if (_json.containsKey("shortRepresentation")) {
|
| - shortRepresentation = new ShortRepresentation.fromJson(_json["shortRepresentation"]);
|
| + shortRepresentation =
|
| + new ShortRepresentation.fromJson(_json["shortRepresentation"]);
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (childLinks != null) {
|
| - _json["childLinks"] = childLinks.map((value) => (value).toJson()).toList();
|
| + _json["childLinks"] =
|
| + childLinks.map((value) => (value).toJson()).toList();
|
| }
|
| if (displayName != null) {
|
| _json["displayName"] = displayName;
|
| @@ -4211,123 +3619,93 @@ class PlanNode {
|
| }
|
| }
|
|
|
| -/**
|
| - * Defines an Identity and Access Management (IAM) policy. It is used to
|
| - * specify access control policies for Cloud Platform resources.
|
| - *
|
| - *
|
| - * A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
|
| - * `members` to a `role`, where the members can be user accounts, Google groups,
|
| - * Google domains, and service accounts. A `role` is a named list of permissions
|
| - * defined by IAM.
|
| - *
|
| - * **Example**
|
| - *
|
| - * {
|
| - * "bindings": [
|
| - * {
|
| - * "role": "roles/owner",
|
| - * "members": [
|
| - * "user:mike@example.com",
|
| - * "group:admins@example.com",
|
| - * "domain:google.com",
|
| - * "serviceAccount:my-other-app@appspot.gserviceaccount.com",
|
| - * ]
|
| - * },
|
| - * {
|
| - * "role": "roles/viewer",
|
| - * "members": ["user:sean@example.com"]
|
| - * }
|
| - * ]
|
| - * }
|
| - *
|
| - * For a description of IAM and its features, see the
|
| - * [IAM developer's guide](https://cloud.google.com/iam).
|
| - */
|
| +/// Defines an Identity and Access Management (IAM) policy. It is used to
|
| +/// specify access control policies for Cloud Platform resources.
|
| +///
|
| +///
|
| +/// A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
|
| +/// `members` to a `role`, where the members can be user accounts, Google
|
| +/// groups,
|
| +/// Google domains, and service accounts. A `role` is a named list of
|
| +/// permissions
|
| +/// defined by IAM.
|
| +///
|
| +/// **Example**
|
| +///
|
| +/// {
|
| +/// "bindings": [
|
| +/// {
|
| +/// "role": "roles/owner",
|
| +/// "members": [
|
| +/// "user:mike@example.com",
|
| +/// "group:admins@example.com",
|
| +/// "domain:google.com",
|
| +/// "serviceAccount:my-other-app@appspot.gserviceaccount.com",
|
| +/// ]
|
| +/// },
|
| +/// {
|
| +/// "role": "roles/viewer",
|
| +/// "members": ["user:sean@example.com"]
|
| +/// }
|
| +/// ]
|
| +/// }
|
| +///
|
| +/// For a description of IAM and its features, see the
|
| +/// [IAM developer's guide](https://cloud.google.com/iam).
|
| class Policy {
|
| - /** Specifies cloud audit logging configuration for this policy. */
|
| - core.List<AuditConfig> auditConfigs;
|
| - /**
|
| - * Associates a list of `members` to a `role`.
|
| - * `bindings` with no members will result in an error.
|
| - */
|
| + /// Associates a list of `members` to a `role`.
|
| + /// `bindings` with no members will result in an error.
|
| core.List<Binding> bindings;
|
| - /**
|
| - * `etag` is used for optimistic concurrency control as a way to help
|
| - * prevent simultaneous updates of a policy from overwriting each other.
|
| - * It is strongly suggested that systems make use of the `etag` in the
|
| - * read-modify-write cycle to perform policy updates in order to avoid race
|
| - * conditions: An `etag` is returned in the response to `getIamPolicy`, and
|
| - * systems are expected to put that etag in the request to `setIamPolicy` to
|
| - * ensure that their change will be applied to the same version of the policy.
|
| - *
|
| - * If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
| - * policy is overwritten blindly.
|
| - */
|
| +
|
| + /// `etag` is used for optimistic concurrency control as a way to help
|
| + /// prevent simultaneous updates of a policy from overwriting each other.
|
| + /// It is strongly suggested that systems make use of the `etag` in the
|
| + /// read-modify-write cycle to perform policy updates in order to avoid race
|
| + /// conditions: An `etag` is returned in the response to `getIamPolicy`, and
|
| + /// systems are expected to put that etag in the request to `setIamPolicy` to
|
| + /// ensure that their change will be applied to the same version of the
|
| + /// policy.
|
| + ///
|
| + /// If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
| + /// policy is overwritten blindly.
|
| core.String etag;
|
| core.List<core.int> get etagAsBytes {
|
| return convert.BASE64.decode(etag);
|
| }
|
|
|
| void set etagAsBytes(core.List<core.int> _bytes) {
|
| - etag = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| - }
|
| - core.bool iamOwned;
|
| - /**
|
| - * If more than one rule is specified, the rules are applied in the following
|
| - * manner:
|
| - * - All matching LOG rules are always applied.
|
| - * - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
|
| - * Logging will be applied if one or more matching rule requires logging.
|
| - * - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
|
| - * granted.
|
| - * Logging will be applied if one or more matching rule requires logging.
|
| - * - Otherwise, if no rule applies, permission is denied.
|
| - */
|
| - core.List<Rule> rules;
|
| - /** Version of the `Policy`. The default version is 0. */
|
| + etag =
|
| + convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + }
|
| +
|
| + /// Version of the `Policy`. The default version is 0.
|
| core.int version;
|
|
|
| Policy();
|
|
|
| Policy.fromJson(core.Map _json) {
|
| - if (_json.containsKey("auditConfigs")) {
|
| - auditConfigs = _json["auditConfigs"].map((value) => new AuditConfig.fromJson(value)).toList();
|
| - }
|
| if (_json.containsKey("bindings")) {
|
| - bindings = _json["bindings"].map((value) => new Binding.fromJson(value)).toList();
|
| + bindings = _json["bindings"]
|
| + .map((value) => new Binding.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("etag")) {
|
| etag = _json["etag"];
|
| }
|
| - if (_json.containsKey("iamOwned")) {
|
| - iamOwned = _json["iamOwned"];
|
| - }
|
| - if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new Rule.fromJson(value)).toList();
|
| - }
|
| if (_json.containsKey("version")) {
|
| version = _json["version"];
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (auditConfigs != null) {
|
| - _json["auditConfigs"] = auditConfigs.map((value) => (value).toJson()).toList();
|
| - }
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (bindings != null) {
|
| _json["bindings"] = bindings.map((value) => (value).toJson()).toList();
|
| }
|
| if (etag != null) {
|
| _json["etag"] = etag;
|
| }
|
| - if (iamOwned != null) {
|
| - _json["iamOwned"] = iamOwned;
|
| - }
|
| - if (rules != null) {
|
| - _json["rules"] = rules.map((value) => (value).toJson()).toList();
|
| - }
|
| if (version != null) {
|
| _json["version"] = version;
|
| }
|
| @@ -4335,25 +3713,27 @@ class Policy {
|
| }
|
| }
|
|
|
| -/** Contains an ordered list of nodes appearing in the query plan. */
|
| +/// Contains an ordered list of nodes appearing in the query plan.
|
| class QueryPlan {
|
| - /**
|
| - * The nodes in the query plan. Plan nodes are returned in pre-order starting
|
| - * with the plan root. Each PlanNode's `id` corresponds to its index in
|
| - * `plan_nodes`.
|
| - */
|
| + /// The nodes in the query plan. Plan nodes are returned in pre-order
|
| + /// starting
|
| + /// with the plan root. Each PlanNode's `id` corresponds to its index in
|
| + /// `plan_nodes`.
|
| core.List<PlanNode> planNodes;
|
|
|
| QueryPlan();
|
|
|
| QueryPlan.fromJson(core.Map _json) {
|
| if (_json.containsKey("planNodes")) {
|
| - planNodes = _json["planNodes"].map((value) => new PlanNode.fromJson(value)).toList();
|
| + planNodes = _json["planNodes"]
|
| + .map((value) => new PlanNode.fromJson(value))
|
| + .toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (planNodes != null) {
|
| _json["planNodes"] = planNodes.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -4361,69 +3741,62 @@ class QueryPlan {
|
| }
|
| }
|
|
|
| -/** Message type to initiate a read-only transaction. */
|
| +/// Message type to initiate a read-only transaction.
|
| class ReadOnly {
|
| - /**
|
| - * Executes all reads at a timestamp that is `exact_staleness`
|
| - * old. The timestamp is chosen soon after the read is started.
|
| - *
|
| - * Guarantees that all writes that have committed more than the
|
| - * specified number of seconds ago are visible. Because Cloud Spanner
|
| - * chooses the exact timestamp, this mode works even if the client's
|
| - * local clock is substantially skewed from Cloud Spanner commit
|
| - * timestamps.
|
| - *
|
| - * Useful for reading at nearby replicas without the distributed
|
| - * timestamp negotiation overhead of `max_staleness`.
|
| - */
|
| + /// Executes all reads at a timestamp that is `exact_staleness`
|
| + /// old. The timestamp is chosen soon after the read is started.
|
| + ///
|
| + /// Guarantees that all writes that have committed more than the
|
| + /// specified number of seconds ago are visible. Because Cloud Spanner
|
| + /// chooses the exact timestamp, this mode works even if the client's
|
| + /// local clock is substantially skewed from Cloud Spanner commit
|
| + /// timestamps.
|
| + ///
|
| + /// Useful for reading at nearby replicas without the distributed
|
| + /// timestamp negotiation overhead of `max_staleness`.
|
| core.String exactStaleness;
|
| - /**
|
| - * Read data at a timestamp >= `NOW - max_staleness`
|
| - * seconds. Guarantees that all writes that have committed more
|
| - * than the specified number of seconds ago are visible. Because
|
| - * Cloud Spanner chooses the exact timestamp, this mode works even if
|
| - * the client's local clock is substantially skewed from Cloud Spanner
|
| - * commit timestamps.
|
| - *
|
| - * Useful for reading the freshest data available at a nearby
|
| - * replica, while bounding the possible staleness if the local
|
| - * replica has fallen behind.
|
| - *
|
| - * Note that this option can only be used in single-use
|
| - * transactions.
|
| - */
|
| +
|
| + /// Read data at a timestamp >= `NOW - max_staleness`
|
| + /// seconds. Guarantees that all writes that have committed more
|
| + /// than the specified number of seconds ago are visible. Because
|
| + /// Cloud Spanner chooses the exact timestamp, this mode works even if
|
| + /// the client's local clock is substantially skewed from Cloud Spanner
|
| + /// commit timestamps.
|
| + ///
|
| + /// Useful for reading the freshest data available at a nearby
|
| + /// replica, while bounding the possible staleness if the local
|
| + /// replica has fallen behind.
|
| + ///
|
| + /// Note that this option can only be used in single-use
|
| + /// transactions.
|
| core.String maxStaleness;
|
| - /**
|
| - * Executes all reads at a timestamp >= `min_read_timestamp`.
|
| - *
|
| - * This is useful for requesting fresher data than some previous
|
| - * read, or data that is fresh enough to observe the effects of some
|
| - * previously committed transaction whose timestamp is known.
|
| - *
|
| - * Note that this option can only be used in single-use transactions.
|
| - */
|
| +
|
| + /// Executes all reads at a timestamp >= `min_read_timestamp`.
|
| + ///
|
| + /// This is useful for requesting fresher data than some previous
|
| + /// read, or data that is fresh enough to observe the effects of some
|
| + /// previously committed transaction whose timestamp is known.
|
| + ///
|
| + /// Note that this option can only be used in single-use transactions.
|
| core.String minReadTimestamp;
|
| - /**
|
| - * Executes all reads at the given timestamp. Unlike other modes,
|
| - * reads at a specific timestamp are repeatable; the same read at
|
| - * the same timestamp always returns the same data. If the
|
| - * timestamp is in the future, the read will block until the
|
| - * specified timestamp, modulo the read's deadline.
|
| - *
|
| - * Useful for large scale consistent reads such as mapreduces, or
|
| - * for coordinating many reads against a consistent snapshot of the
|
| - * data.
|
| - */
|
| +
|
| + /// Executes all reads at the given timestamp. Unlike other modes,
|
| + /// reads at a specific timestamp are repeatable; the same read at
|
| + /// the same timestamp always returns the same data. If the
|
| + /// timestamp is in the future, the read will block until the
|
| + /// specified timestamp, modulo the read's deadline.
|
| + ///
|
| + /// Useful for large scale consistent reads such as mapreduces, or
|
| + /// for coordinating many reads against a consistent snapshot of the
|
| + /// data.
|
| core.String readTimestamp;
|
| - /**
|
| - * If true, the Cloud Spanner-selected read timestamp is included in
|
| - * the Transaction message that describes the transaction.
|
| - */
|
| +
|
| + /// If true, the Cloud Spanner-selected read timestamp is included in
|
| + /// the Transaction message that describes the transaction.
|
| core.bool returnReadTimestamp;
|
| - /**
|
| - * Read at a timestamp where all previously committed transactions
|
| - * are visible.
|
| - */
|
| +
|
| + /// Read at a timestamp where all previously committed transactions
|
| + /// are visible.
|
| core.bool strong;
|
|
|
| ReadOnly();
|
| @@ -4450,7 +3823,8 @@ class ReadOnly {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (exactStaleness != null) {
|
| _json["exactStaleness"] = exactStaleness;
|
| }
|
| @@ -4473,62 +3847,56 @@ class ReadOnly {
|
| }
|
| }
|
|
|
| -/**
|
| - * The request for Read and
|
| - * StreamingRead.
|
| - */
|
| +/// The request for Read and
|
| +/// StreamingRead.
|
| class ReadRequest {
|
| - /**
|
| - * The columns of table to be returned for each row matching
|
| - * this request.
|
| - */
|
| + /// The columns of table to be returned for each row matching
|
| + /// this request.
|
| core.List<core.String> columns;
|
| - /**
|
| - * If non-empty, the name of an index on table. This index is
|
| - * used instead of the table primary key when interpreting key_set
|
| - * and sorting result rows. See key_set for further information.
|
| - */
|
| +
|
| + /// If non-empty, the name of an index on table. This index is
|
| + /// used instead of the table primary key when interpreting key_set
|
| + /// and sorting result rows. See key_set for further information.
|
| core.String index;
|
| - /**
|
| - * Required. `key_set` identifies the rows to be yielded. `key_set` names the
|
| - * primary keys of the rows in table to be yielded, unless index
|
| - * is present. If index is present, then key_set instead names
|
| - * index keys in index.
|
| - *
|
| - * Rows are yielded in table primary key order (if index is empty)
|
| - * or index key order (if index is non-empty).
|
| - *
|
| - * It is not an error for the `key_set` to name rows that do not
|
| - * exist in the database. Read yields nothing for nonexistent rows.
|
| - */
|
| +
|
| + /// Required. `key_set` identifies the rows to be yielded. `key_set` names
|
| + /// the
|
| + /// primary keys of the rows in table to be yielded, unless index
|
| + /// is present. If index is present, then key_set instead names
|
| + /// index keys in index.
|
| + ///
|
| + /// Rows are yielded in table primary key order (if index is empty)
|
| + /// or index key order (if index is non-empty).
|
| + ///
|
| + /// It is not an error for the `key_set` to name rows that do not
|
| + /// exist in the database. Read yields nothing for nonexistent rows.
|
| KeySet keySet;
|
| - /**
|
| - * If greater than zero, only the first `limit` rows are yielded. If `limit`
|
| - * is zero, the default is no limit.
|
| - */
|
| +
|
| + /// If greater than zero, only the first `limit` rows are yielded. If `limit`
|
| + /// is zero, the default is no limit.
|
| core.String limit;
|
| - /**
|
| - * If this request is resuming a previously interrupted read,
|
| - * `resume_token` should be copied from the last
|
| - * PartialResultSet yielded before the interruption. Doing this
|
| - * enables the new read to resume where the last read left off. The
|
| - * rest of the request parameters must exactly match the request
|
| - * that yielded this token.
|
| - */
|
| +
|
| + /// If this request is resuming a previously interrupted read,
|
| + /// `resume_token` should be copied from the last
|
| + /// PartialResultSet yielded before the interruption. Doing this
|
| + /// enables the new read to resume where the last read left off. The
|
| + /// rest of the request parameters must exactly match the request
|
| + /// that yielded this token.
|
| core.String resumeToken;
|
| core.List<core.int> get resumeTokenAsBytes {
|
| return convert.BASE64.decode(resumeToken);
|
| }
|
|
|
| void set resumeTokenAsBytes(core.List<core.int> _bytes) {
|
| - resumeToken = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + resumeToken =
|
| + convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| }
|
| - /** Required. The name of the table in the database to be read. */
|
| +
|
| + /// Required. The name of the table in the database to be read.
|
| core.String table;
|
| - /**
|
| - * The transaction to use. If none is provided, the default is a
|
| - * temporary read-only transaction with strong concurrency.
|
| - */
|
| +
|
| + /// The transaction to use. If none is provided, the default is a
|
| + /// temporary read-only transaction with strong concurrency.
|
| TransactionSelector transaction;
|
|
|
| ReadRequest();
|
| @@ -4558,7 +3926,8 @@ class ReadRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (columns != null) {
|
| _json["columns"] = columns;
|
| }
|
| @@ -4584,47 +3953,40 @@ class ReadRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Message type to initiate a read-write transaction. Currently this
|
| - * transaction type has no options.
|
| - */
|
| +/// Message type to initiate a read-write transaction. Currently this
|
| +/// transaction type has no options.
|
| class ReadWrite {
|
| -
|
| ReadWrite();
|
|
|
| - ReadWrite.fromJson(core.Map _json) {
|
| - }
|
| + ReadWrite.fromJson(core.Map _json) {}
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * Results from Read or
|
| - * ExecuteSql.
|
| - */
|
| +/// Results from Read or
|
| +/// ExecuteSql.
|
| class ResultSet {
|
| - /** Metadata about the result set, such as row type information. */
|
| + /// Metadata about the result set, such as row type information.
|
| ResultSetMetadata metadata;
|
| - /**
|
| - * Each element in `rows` is a row whose format is defined by
|
| - * metadata.row_type. The ith element
|
| - * in each row matches the ith field in
|
| - * metadata.row_type. Elements are
|
| - * encoded based on type as described
|
| - * here.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// Each element in `rows` is a row whose format is defined by
|
| + /// metadata.row_type. The ith element
|
| + /// in each row matches the ith field in
|
| + /// metadata.row_type. Elements are
|
| + /// encoded based on type as described
|
| + /// here.
|
| + ///
|
| + /// 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.List<core.Object>> rows;
|
| - /**
|
| - * Query plan and execution statistics for the query that produced this
|
| - * result set. These can be requested by setting
|
| - * ExecuteSqlRequest.query_mode.
|
| - */
|
| +
|
| + /// Query plan and execution statistics for the query that produced this
|
| + /// result set. These can be requested by setting
|
| + /// ExecuteSqlRequest.query_mode.
|
| ResultSetStats stats;
|
|
|
| ResultSet();
|
| @@ -4642,7 +4004,8 @@ class ResultSet {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (metadata != null) {
|
| _json["metadata"] = (metadata).toJson();
|
| }
|
| @@ -4656,23 +4019,20 @@ class ResultSet {
|
| }
|
| }
|
|
|
| -/** Metadata about a ResultSet or PartialResultSet. */
|
| +/// Metadata about a ResultSet or PartialResultSet.
|
| class ResultSetMetadata {
|
| - /**
|
| - * Indicates the field names and types for the rows in the result
|
| - * set. For example, a SQL query like `"SELECT UserId, UserName FROM
|
| - * Users"` could return a `row_type` value like:
|
| - *
|
| - * "fields": [
|
| - * { "name": "UserId", "type": { "code": "INT64" } },
|
| - * { "name": "UserName", "type": { "code": "STRING" } },
|
| - * ]
|
| - */
|
| + /// Indicates the field names and types for the rows in the result
|
| + /// set. For example, a SQL query like `"SELECT UserId, UserName FROM
|
| + /// Users"` could return a `row_type` value like:
|
| + ///
|
| + /// "fields": [
|
| + /// { "name": "UserId", "type": { "code": "INT64" } },
|
| + /// { "name": "UserName", "type": { "code": "STRING" } },
|
| + /// ]
|
| StructType rowType;
|
| - /**
|
| - * If the read or SQL query began a transaction as a side-effect, the
|
| - * information about the new transaction is yielded here.
|
| - */
|
| +
|
| + /// If the read or SQL query began a transaction as a side-effect, the
|
| + /// information about the new transaction is yielded here.
|
| Transaction transaction;
|
|
|
| ResultSetMetadata();
|
| @@ -4687,7 +4047,8 @@ class ResultSetMetadata {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (rowType != null) {
|
| _json["rowType"] = (rowType).toJson();
|
| }
|
| @@ -4698,24 +4059,24 @@ class ResultSetMetadata {
|
| }
|
| }
|
|
|
| -/** Additional statistics about a ResultSet or PartialResultSet. */
|
| +/// Additional statistics about a ResultSet or PartialResultSet.
|
| class ResultSetStats {
|
| - /** QueryPlan for the query associated with this result. */
|
| + /// QueryPlan for the query associated with this result.
|
| QueryPlan queryPlan;
|
| - /**
|
| - * Aggregated statistics from the execution of the query. Only present when
|
| - * the query is profiled. For example, a query could return the statistics as
|
| - * follows:
|
| - *
|
| - * {
|
| - * "rows_returned": "3",
|
| - * "elapsed_time": "1.22 secs",
|
| - * "cpu_time": "1.19 secs"
|
| - * }
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// Aggregated statistics from the execution of the query. Only present when
|
| + /// the query is profiled. For example, a query could return the statistics
|
| + /// as
|
| + /// follows:
|
| + ///
|
| + /// {
|
| + /// "rows_returned": "3",
|
| + /// "elapsed_time": "1.22 secs",
|
| + /// "cpu_time": "1.19 secs"
|
| + /// }
|
| + ///
|
| + /// 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> queryStats;
|
|
|
| ResultSetStats();
|
| @@ -4730,7 +4091,8 @@ class ResultSetStats {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (queryPlan != null) {
|
| _json["queryPlan"] = (queryPlan).toJson();
|
| }
|
| @@ -4741,16 +4103,17 @@ class ResultSetStats {
|
| }
|
| }
|
|
|
| -/** The request for Rollback. */
|
| +/// The request for Rollback.
|
| class RollbackRequest {
|
| - /** Required. The transaction to roll back. */
|
| + /// Required. The transaction to roll back.
|
| core.String transactionId;
|
| core.List<core.int> get transactionIdAsBytes {
|
| return convert.BASE64.decode(transactionId);
|
| }
|
|
|
| void set transactionIdAsBytes(core.List<core.int> _bytes) {
|
| - transactionId = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + transactionId =
|
| + convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| }
|
|
|
| RollbackRequest();
|
| @@ -4762,7 +4125,8 @@ class RollbackRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (transactionId != null) {
|
| _json["transactionId"] = transactionId;
|
| }
|
| @@ -4770,107 +4134,9 @@ class RollbackRequest {
|
| }
|
| }
|
|
|
| -/** A rule to be applied in a Policy. */
|
| -class Rule {
|
| - /**
|
| - * Required
|
| - * Possible string values are:
|
| - * - "NO_ACTION" : Default no action.
|
| - * - "ALLOW" : Matching 'Entries' grant access.
|
| - * - "ALLOW_WITH_LOG" : Matching 'Entries' grant access and the caller
|
| - * promises to log
|
| - * the request per the returned log_configs.
|
| - * - "DENY" : Matching 'Entries' deny access.
|
| - * - "DENY_WITH_LOG" : Matching 'Entries' deny access and the caller promises
|
| - * to log
|
| - * the request per the returned log_configs.
|
| - * - "LOG" : Matching 'Entries' tell IAM.Check callers to generate logs.
|
| - */
|
| - core.String action;
|
| - /** Additional restrictions that must be met */
|
| - core.List<Condition> conditions;
|
| - /** Human-readable description of the rule. */
|
| - core.String description;
|
| - /**
|
| - * If one or more 'in' clauses are specified, the rule matches if
|
| - * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
|
| - */
|
| - core.List<core.String> in_;
|
| - /**
|
| - * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
|
| - * that match the LOG action.
|
| - */
|
| - core.List<LogConfig> logConfig;
|
| - /**
|
| - * If one or more 'not_in' clauses are specified, the rule matches
|
| - * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
|
| - * The format for in and not_in entries is the same as for members in a
|
| - * Binding (see google/iam/v1/policy.proto).
|
| - */
|
| - core.List<core.String> notIn;
|
| - /**
|
| - * A permission is a string of form '<service>.<resource type>.<verb>'
|
| - * (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
|
| - * and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
|
| - */
|
| - core.List<core.String> permissions;
|
| -
|
| - Rule();
|
| -
|
| - Rule.fromJson(core.Map _json) {
|
| - if (_json.containsKey("action")) {
|
| - action = _json["action"];
|
| - }
|
| - if (_json.containsKey("conditions")) {
|
| - conditions = _json["conditions"].map((value) => new Condition.fromJson(value)).toList();
|
| - }
|
| - if (_json.containsKey("description")) {
|
| - description = _json["description"];
|
| - }
|
| - if (_json.containsKey("in")) {
|
| - in_ = _json["in"];
|
| - }
|
| - if (_json.containsKey("logConfig")) {
|
| - logConfig = _json["logConfig"].map((value) => new LogConfig.fromJson(value)).toList();
|
| - }
|
| - if (_json.containsKey("notIn")) {
|
| - notIn = _json["notIn"];
|
| - }
|
| - if (_json.containsKey("permissions")) {
|
| - permissions = _json["permissions"];
|
| - }
|
| - }
|
| -
|
| - core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| - if (action != null) {
|
| - _json["action"] = action;
|
| - }
|
| - if (conditions != null) {
|
| - _json["conditions"] = conditions.map((value) => (value).toJson()).toList();
|
| - }
|
| - if (description != null) {
|
| - _json["description"] = description;
|
| - }
|
| - if (in_ != null) {
|
| - _json["in"] = in_;
|
| - }
|
| - if (logConfig != null) {
|
| - _json["logConfig"] = logConfig.map((value) => (value).toJson()).toList();
|
| - }
|
| - if (notIn != null) {
|
| - _json["notIn"] = notIn;
|
| - }
|
| - if (permissions != null) {
|
| - _json["permissions"] = permissions;
|
| - }
|
| - return _json;
|
| - }
|
| -}
|
| -
|
| -/** A session in the Cloud Spanner API. */
|
| +/// A session in the Cloud Spanner API.
|
| class Session {
|
| - /** Required. The name of the session. */
|
| + /// Required. The name of the session.
|
| core.String name;
|
|
|
| Session();
|
| @@ -4882,7 +4148,8 @@ class Session {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (name != null) {
|
| _json["name"] = name;
|
| }
|
| @@ -4890,23 +4157,14 @@ class Session {
|
| }
|
| }
|
|
|
| -/** Request message for `SetIamPolicy` method. */
|
| +/// Request message for `SetIamPolicy` method.
|
| class SetIamPolicyRequest {
|
| - /**
|
| - * REQUIRED: The complete policy to be applied to the `resource`. The size of
|
| - * the policy is limited to a few 10s of KB. An empty policy is a
|
| - * valid policy but certain Cloud Platform services (such as Projects)
|
| - * might reject them.
|
| - */
|
| + /// REQUIRED: The complete policy to be applied to the `resource`. The size
|
| + /// of
|
| + /// the policy is limited to a few 10s of KB. An empty policy is a
|
| + /// valid policy but certain Cloud Platform services (such as Projects)
|
| + /// might reject them.
|
| Policy policy;
|
| - /**
|
| - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
|
| - * the fields in the mask will be modified. If no mask is provided, the
|
| - * following default mask is used:
|
| - * paths: "bindings, etag"
|
| - * This field is only used by Cloud IAM.
|
| - */
|
| - core.String updateMask;
|
|
|
| SetIamPolicyRequest();
|
|
|
| @@ -4914,37 +4172,29 @@ class SetIamPolicyRequest {
|
| if (_json.containsKey("policy")) {
|
| policy = new Policy.fromJson(_json["policy"]);
|
| }
|
| - if (_json.containsKey("updateMask")) {
|
| - updateMask = _json["updateMask"];
|
| - }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (policy != null) {
|
| _json["policy"] = (policy).toJson();
|
| }
|
| - if (updateMask != null) {
|
| - _json["updateMask"] = updateMask;
|
| - }
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * Condensed representation of a node and its subtree. Only present for
|
| - * `SCALAR` PlanNode(s).
|
| - */
|
| +/// Condensed representation of a node and its subtree. Only present for
|
| +/// `SCALAR` PlanNode(s).
|
| class ShortRepresentation {
|
| - /** A string representation of the expression subtree rooted at this node. */
|
| + /// A string representation of the expression subtree rooted at this node.
|
| core.String description;
|
| - /**
|
| - * A mapping of (subquery variable name) -> (subquery node id) for cases
|
| - * where the `description` string of this node references a `SCALAR`
|
| - * subquery contained in the expression subtree rooted at this node. The
|
| - * referenced `SCALAR` subquery may not necessarily be a direct child of
|
| - * this node.
|
| - */
|
| +
|
| + /// A mapping of (subquery variable name) -> (subquery node id) for cases
|
| + /// where the `description` string of this node references a `SCALAR`
|
| + /// subquery contained in the expression subtree rooted at this node. The
|
| + /// referenced `SCALAR` subquery may not necessarily be a direct child of
|
| + /// this node.
|
| core.Map<core.String, core.int> subqueries;
|
|
|
| ShortRepresentation();
|
| @@ -4959,7 +4209,8 @@ class ShortRepresentation {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (description != null) {
|
| _json["description"] = description;
|
| }
|
| @@ -4970,78 +4221,81 @@ class ShortRepresentation {
|
| }
|
| }
|
|
|
| -/**
|
| - * 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). The error model is designed to be:
|
| - *
|
| - * - Simple to use and understand for most users
|
| - * - Flexible enough to meet unexpected needs
|
| - *
|
| - * # Overview
|
| - *
|
| - * The `Status` message contains three pieces of data: error code, error
|
| - * message,
|
| - * and error details. The error code should be an enum value of
|
| - * google.rpc.Code, but it may accept additional error codes if needed. The
|
| - * error message should be a developer-facing English message that helps
|
| - * developers *understand* and *resolve* the error. If a localized user-facing
|
| - * error message is needed, put the localized message in the error details or
|
| - * localize it in the client. The optional error details may contain arbitrary
|
| - * information about the error. There is a predefined set of error detail types
|
| - * in the package `google.rpc` that can be used for common error conditions.
|
| - *
|
| - * # Language mapping
|
| - *
|
| - * The `Status` message is the logical representation of the error model, but it
|
| - * is not necessarily the actual wire format. When the `Status` message is
|
| - * exposed in different client libraries and different wire protocols, it can be
|
| - * mapped differently. For example, it will likely be mapped to some exceptions
|
| - * in Java, but more likely mapped to some error codes in C.
|
| - *
|
| - * # Other uses
|
| - *
|
| - * The error model and the `Status` message can be used in a variety of
|
| - * environments, either with or without APIs, to provide a
|
| - * consistent developer experience across different environments.
|
| - *
|
| - * Example uses of this error model include:
|
| - *
|
| - * - Partial errors. If a service needs to return partial errors to the client,
|
| - * it may embed the `Status` in the normal response to indicate the partial
|
| - * errors.
|
| - *
|
| - * - Workflow errors. A typical workflow has multiple steps. Each step may
|
| - * have a `Status` message for error reporting.
|
| - *
|
| - * - Batch operations. If a client uses batch request and batch response, the
|
| - * `Status` message should be used directly inside batch response, one for
|
| - * each error sub-response.
|
| - *
|
| - * - Asynchronous operations. If an API call embeds asynchronous operation
|
| - * results in its response, the status of those operations should be
|
| - * represented directly using the `Status` message.
|
| - *
|
| - * - Logging. If some API errors are stored in logs, the message `Status` could
|
| - * be used directly after any stripping needed for security/privacy reasons.
|
| - */
|
| +/// 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). The error model is designed to be:
|
| +///
|
| +/// - Simple to use and understand for most users
|
| +/// - Flexible enough to meet unexpected needs
|
| +///
|
| +/// # Overview
|
| +///
|
| +/// The `Status` message contains three pieces of data: error code, error
|
| +/// message,
|
| +/// and error details. The error code should be an enum value of
|
| +/// google.rpc.Code, but it may accept additional error codes if needed. The
|
| +/// error message should be a developer-facing English message that helps
|
| +/// developers *understand* and *resolve* the error. If a localized user-facing
|
| +/// error message is needed, put the localized message in the error details or
|
| +/// localize it in the client. The optional error details may contain arbitrary
|
| +/// information about the error. There is a predefined set of error detail
|
| +/// types
|
| +/// in the package `google.rpc` that can be used for common error conditions.
|
| +///
|
| +/// # Language mapping
|
| +///
|
| +/// The `Status` message is the logical representation of the error model, but
|
| +/// it
|
| +/// is not necessarily the actual wire format. When the `Status` message is
|
| +/// exposed in different client libraries and different wire protocols, it can
|
| +/// be
|
| +/// mapped differently. For example, it will likely be mapped to some
|
| +/// exceptions
|
| +/// in Java, but more likely mapped to some error codes in C.
|
| +///
|
| +/// # Other uses
|
| +///
|
| +/// The error model and the `Status` message can be used in a variety of
|
| +/// environments, either with or without APIs, to provide a
|
| +/// consistent developer experience across different environments.
|
| +///
|
| +/// Example uses of this error model include:
|
| +///
|
| +/// - Partial errors. If a service needs to return partial errors to the
|
| +/// client,
|
| +/// it may embed the `Status` in the normal response to indicate the partial
|
| +/// errors.
|
| +///
|
| +/// - Workflow errors. A typical workflow has multiple steps. Each step may
|
| +/// have a `Status` message for error reporting.
|
| +///
|
| +/// - Batch operations. If a client uses batch request and batch response, the
|
| +/// `Status` message should be used directly inside batch response, one for
|
| +/// each error sub-response.
|
| +///
|
| +/// - Asynchronous operations. If an API call embeds asynchronous operation
|
| +/// results in its response, the status of those operations should be
|
| +/// represented directly using the `Status` message.
|
| +///
|
| +/// - Logging. If some API errors are stored in logs, the message `Status`
|
| +/// could
|
| +/// be used directly after any stripping needed for security/privacy reasons.
|
| class Status {
|
| - /** The status code, which should be an enum value of google.rpc.Code. */
|
| + /// 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.
|
| - */
|
| +
|
| + /// 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.
|
| - */
|
| +
|
| + /// 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();
|
| @@ -5059,7 +4313,8 @@ class Status {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (code != null) {
|
| _json["code"] = code;
|
| }
|
| @@ -5073,28 +4328,28 @@ class Status {
|
| }
|
| }
|
|
|
| -/** `StructType` defines the fields of a STRUCT type. */
|
| +/// `StructType` defines the fields of a STRUCT type.
|
| class StructType {
|
| - /**
|
| - * The list of fields that make up this struct. Order is
|
| - * significant, because values of this struct type are represented as
|
| - * lists, where the order of field values matches the order of
|
| - * fields in the StructType. In turn, the order of fields
|
| - * matches the order of columns in a read request, or the order of
|
| - * fields in the `SELECT` clause of a query.
|
| - */
|
| + /// The list of fields that make up this struct. Order is
|
| + /// significant, because values of this struct type are represented as
|
| + /// lists, where the order of field values matches the order of
|
| + /// fields in the StructType. In turn, the order of fields
|
| + /// matches the order of columns in a read request, or the order of
|
| + /// fields in the `SELECT` clause of a query.
|
| core.List<Field> fields;
|
|
|
| StructType();
|
|
|
| StructType.fromJson(core.Map _json) {
|
| if (_json.containsKey("fields")) {
|
| - fields = _json["fields"].map((value) => new Field.fromJson(value)).toList();
|
| + fields =
|
| + _json["fields"].map((value) => new Field.fromJson(value)).toList();
|
| }
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fields != null) {
|
| _json["fields"] = fields.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -5102,13 +4357,11 @@ class StructType {
|
| }
|
| }
|
|
|
| -/** Request message for `TestIamPermissions` method. */
|
| +/// Request message for `TestIamPermissions` method.
|
| class TestIamPermissionsRequest {
|
| - /**
|
| - * REQUIRED: The set of permissions to check for 'resource'.
|
| - * Permissions with wildcards (such as '*', 'spanner.*',
|
| - * 'spanner.instances.*') are not allowed.
|
| - */
|
| + /// REQUIRED: The set of permissions to check for 'resource'.
|
| + /// Permissions with wildcards (such as '*', 'spanner.*',
|
| + /// 'spanner.instances.*') are not allowed.
|
| core.List<core.String> permissions;
|
|
|
| TestIamPermissionsRequest();
|
| @@ -5120,7 +4373,8 @@ class TestIamPermissionsRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (permissions != null) {
|
| _json["permissions"] = permissions;
|
| }
|
| @@ -5128,12 +4382,10 @@ class TestIamPermissionsRequest {
|
| }
|
| }
|
|
|
| -/** Response message for `TestIamPermissions` method. */
|
| +/// Response message for `TestIamPermissions` method.
|
| class TestIamPermissionsResponse {
|
| - /**
|
| - * A subset of `TestPermissionsRequest.permissions` that the caller is
|
| - * allowed.
|
| - */
|
| + /// A subset of `TestPermissionsRequest.permissions` that the caller is
|
| + /// allowed.
|
| core.List<core.String> permissions;
|
|
|
| TestIamPermissionsResponse();
|
| @@ -5145,7 +4397,8 @@ class TestIamPermissionsResponse {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (permissions != null) {
|
| _json["permissions"] = permissions;
|
| }
|
| @@ -5153,31 +4406,29 @@ class TestIamPermissionsResponse {
|
| }
|
| }
|
|
|
| -/** A transaction. */
|
| +/// A transaction.
|
| class Transaction {
|
| - /**
|
| - * `id` may be used to identify the transaction in subsequent
|
| - * Read,
|
| - * ExecuteSql,
|
| - * Commit, or
|
| - * Rollback calls.
|
| - *
|
| - * Single-use read-only transactions do not have IDs, because
|
| - * single-use transactions do not support multiple requests.
|
| - */
|
| + /// `id` may be used to identify the transaction in subsequent
|
| + /// Read,
|
| + /// ExecuteSql,
|
| + /// Commit, or
|
| + /// Rollback calls.
|
| + ///
|
| + /// Single-use read-only transactions do not have IDs, because
|
| + /// single-use transactions do not support multiple requests.
|
| core.String id;
|
| core.List<core.int> get idAsBytes {
|
| return convert.BASE64.decode(id);
|
| }
|
|
|
| void set idAsBytes(core.List<core.int> _bytes) {
|
| - id = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + id =
|
| + convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| }
|
| - /**
|
| - * For snapshot read-only transactions, the read timestamp chosen
|
| - * for the transaction. Not returned by default: see
|
| - * TransactionOptions.ReadOnly.return_read_timestamp.
|
| - */
|
| +
|
| + /// For snapshot read-only transactions, the read timestamp chosen
|
| + /// for the transaction. Not returned by default: see
|
| + /// TransactionOptions.ReadOnly.return_read_timestamp.
|
| core.String readTimestamp;
|
|
|
| Transaction();
|
| @@ -5192,7 +4443,8 @@ class Transaction {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (id != null) {
|
| _json["id"] = id;
|
| }
|
| @@ -5203,241 +4455,236 @@ class Transaction {
|
| }
|
| }
|
|
|
| -/**
|
| - * # Transactions
|
| - *
|
| - *
|
| - * Each session can have at most one active transaction at a time. After the
|
| - * active transaction is completed, the session can immediately be
|
| - * re-used for the next transaction. It is not necessary to create a
|
| - * new session for each transaction.
|
| - *
|
| - * # Transaction Modes
|
| - *
|
| - * Cloud Spanner supports two transaction modes:
|
| - *
|
| - * 1. Locking read-write. This type of transaction is the only way
|
| - * to write data into Cloud Spanner. These transactions rely on
|
| - * pessimistic locking and, if necessary, two-phase commit.
|
| - * Locking read-write transactions may abort, requiring the
|
| - * application to retry.
|
| - *
|
| - * 2. Snapshot read-only. This transaction type provides guaranteed
|
| - * consistency across several reads, but does not allow
|
| - * writes. Snapshot read-only transactions can be configured to
|
| - * read at timestamps in the past. Snapshot read-only
|
| - * transactions do not need to be committed.
|
| - *
|
| - * For transactions that only read, snapshot read-only transactions
|
| - * provide simpler semantics and are almost always faster. In
|
| - * particular, read-only transactions do not take locks, so they do
|
| - * not conflict with read-write transactions. As a consequence of not
|
| - * taking locks, they also do not abort, so retry loops are not needed.
|
| - *
|
| - * Transactions may only read/write data in a single database. They
|
| - * may, however, read/write data in different tables within that
|
| - * database.
|
| - *
|
| - * ## Locking Read-Write Transactions
|
| - *
|
| - * Locking transactions may be used to atomically read-modify-write
|
| - * data anywhere in a database. This type of transaction is externally
|
| - * consistent.
|
| - *
|
| - * Clients should attempt to minimize the amount of time a transaction
|
| - * is active. Faster transactions commit with higher probability
|
| - * and cause less contention. Cloud Spanner attempts to keep read locks
|
| - * active as long as the transaction continues to do reads, and the
|
| - * transaction has not been terminated by
|
| - * Commit or
|
| - * Rollback. Long periods of
|
| - * inactivity at the client may cause Cloud Spanner to release a
|
| - * transaction's locks and abort it.
|
| - *
|
| - * Reads performed within a transaction acquire locks on the data
|
| - * being read. Writes can only be done at commit time, after all reads
|
| - * have been completed.
|
| - * Conceptually, a read-write transaction consists of zero or more
|
| - * reads or SQL queries followed by
|
| - * Commit. At any time before
|
| - * Commit, the client can send a
|
| - * Rollback request to abort the
|
| - * transaction.
|
| - *
|
| - * ### Semantics
|
| - *
|
| - * Cloud Spanner can commit the transaction if all read locks it acquired
|
| - * are still valid at commit time, and it is able to acquire write
|
| - * locks for all writes. Cloud Spanner can abort the transaction for any
|
| - * reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees
|
| - * that the transaction has not modified any user data in Cloud Spanner.
|
| - *
|
| - * Unless the transaction commits, Cloud Spanner makes no guarantees about
|
| - * how long the transaction's locks were held for. It is an error to
|
| - * use Cloud Spanner locks for any sort of mutual exclusion other than
|
| - * between Cloud Spanner transactions themselves.
|
| - *
|
| - * ### Retrying Aborted Transactions
|
| - *
|
| - * When a transaction aborts, the application can choose to retry the
|
| - * whole transaction again. To maximize the chances of successfully
|
| - * committing the retry, the client should execute the retry in the
|
| - * same session as the original attempt. The original session's lock
|
| - * priority increases with each consecutive abort, meaning that each
|
| - * attempt has a slightly better chance of success than the previous.
|
| - *
|
| - * Under some circumstances (e.g., many transactions attempting to
|
| - * modify the same row(s)), a transaction can abort many times in a
|
| - * short period before successfully committing. Thus, it is not a good
|
| - * idea to cap the number of retries a transaction can attempt;
|
| - * instead, it is better to limit the total amount of wall time spent
|
| - * retrying.
|
| - *
|
| - * ### Idle Transactions
|
| - *
|
| - * A transaction is considered idle if it has no outstanding reads or
|
| - * SQL queries and has not started a read or SQL query within the last 10
|
| - * seconds. Idle transactions can be aborted by Cloud Spanner so that they
|
| - * don't hold on to locks indefinitely. In that case, the commit will
|
| - * fail with error `ABORTED`.
|
| - *
|
| - * If this behavior is undesirable, periodically executing a simple
|
| - * SQL query in the transaction (e.g., `SELECT 1`) prevents the
|
| - * transaction from becoming idle.
|
| - *
|
| - * ## Snapshot Read-Only Transactions
|
| - *
|
| - * Snapshot read-only transactions provides a simpler method than
|
| - * locking read-write transactions for doing several consistent
|
| - * reads. However, this type of transaction does not support writes.
|
| - *
|
| - * Snapshot transactions do not take locks. Instead, they work by
|
| - * choosing a Cloud Spanner timestamp, then executing all reads at that
|
| - * timestamp. Since they do not acquire locks, they do not block
|
| - * concurrent read-write transactions.
|
| - *
|
| - * Unlike locking read-write transactions, snapshot read-only
|
| - * transactions never abort. They can fail if the chosen read
|
| - * timestamp is garbage collected; however, the default garbage
|
| - * collection policy is generous enough that most applications do not
|
| - * need to worry about this in practice.
|
| - *
|
| - * Snapshot read-only transactions do not need to call
|
| - * Commit or
|
| - * Rollback (and in fact are not
|
| - * permitted to do so).
|
| - *
|
| - * To execute a snapshot transaction, the client specifies a timestamp
|
| - * bound, which tells Cloud Spanner how to choose a read timestamp.
|
| - *
|
| - * The types of timestamp bound are:
|
| - *
|
| - * - Strong (the default).
|
| - * - Bounded staleness.
|
| - * - Exact staleness.
|
| - *
|
| - * If the Cloud Spanner database to be read is geographically distributed,
|
| - * stale read-only transactions can execute more quickly than strong
|
| - * or read-write transaction, because they are able to execute far
|
| - * from the leader replica.
|
| - *
|
| - * Each type of timestamp bound is discussed in detail below.
|
| - *
|
| - * ### Strong
|
| - *
|
| - * Strong reads are guaranteed to see the effects of all transactions
|
| - * that have committed before the start of the read. Furthermore, all
|
| - * rows yielded by a single read are consistent with each other -- if
|
| - * any part of the read observes a transaction, all parts of the read
|
| - * see the transaction.
|
| - *
|
| - * Strong reads are not repeatable: two consecutive strong read-only
|
| - * transactions might return inconsistent results if there are
|
| - * concurrent writes. If consistency across reads is required, the
|
| - * reads should be executed within a transaction or at an exact read
|
| - * timestamp.
|
| - *
|
| - * See TransactionOptions.ReadOnly.strong.
|
| - *
|
| - * ### Exact Staleness
|
| - *
|
| - * These timestamp bounds execute reads at a user-specified
|
| - * timestamp. Reads at a timestamp are guaranteed to see a consistent
|
| - * prefix of the global transaction history: they observe
|
| - * modifications done by all transactions with a commit timestamp <=
|
| - * the read timestamp, and observe none of the modifications done by
|
| - * transactions with a larger commit timestamp. They will block until
|
| - * all conflicting transactions that may be assigned commit timestamps
|
| - * <= the read timestamp have finished.
|
| - *
|
| - * The timestamp can either be expressed as an absolute Cloud Spanner commit
|
| - * timestamp or a staleness relative to the current time.
|
| - *
|
| - * These modes do not require a "negotiation phase" to pick a
|
| - * timestamp. As a result, they execute slightly faster than the
|
| - * equivalent boundedly stale concurrency modes. On the other hand,
|
| - * boundedly stale reads usually return fresher results.
|
| - *
|
| - * See TransactionOptions.ReadOnly.read_timestamp and
|
| - * TransactionOptions.ReadOnly.exact_staleness.
|
| - *
|
| - * ### Bounded Staleness
|
| - *
|
| - * Bounded staleness modes allow Cloud Spanner to pick the read timestamp,
|
| - * subject to a user-provided staleness bound. Cloud Spanner chooses the
|
| - * newest timestamp within the staleness bound that allows execution
|
| - * of the reads at the closest available replica without blocking.
|
| - *
|
| - * All rows yielded are consistent with each other -- if any part of
|
| - * the read observes a transaction, all parts of the read see the
|
| - * transaction. Boundedly stale reads are not repeatable: two stale
|
| - * reads, even if they use the same staleness bound, can execute at
|
| - * different timestamps and thus return inconsistent results.
|
| - *
|
| - * Boundedly stale reads execute in two phases: the first phase
|
| - * negotiates a timestamp among all replicas needed to serve the
|
| - * read. In the second phase, reads are executed at the negotiated
|
| - * timestamp.
|
| - *
|
| - * As a result of the two phase execution, bounded staleness reads are
|
| - * usually a little slower than comparable exact staleness
|
| - * reads. However, they are typically able to return fresher
|
| - * results, and are more likely to execute at the closest replica.
|
| - *
|
| - * Because the timestamp negotiation requires up-front knowledge of
|
| - * which rows will be read, it can only be used with single-use
|
| - * read-only transactions.
|
| - *
|
| - * See TransactionOptions.ReadOnly.max_staleness and
|
| - * TransactionOptions.ReadOnly.min_read_timestamp.
|
| - *
|
| - * ### Old Read Timestamps and Garbage Collection
|
| - *
|
| - * Cloud Spanner continuously garbage collects deleted and overwritten data
|
| - * in the background to reclaim storage space. This process is known
|
| - * as "version GC". By default, version GC reclaims versions after they
|
| - * are one hour old. Because of this, Cloud Spanner cannot perform reads
|
| - * at read timestamps more than one hour in the past. This
|
| - * restriction also applies to in-progress reads and/or SQL queries whose
|
| - * timestamp become too old while executing. Reads and SQL queries with
|
| - * too-old read timestamps fail with the error `FAILED_PRECONDITION`.
|
| - */
|
| +/// # Transactions
|
| +///
|
| +///
|
| +/// Each session can have at most one active transaction at a time. After the
|
| +/// active transaction is completed, the session can immediately be
|
| +/// re-used for the next transaction. It is not necessary to create a
|
| +/// new session for each transaction.
|
| +///
|
| +/// # Transaction Modes
|
| +///
|
| +/// Cloud Spanner supports two transaction modes:
|
| +///
|
| +/// 1. Locking read-write. This type of transaction is the only way
|
| +/// to write data into Cloud Spanner. These transactions rely on
|
| +/// pessimistic locking and, if necessary, two-phase commit.
|
| +/// Locking read-write transactions may abort, requiring the
|
| +/// application to retry.
|
| +///
|
| +/// 2. Snapshot read-only. This transaction type provides guaranteed
|
| +/// consistency across several reads, but does not allow
|
| +/// writes. Snapshot read-only transactions can be configured to
|
| +/// read at timestamps in the past. Snapshot read-only
|
| +/// transactions do not need to be committed.
|
| +///
|
| +/// For transactions that only read, snapshot read-only transactions
|
| +/// provide simpler semantics and are almost always faster. In
|
| +/// particular, read-only transactions do not take locks, so they do
|
| +/// not conflict with read-write transactions. As a consequence of not
|
| +/// taking locks, they also do not abort, so retry loops are not needed.
|
| +///
|
| +/// Transactions may only read/write data in a single database. They
|
| +/// may, however, read/write data in different tables within that
|
| +/// database.
|
| +///
|
| +/// ## Locking Read-Write Transactions
|
| +///
|
| +/// Locking transactions may be used to atomically read-modify-write
|
| +/// data anywhere in a database. This type of transaction is externally
|
| +/// consistent.
|
| +///
|
| +/// Clients should attempt to minimize the amount of time a transaction
|
| +/// is active. Faster transactions commit with higher probability
|
| +/// and cause less contention. Cloud Spanner attempts to keep read locks
|
| +/// active as long as the transaction continues to do reads, and the
|
| +/// transaction has not been terminated by
|
| +/// Commit or
|
| +/// Rollback. Long periods of
|
| +/// inactivity at the client may cause Cloud Spanner to release a
|
| +/// transaction's locks and abort it.
|
| +///
|
| +/// Reads performed within a transaction acquire locks on the data
|
| +/// being read. Writes can only be done at commit time, after all reads
|
| +/// have been completed.
|
| +/// Conceptually, a read-write transaction consists of zero or more
|
| +/// reads or SQL queries followed by
|
| +/// Commit. At any time before
|
| +/// Commit, the client can send a
|
| +/// Rollback request to abort the
|
| +/// transaction.
|
| +///
|
| +/// ### Semantics
|
| +///
|
| +/// Cloud Spanner can commit the transaction if all read locks it acquired
|
| +/// are still valid at commit time, and it is able to acquire write
|
| +/// locks for all writes. Cloud Spanner can abort the transaction for any
|
| +/// reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees
|
| +/// that the transaction has not modified any user data in Cloud Spanner.
|
| +///
|
| +/// Unless the transaction commits, Cloud Spanner makes no guarantees about
|
| +/// how long the transaction's locks were held for. It is an error to
|
| +/// use Cloud Spanner locks for any sort of mutual exclusion other than
|
| +/// between Cloud Spanner transactions themselves.
|
| +///
|
| +/// ### Retrying Aborted Transactions
|
| +///
|
| +/// When a transaction aborts, the application can choose to retry the
|
| +/// whole transaction again. To maximize the chances of successfully
|
| +/// committing the retry, the client should execute the retry in the
|
| +/// same session as the original attempt. The original session's lock
|
| +/// priority increases with each consecutive abort, meaning that each
|
| +/// attempt has a slightly better chance of success than the previous.
|
| +///
|
| +/// Under some circumstances (e.g., many transactions attempting to
|
| +/// modify the same row(s)), a transaction can abort many times in a
|
| +/// short period before successfully committing. Thus, it is not a good
|
| +/// idea to cap the number of retries a transaction can attempt;
|
| +/// instead, it is better to limit the total amount of wall time spent
|
| +/// retrying.
|
| +///
|
| +/// ### Idle Transactions
|
| +///
|
| +/// A transaction is considered idle if it has no outstanding reads or
|
| +/// SQL queries and has not started a read or SQL query within the last 10
|
| +/// seconds. Idle transactions can be aborted by Cloud Spanner so that they
|
| +/// don't hold on to locks indefinitely. In that case, the commit will
|
| +/// fail with error `ABORTED`.
|
| +///
|
| +/// If this behavior is undesirable, periodically executing a simple
|
| +/// SQL query in the transaction (e.g., `SELECT 1`) prevents the
|
| +/// transaction from becoming idle.
|
| +///
|
| +/// ## Snapshot Read-Only Transactions
|
| +///
|
| +/// Snapshot read-only transactions provides a simpler method than
|
| +/// locking read-write transactions for doing several consistent
|
| +/// reads. However, this type of transaction does not support writes.
|
| +///
|
| +/// Snapshot transactions do not take locks. Instead, they work by
|
| +/// choosing a Cloud Spanner timestamp, then executing all reads at that
|
| +/// timestamp. Since they do not acquire locks, they do not block
|
| +/// concurrent read-write transactions.
|
| +///
|
| +/// Unlike locking read-write transactions, snapshot read-only
|
| +/// transactions never abort. They can fail if the chosen read
|
| +/// timestamp is garbage collected; however, the default garbage
|
| +/// collection policy is generous enough that most applications do not
|
| +/// need to worry about this in practice.
|
| +///
|
| +/// Snapshot read-only transactions do not need to call
|
| +/// Commit or
|
| +/// Rollback (and in fact are not
|
| +/// permitted to do so).
|
| +///
|
| +/// To execute a snapshot transaction, the client specifies a timestamp
|
| +/// bound, which tells Cloud Spanner how to choose a read timestamp.
|
| +///
|
| +/// The types of timestamp bound are:
|
| +///
|
| +/// - Strong (the default).
|
| +/// - Bounded staleness.
|
| +/// - Exact staleness.
|
| +///
|
| +/// If the Cloud Spanner database to be read is geographically distributed,
|
| +/// stale read-only transactions can execute more quickly than strong
|
| +/// or read-write transaction, because they are able to execute far
|
| +/// from the leader replica.
|
| +///
|
| +/// Each type of timestamp bound is discussed in detail below.
|
| +///
|
| +/// ### Strong
|
| +///
|
| +/// Strong reads are guaranteed to see the effects of all transactions
|
| +/// that have committed before the start of the read. Furthermore, all
|
| +/// rows yielded by a single read are consistent with each other -- if
|
| +/// any part of the read observes a transaction, all parts of the read
|
| +/// see the transaction.
|
| +///
|
| +/// Strong reads are not repeatable: two consecutive strong read-only
|
| +/// transactions might return inconsistent results if there are
|
| +/// concurrent writes. If consistency across reads is required, the
|
| +/// reads should be executed within a transaction or at an exact read
|
| +/// timestamp.
|
| +///
|
| +/// See TransactionOptions.ReadOnly.strong.
|
| +///
|
| +/// ### Exact Staleness
|
| +///
|
| +/// These timestamp bounds execute reads at a user-specified
|
| +/// timestamp. Reads at a timestamp are guaranteed to see a consistent
|
| +/// prefix of the global transaction history: they observe
|
| +/// modifications done by all transactions with a commit timestamp <=
|
| +/// the read timestamp, and observe none of the modifications done by
|
| +/// transactions with a larger commit timestamp. They will block until
|
| +/// all conflicting transactions that may be assigned commit timestamps
|
| +/// <= the read timestamp have finished.
|
| +///
|
| +/// The timestamp can either be expressed as an absolute Cloud Spanner commit
|
| +/// timestamp or a staleness relative to the current time.
|
| +///
|
| +/// These modes do not require a "negotiation phase" to pick a
|
| +/// timestamp. As a result, they execute slightly faster than the
|
| +/// equivalent boundedly stale concurrency modes. On the other hand,
|
| +/// boundedly stale reads usually return fresher results.
|
| +///
|
| +/// See TransactionOptions.ReadOnly.read_timestamp and
|
| +/// TransactionOptions.ReadOnly.exact_staleness.
|
| +///
|
| +/// ### Bounded Staleness
|
| +///
|
| +/// Bounded staleness modes allow Cloud Spanner to pick the read timestamp,
|
| +/// subject to a user-provided staleness bound. Cloud Spanner chooses the
|
| +/// newest timestamp within the staleness bound that allows execution
|
| +/// of the reads at the closest available replica without blocking.
|
| +///
|
| +/// All rows yielded are consistent with each other -- if any part of
|
| +/// the read observes a transaction, all parts of the read see the
|
| +/// transaction. Boundedly stale reads are not repeatable: two stale
|
| +/// reads, even if they use the same staleness bound, can execute at
|
| +/// different timestamps and thus return inconsistent results.
|
| +///
|
| +/// Boundedly stale reads execute in two phases: the first phase
|
| +/// negotiates a timestamp among all replicas needed to serve the
|
| +/// read. In the second phase, reads are executed at the negotiated
|
| +/// timestamp.
|
| +///
|
| +/// As a result of the two phase execution, bounded staleness reads are
|
| +/// usually a little slower than comparable exact staleness
|
| +/// reads. However, they are typically able to return fresher
|
| +/// results, and are more likely to execute at the closest replica.
|
| +///
|
| +/// Because the timestamp negotiation requires up-front knowledge of
|
| +/// which rows will be read, it can only be used with single-use
|
| +/// read-only transactions.
|
| +///
|
| +/// See TransactionOptions.ReadOnly.max_staleness and
|
| +/// TransactionOptions.ReadOnly.min_read_timestamp.
|
| +///
|
| +/// ### Old Read Timestamps and Garbage Collection
|
| +///
|
| +/// Cloud Spanner continuously garbage collects deleted and overwritten data
|
| +/// in the background to reclaim storage space. This process is known
|
| +/// as "version GC". By default, version GC reclaims versions after they
|
| +/// are one hour old. Because of this, Cloud Spanner cannot perform reads
|
| +/// at read timestamps more than one hour in the past. This
|
| +/// restriction also applies to in-progress reads and/or SQL queries whose
|
| +/// timestamp become too old while executing. Reads and SQL queries with
|
| +/// too-old read timestamps fail with the error `FAILED_PRECONDITION`.
|
| class TransactionOptions {
|
| - /**
|
| - * Transaction will not write.
|
| - *
|
| - * Authorization to begin a read-only transaction requires
|
| - * `spanner.databases.beginReadOnlyTransaction` permission
|
| - * on the `session` resource.
|
| - */
|
| + /// Transaction will not write.
|
| + ///
|
| + /// Authorization to begin a read-only transaction requires
|
| + /// `spanner.databases.beginReadOnlyTransaction` permission
|
| + /// on the `session` resource.
|
| ReadOnly readOnly;
|
| - /**
|
| - * Transaction may write.
|
| - *
|
| - * Authorization to begin a read-write transaction requires
|
| - * `spanner.databases.beginOrRollbackReadWriteTransaction` permission
|
| - * on the `session` resource.
|
| - */
|
| +
|
| + /// Transaction may write.
|
| + ///
|
| + /// Authorization to begin a read-write transaction requires
|
| + /// `spanner.databases.beginOrRollbackReadWriteTransaction` permission
|
| + /// on the `session` resource.
|
| ReadWrite readWrite;
|
|
|
| TransactionOptions();
|
| @@ -5452,7 +4699,8 @@ class TransactionOptions {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (readOnly != null) {
|
| _json["readOnly"] = (readOnly).toJson();
|
| }
|
| @@ -5463,34 +4711,31 @@ class TransactionOptions {
|
| }
|
| }
|
|
|
| -/**
|
| - * This message is used to select the transaction in which a
|
| - * Read or
|
| - * ExecuteSql call runs.
|
| - *
|
| - * See TransactionOptions for more information about transactions.
|
| - */
|
| +/// This message is used to select the transaction in which a
|
| +/// Read or
|
| +/// ExecuteSql call runs.
|
| +///
|
| +/// See TransactionOptions for more information about transactions.
|
| class TransactionSelector {
|
| - /**
|
| - * Begin a new transaction and execute this read or SQL query in
|
| - * it. The transaction ID of the new transaction is returned in
|
| - * ResultSetMetadata.transaction, which is a Transaction.
|
| - */
|
| + /// Begin a new transaction and execute this read or SQL query in
|
| + /// it. The transaction ID of the new transaction is returned in
|
| + /// ResultSetMetadata.transaction, which is a Transaction.
|
| TransactionOptions begin;
|
| - /** Execute the read or SQL query in a previously-started transaction. */
|
| +
|
| + /// Execute the read or SQL query in a previously-started transaction.
|
| core.String id;
|
| core.List<core.int> get idAsBytes {
|
| return convert.BASE64.decode(id);
|
| }
|
|
|
| void set idAsBytes(core.List<core.int> _bytes) {
|
| - id = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| + id =
|
| + convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
|
| }
|
| - /**
|
| - * Execute the read or SQL query in a temporary transaction.
|
| - * This is the most efficient way to execute a transaction that
|
| - * consists of a single SQL query.
|
| - */
|
| +
|
| + /// Execute the read or SQL query in a temporary transaction.
|
| + /// This is the most efficient way to execute a transaction that
|
| + /// consists of a single SQL query.
|
| TransactionOptions singleUse;
|
|
|
| TransactionSelector();
|
| @@ -5508,7 +4753,8 @@ class TransactionSelector {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (begin != null) {
|
| _json["begin"] = (begin).toJson();
|
| }
|
| @@ -5522,42 +4768,38 @@ class TransactionSelector {
|
| }
|
| }
|
|
|
| -/**
|
| - * `Type` indicates the type of a Cloud Spanner value, as might be stored in a
|
| - * table cell or returned from an SQL query.
|
| - */
|
| +/// `Type` indicates the type of a Cloud Spanner value, as might be stored in a
|
| +/// table cell or returned from an SQL query.
|
| class Type {
|
| - /**
|
| - * If code == ARRAY, then `array_element_type`
|
| - * is the type of the array elements.
|
| - */
|
| + /// If code == ARRAY, then `array_element_type`
|
| + /// is the type of the array elements.
|
| Type arrayElementType;
|
| - /**
|
| - * Required. The TypeCode for this type.
|
| - * Possible string values are:
|
| - * - "TYPE_CODE_UNSPECIFIED" : Not specified.
|
| - * - "BOOL" : Encoded as JSON `true` or `false`.
|
| - * - "INT64" : Encoded as `string`, in decimal format.
|
| - * - "FLOAT64" : Encoded as `number`, or the strings `"NaN"`, `"Infinity"`, or
|
| - * `"-Infinity"`.
|
| - * - "TIMESTAMP" : Encoded as `string` in RFC 3339 timestamp format. The time
|
| - * zone
|
| - * must be present, and must be `"Z"`.
|
| - * - "DATE" : Encoded as `string` in RFC 3339 date format.
|
| - * - "STRING" : Encoded as `string`.
|
| - * - "BYTES" : Encoded as a base64-encoded `string`, as described in RFC 4648,
|
| - * section 4.
|
| - * - "ARRAY" : Encoded as `list`, where the list elements are represented
|
| - * according to array_element_type.
|
| - * - "STRUCT" : Encoded as `list`, where list element `i` is represented
|
| - * according
|
| - * to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
|
| - */
|
| +
|
| + /// Required. The TypeCode for this type.
|
| + /// Possible string values are:
|
| + /// - "TYPE_CODE_UNSPECIFIED" : Not specified.
|
| + /// - "BOOL" : Encoded as JSON `true` or `false`.
|
| + /// - "INT64" : Encoded as `string`, in decimal format.
|
| + /// - "FLOAT64" : Encoded as `number`, or the strings `"NaN"`, `"Infinity"`,
|
| + /// or
|
| + /// `"-Infinity"`.
|
| + /// - "TIMESTAMP" : Encoded as `string` in RFC 3339 timestamp format. The
|
| + /// time zone
|
| + /// must be present, and must be `"Z"`.
|
| + /// - "DATE" : Encoded as `string` in RFC 3339 date format.
|
| + /// - "STRING" : Encoded as `string`.
|
| + /// - "BYTES" : Encoded as a base64-encoded `string`, as described in RFC
|
| + /// 4648,
|
| + /// section 4.
|
| + /// - "ARRAY" : Encoded as `list`, where the list elements are represented
|
| + /// according to array_element_type.
|
| + /// - "STRUCT" : Encoded as `list`, where list element `i` is represented
|
| + /// according
|
| + /// to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
|
| core.String code;
|
| - /**
|
| - * If code == STRUCT, then `struct_type`
|
| - * provides type information for the struct's fields.
|
| - */
|
| +
|
| + /// If code == STRUCT, then `struct_type`
|
| + /// provides type information for the struct's fields.
|
| StructType structType;
|
|
|
| Type();
|
| @@ -5575,7 +4817,8 @@ class Type {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (arrayElementType != null) {
|
| _json["arrayElementType"] = (arrayElementType).toJson();
|
| }
|
| @@ -5589,23 +4832,19 @@ class Type {
|
| }
|
| }
|
|
|
| -/**
|
| - * Metadata type for the operation returned by
|
| - * UpdateDatabaseDdl.
|
| - */
|
| +/// Metadata type for the operation returned by
|
| +/// UpdateDatabaseDdl.
|
| class UpdateDatabaseDdlMetadata {
|
| - /**
|
| - * Reports the commit timestamps of all statements that have
|
| - * succeeded so far, where `commit_timestamps[i]` is the commit
|
| - * timestamp for the statement `statements[i]`.
|
| - */
|
| + /// Reports the commit timestamps of all statements that have
|
| + /// succeeded so far, where `commit_timestamps[i]` is the commit
|
| + /// timestamp for the statement `statements[i]`.
|
| core.List<core.String> commitTimestamps;
|
| - /** The database being modified. */
|
| +
|
| + /// The database being modified.
|
| core.String database;
|
| - /**
|
| - * For an update this list contains all the statements. For an
|
| - * individual statement, this list contains only that statement.
|
| - */
|
| +
|
| + /// For an update this list contains all the statements. For an
|
| + /// individual statement, this list contains only that statement.
|
| core.List<core.String> statements;
|
|
|
| UpdateDatabaseDdlMetadata();
|
| @@ -5623,7 +4862,8 @@ class UpdateDatabaseDdlMetadata {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (commitTimestamps != null) {
|
| _json["commitTimestamps"] = commitTimestamps;
|
| }
|
| @@ -5637,48 +4877,45 @@ class UpdateDatabaseDdlMetadata {
|
| }
|
| }
|
|
|
| -/**
|
| - * Enqueues the given DDL statements to be applied, in order but not
|
| - * necessarily all at once, to the database schema at some point (or
|
| - * points) in the future. The server checks that the statements
|
| - * are executable (syntactically valid, name tables that exist, etc.)
|
| - * before enqueueing them, but they may still fail upon
|
| - * later execution (e.g., if a statement from another batch of
|
| - * statements is applied first and it conflicts in some way, or if
|
| - * there is some data-related problem like a `NULL` value in a column to
|
| - * which `NOT NULL` would be added). If a statement fails, all
|
| - * subsequent statements in the batch are automatically cancelled.
|
| - *
|
| - * Each batch of statements is assigned a name which can be used with
|
| - * the Operations API to monitor
|
| - * progress. See the
|
| - * operation_id field for more
|
| - * details.
|
| - */
|
| +/// Enqueues the given DDL statements to be applied, in order but not
|
| +/// necessarily all at once, to the database schema at some point (or
|
| +/// points) in the future. The server checks that the statements
|
| +/// are executable (syntactically valid, name tables that exist, etc.)
|
| +/// before enqueueing them, but they may still fail upon
|
| +/// later execution (e.g., if a statement from another batch of
|
| +/// statements is applied first and it conflicts in some way, or if
|
| +/// there is some data-related problem like a `NULL` value in a column to
|
| +/// which `NOT NULL` would be added). If a statement fails, all
|
| +/// subsequent statements in the batch are automatically cancelled.
|
| +///
|
| +/// Each batch of statements is assigned a name which can be used with
|
| +/// the Operations API to monitor
|
| +/// progress. See the
|
| +/// operation_id field for more
|
| +/// details.
|
| class UpdateDatabaseDdlRequest {
|
| - /**
|
| - * If empty, the new update request is assigned an
|
| - * automatically-generated operation ID. Otherwise, `operation_id`
|
| - * is used to construct the name of the resulting
|
| - * Operation.
|
| - *
|
| - * Specifying an explicit operation ID simplifies determining
|
| - * whether the statements were executed in the event that the
|
| - * UpdateDatabaseDdl call is replayed,
|
| - * or the return value is otherwise lost: the database and
|
| - * `operation_id` fields can be combined to form the
|
| - * name of the resulting
|
| - * longrunning.Operation: `<database>/operations/<operation_id>`.
|
| - *
|
| - * `operation_id` should be unique within the database, and must be
|
| - * a valid identifier: `a-z*`. Note that
|
| - * automatically-generated operation IDs always begin with an
|
| - * underscore. If the named operation already exists,
|
| - * UpdateDatabaseDdl returns
|
| - * `ALREADY_EXISTS`.
|
| - */
|
| + /// If empty, the new update request is assigned an
|
| + /// automatically-generated operation ID. Otherwise, `operation_id`
|
| + /// is used to construct the name of the resulting
|
| + /// Operation.
|
| + ///
|
| + /// Specifying an explicit operation ID simplifies determining
|
| + /// whether the statements were executed in the event that the
|
| + /// UpdateDatabaseDdl call is replayed,
|
| + /// or the return value is otherwise lost: the database and
|
| + /// `operation_id` fields can be combined to form the
|
| + /// name of the resulting
|
| + /// longrunning.Operation: `<database>/operations/<operation_id>`.
|
| + ///
|
| + /// `operation_id` should be unique within the database, and must be
|
| + /// a valid identifier: `a-z*`. Note that
|
| + /// automatically-generated operation IDs always begin with an
|
| + /// underscore. If the named operation already exists,
|
| + /// UpdateDatabaseDdl returns
|
| + /// `ALREADY_EXISTS`.
|
| core.String operationId;
|
| - /** DDL statements to be applied to the database. */
|
| +
|
| + /// DDL statements to be applied to the database.
|
| core.List<core.String> statements;
|
|
|
| UpdateDatabaseDdlRequest();
|
| @@ -5693,7 +4930,8 @@ class UpdateDatabaseDdlRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (operationId != null) {
|
| _json["operationId"] = operationId;
|
| }
|
| @@ -5704,25 +4942,22 @@ class UpdateDatabaseDdlRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Metadata type for the operation returned by
|
| - * UpdateInstance.
|
| - */
|
| +/// Metadata type for the operation returned by
|
| +/// UpdateInstance.
|
| class UpdateInstanceMetadata {
|
| - /**
|
| - * The time at which this operation was cancelled. If set, this operation is
|
| - * in the process of undoing itself (which is guaranteed to succeed) and
|
| - * cannot be cancelled again.
|
| - */
|
| + /// The time at which this operation was cancelled. If set, this operation is
|
| + /// in the process of undoing itself (which is guaranteed to succeed) and
|
| + /// cannot be cancelled again.
|
| core.String cancelTime;
|
| - /** The time at which this operation failed or was completed successfully. */
|
| +
|
| + /// The time at which this operation failed or was completed successfully.
|
| core.String endTime;
|
| - /** The desired end state of the update. */
|
| +
|
| + /// The desired end state of the update.
|
| Instance instance;
|
| - /**
|
| - * The time at which UpdateInstance
|
| - * request was received.
|
| - */
|
| +
|
| + /// The time at which UpdateInstance
|
| + /// request was received.
|
| core.String startTime;
|
|
|
| UpdateInstanceMetadata();
|
| @@ -5743,7 +4978,8 @@ class UpdateInstanceMetadata {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (cancelTime != null) {
|
| _json["cancelTime"] = cancelTime;
|
| }
|
| @@ -5760,24 +4996,22 @@ class UpdateInstanceMetadata {
|
| }
|
| }
|
|
|
| -/** The request for UpdateInstance. */
|
| +/// The request for UpdateInstance.
|
| class UpdateInstanceRequest {
|
| - /**
|
| - * Required. A mask specifying which fields in
|
| - * [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should
|
| - * be updated.
|
| - * The field mask must always be specified; this prevents any future fields in
|
| - * [][google.spanner.admin.instance.v1.Instance] from being erased
|
| - * accidentally by clients that do not know
|
| - * about them.
|
| - */
|
| + /// Required. A mask specifying which fields in
|
| + /// [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance]
|
| + /// should be updated.
|
| + /// The field mask must always be specified; this prevents any future fields
|
| + /// in
|
| + /// [][google.spanner.admin.instance.v1.Instance] from being erased
|
| + /// accidentally by clients that do not know
|
| + /// about them.
|
| core.String fieldMask;
|
| - /**
|
| - * Required. The instance to update, which must always include the instance
|
| - * name. Otherwise, only fields mentioned in
|
| - * [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need
|
| - * be included.
|
| - */
|
| +
|
| + /// Required. The instance to update, which must always include the instance
|
| + /// name. Otherwise, only fields mentioned in
|
| + /// [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask]
|
| + /// need be included.
|
| Instance instance;
|
|
|
| UpdateInstanceRequest();
|
| @@ -5792,7 +5026,8 @@ class UpdateInstanceRequest {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (fieldMask != null) {
|
| _json["fieldMask"] = fieldMask;
|
| }
|
| @@ -5803,34 +5038,30 @@ class UpdateInstanceRequest {
|
| }
|
| }
|
|
|
| -/**
|
| - * Arguments to insert, update, insert_or_update, and
|
| - * replace operations.
|
| - */
|
| +/// Arguments to insert, update, insert_or_update, and
|
| +/// replace operations.
|
| class Write {
|
| - /**
|
| - * The names of the columns in table to be written.
|
| - *
|
| - * The list of columns must contain enough columns to allow
|
| - * Cloud Spanner to derive values for all primary key columns in the
|
| - * row(s) to be modified.
|
| - */
|
| + /// The names of the columns in table to be written.
|
| + ///
|
| + /// The list of columns must contain enough columns to allow
|
| + /// Cloud Spanner to derive values for all primary key columns in the
|
| + /// row(s) to be modified.
|
| core.List<core.String> columns;
|
| - /** Required. The table whose rows will be written. */
|
| +
|
| + /// Required. The table whose rows will be written.
|
| core.String table;
|
| - /**
|
| - * The values to be written. `values` can contain more than one
|
| - * list of values. If it does, then multiple rows are written, one
|
| - * for each entry in `values`. Each list in `values` must have
|
| - * exactly as many entries as there are entries in columns
|
| - * above. Sending multiple lists is equivalent to sending multiple
|
| - * `Mutation`s, each containing one `values` entry and repeating
|
| - * table and columns. Individual values in each list are
|
| - * encoded as described here.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| +
|
| + /// The values to be written. `values` can contain more than one
|
| + /// list of values. If it does, then multiple rows are written, one
|
| + /// for each entry in `values`. Each list in `values` must have
|
| + /// exactly as many entries as there are entries in columns
|
| + /// above. Sending multiple lists is equivalent to sending multiple
|
| + /// `Mutation`s, each containing one `values` entry and repeating
|
| + /// table and columns. Individual values in each list are
|
| + /// encoded as described here.
|
| + ///
|
| + /// 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.List<core.Object>> values;
|
|
|
| Write();
|
| @@ -5848,7 +5079,8 @@ class Write {
|
| }
|
|
|
| core.Map<core.String, core.Object> toJson() {
|
| - final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
|
| + final core.Map<core.String, core.Object> _json =
|
| + new core.Map<core.String, core.Object>();
|
| if (columns != null) {
|
| _json["columns"] = columns;
|
| }
|
|
|
Chromium Code Reviews
Issue 3006323002:
Api-Roll 54: 2017-09-11 (Closed)
