| Index: generated/googleapis/lib/serviceuser/v1.dart
|
| diff --git a/generated/googleapis/lib/serviceuser/v1.dart b/generated/googleapis/lib/serviceuser/v1.dart
|
| index fc53b5c86eae43013c8b065fa5f0066a2fa95de9..61ccbb880ee8ea26f10f3a896886156cabb15cfd 100644
|
| --- a/generated/googleapis/lib/serviceuser/v1.dart
|
| +++ b/generated/googleapis/lib/serviceuser/v1.dart
|
| @@ -9,82 +9,84 @@ import 'dart:convert' as convert;
|
| import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
|
| import 'package:http/http.dart' as http_1;
|
|
|
| -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 serviceuser/v1';
|
|
|
| -/**
|
| - * Enables services that service consumers want to use on Google Cloud Platform,
|
| - * lists the available or enabled services, or disables services that service
|
| - * consumers no longer use.
|
| - */
|
| +/// Enables services that service consumers want to use on Google Cloud
|
| +/// Platform, lists the available or enabled services, or disables services
|
| +/// that service consumers no longer use.
|
| class ServiceuserApi {
|
| - /** 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";
|
|
|
| - /** View your data across Google Cloud Platform services */
|
| - static const CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only";
|
| -
|
| - /** Manage your Google API service configuration */
|
| - static const ServiceManagementScope = "https://www.googleapis.com/auth/service.management";
|
| + /// View your data across Google Cloud Platform services
|
| + static const CloudPlatformReadOnlyScope =
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only";
|
|
|
| + /// Manage your Google API service configuration
|
| + static const ServiceManagementScope =
|
| + "https://www.googleapis.com/auth/service.management";
|
|
|
| final commons.ApiRequester _requester;
|
|
|
| ProjectsResourceApi get projects => new ProjectsResourceApi(_requester);
|
| ServicesResourceApi get services => new ServicesResourceApi(_requester);
|
|
|
| - ServiceuserApi(http_1.Client client, {core.String rootUrl: "https://serviceuser.googleapis.com/", core.String servicePath: ""}) :
|
| - _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| + ServiceuserApi(http_1.Client client,
|
| + {core.String rootUrl: "https://serviceuser.googleapis.com/",
|
| + core.String servicePath: ""})
|
| + : _requester =
|
| + new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
|
| }
|
|
|
| -
|
| class ProjectsResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsServicesResourceApi get services => new ProjectsServicesResourceApi(_requester);
|
| + ProjectsServicesResourceApi get services =>
|
| + new ProjectsServicesResourceApi(_requester);
|
|
|
| - ProjectsResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| + ProjectsResourceApi(commons.ApiRequester client) : _requester = client;
|
| }
|
|
|
| -
|
| class ProjectsServicesResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ProjectsServicesResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Disable a service so it can no longer be used with a
|
| - * project. This prevents unintended usage that may cause unexpected billing
|
| - * charges or security leaks.
|
| - *
|
| - * Operation<response: google.protobuf.Empty>
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Name of the consumer and the service to disable for that consumer.
|
| - *
|
| - * The Service User implementation accepts the following forms for consumer:
|
| - * - "project:<project_id>"
|
| - *
|
| - * A valid path would be:
|
| - * - /v1/projects/my-project/services/servicemanagement.googleapis.com:disable
|
| - * Value must have pattern "^projects/[^/]+/services/[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http_1.Client] completes with an error when making a REST
|
| - * call, this method will complete with the same error.
|
| - */
|
| - async.Future<Operation> disable(DisableServiceRequest request, core.String name) {
|
| + ProjectsServicesResourceApi(commons.ApiRequester client)
|
| + : _requester = client;
|
| +
|
| + /// Disable a service so it can no longer be used with a
|
| + /// project. This prevents unintended usage that may cause unexpected billing
|
| + /// charges or security leaks.
|
| + ///
|
| + /// Operation<response: google.protobuf.Empty>
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Name of the consumer and the service to disable for that
|
| + /// consumer.
|
| + ///
|
| + /// The Service User implementation accepts the following forms for consumer:
|
| + /// - "project:<project_id>"
|
| + ///
|
| + /// A valid path would be:
|
| + /// -
|
| + /// /v1/projects/my-project/services/servicemanagement.googleapis.com:disable
|
| + /// Value must have pattern "^projects/[^/]+/services/[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http_1.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<Operation> disable(
|
| + DisableServiceRequest request, core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -101,42 +103,42 @@ class ProjectsServicesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':disable';
|
|
|
| - 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));
|
| }
|
|
|
| - /**
|
| - * Enable a service so it can be used with a project.
|
| - * See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
|
| - * more information.
|
| - *
|
| - * Operation<response: google.protobuf.Empty>
|
| - *
|
| - * [request] - The metadata request object.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [name] - Name of the consumer and the service to enable for that consumer.
|
| - *
|
| - * A valid path would be:
|
| - * - /v1/projects/my-project/services/servicemanagement.googleapis.com:enable
|
| - * Value must have pattern "^projects/[^/]+/services/[^/]+$".
|
| - *
|
| - * Completes with a [Operation].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http_1.Client] completes with an error when making a REST
|
| - * call, this method will complete with the same error.
|
| - */
|
| - async.Future<Operation> enable(EnableServiceRequest request, core.String name) {
|
| + /// Enable a service so it can be used with a project.
|
| + /// See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
|
| + /// more information.
|
| + ///
|
| + /// Operation<response: google.protobuf.Empty>
|
| + ///
|
| + /// [request] - The metadata request object.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [name] - Name of the consumer and the service to enable for that
|
| + /// consumer.
|
| + ///
|
| + /// A valid path would be:
|
| + /// -
|
| + /// /v1/projects/my-project/services/servicemanagement.googleapis.com:enable
|
| + /// Value must have pattern "^projects/[^/]+/services/[^/]+$".
|
| + ///
|
| + /// Completes with a [Operation].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http_1.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<Operation> enable(
|
| + EnableServiceRequest request, core.String name) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -153,42 +155,40 @@ class ProjectsServicesResourceApi {
|
|
|
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':enable';
|
|
|
| - 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));
|
| }
|
|
|
| - /**
|
| - * List enabled services for the specified consumer.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [parent] - List enabled services for the specified parent.
|
| - *
|
| - * An example valid parent would be:
|
| - * - projects/my-project
|
| - * Value must have pattern "^projects/[^/]+$".
|
| - *
|
| - * [pageToken] - Token identifying which result to start with; returned by a
|
| - * previous list
|
| - * call.
|
| - *
|
| - * [pageSize] - Requested size of the next page of data.
|
| - *
|
| - * Completes with a [ListEnabledServicesResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http_1.Client] completes with an error when making a REST
|
| - * call, this method will complete with the same error.
|
| - */
|
| - async.Future<ListEnabledServicesResponse> list(core.String parent, {core.String pageToken, core.int pageSize}) {
|
| + /// List enabled services for the specified consumer.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [parent] - List enabled services for the specified parent.
|
| + ///
|
| + /// An example valid parent would be:
|
| + /// - projects/my-project
|
| + /// Value must have pattern "^projects/[^/]+$".
|
| + ///
|
| + /// [pageSize] - Requested size of the next page of data.
|
| + ///
|
| + /// [pageToken] - Token identifying which result to start with; returned by a
|
| + /// previous list
|
| + /// call.
|
| + ///
|
| + /// Completes with a [ListEnabledServicesResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http_1.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<ListEnabledServicesResponse> list(core.String parent,
|
| + {core.int pageSize, core.String pageToken}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -199,58 +199,55 @@ class ProjectsServicesResourceApi {
|
| if (parent == null) {
|
| throw new core.ArgumentError("Parameter parent is required.");
|
| }
|
| - if (pageToken != null) {
|
| - _queryParams["pageToken"] = [pageToken];
|
| - }
|
| if (pageSize != null) {
|
| _queryParams["pageSize"] = ["${pageSize}"];
|
| }
|
| + if (pageToken != null) {
|
| + _queryParams["pageToken"] = [pageToken];
|
| + }
|
|
|
| - _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/services';
|
| + _url =
|
| + 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/services';
|
|
|
| - var _response = _requester.request(_url,
|
| - "GET",
|
| - body: _body,
|
| - queryParams: _queryParams,
|
| - uploadOptions: _uploadOptions,
|
| - uploadMedia: _uploadMedia,
|
| - downloadOptions: _downloadOptions);
|
| - return _response.then((data) => new ListEnabledServicesResponse.fromJson(data));
|
| + var _response = _requester.request(_url, "GET",
|
| + body: _body,
|
| + queryParams: _queryParams,
|
| + uploadOptions: _uploadOptions,
|
| + uploadMedia: _uploadMedia,
|
| + downloadOptions: _downloadOptions);
|
| + return _response
|
| + .then((data) => new ListEnabledServicesResponse.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| class ServicesResourceApi {
|
| final commons.ApiRequester _requester;
|
|
|
| - ServicesResourceApi(commons.ApiRequester client) :
|
| - _requester = client;
|
| -
|
| - /**
|
| - * Search available services.
|
| - *
|
| - * When no filter is specified, returns all accessible services. For
|
| - * authenticated users, also returns all services the calling user has
|
| - * "servicemanagement.services.bind" permission for.
|
| - *
|
| - * Request parameters:
|
| - *
|
| - * [pageToken] - Token identifying which result to start with; returned by a
|
| - * previous list
|
| - * call.
|
| - *
|
| - * [pageSize] - Requested size of the next page of data.
|
| - *
|
| - * Completes with a [SearchServicesResponse].
|
| - *
|
| - * Completes with a [commons.ApiRequestError] if the API endpoint returned an
|
| - * error.
|
| - *
|
| - * If the used [http_1.Client] completes with an error when making a REST
|
| - * call, this method will complete with the same error.
|
| - */
|
| - async.Future<SearchServicesResponse> search({core.String pageToken, core.int pageSize}) {
|
| + ServicesResourceApi(commons.ApiRequester client) : _requester = client;
|
| +
|
| + /// Search available services.
|
| + ///
|
| + /// When no filter is specified, returns all accessible services. For
|
| + /// authenticated users, also returns all services the calling user has
|
| + /// "servicemanagement.services.bind" permission for.
|
| + ///
|
| + /// Request parameters:
|
| + ///
|
| + /// [pageToken] - Token identifying which result to start with; returned by a
|
| + /// previous list
|
| + /// call.
|
| + ///
|
| + /// [pageSize] - Requested size of the next page of data.
|
| + ///
|
| + /// Completes with a [SearchServicesResponse].
|
| + ///
|
| + /// Completes with a [commons.ApiRequestError] if the API endpoint returned
|
| + /// an error.
|
| + ///
|
| + /// If the used [http_1.Client] completes with an error when making a REST
|
| + /// call, this method will complete with the same error.
|
| + async.Future<SearchServicesResponse> search(
|
| + {core.String pageToken, core.int pageSize}) {
|
| var _url = null;
|
| var _queryParams = new core.Map();
|
| var _uploadMedia = null;
|
| @@ -267,92 +264,91 @@ class ServicesResourceApi {
|
|
|
| _url = 'v1/services:search';
|
|
|
| - 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 SearchServicesResponse.fromJson(data));
|
| }
|
| -
|
| }
|
|
|
| -
|
| -
|
| -/**
|
| - * Api is a light-weight descriptor for an API Interface.
|
| - *
|
| - * Interfaces are also described as "protocol buffer services" in some contexts,
|
| - * such as by the "service" keyword in a .proto file, but they are different
|
| - * from API Services, which represent a concrete implementation of an interface
|
| - * as opposed to simply a description of methods and bindings. They are also
|
| - * sometimes simply referred to as "APIs" in other contexts, such as the name of
|
| - * this message itself. See https://cloud.google.com/apis/design/glossary for
|
| - * detailed terminology.
|
| - */
|
| +/// Api is a light-weight descriptor for an API Interface.
|
| +///
|
| +/// Interfaces are also described as "protocol buffer services" in some
|
| +/// contexts,
|
| +/// such as by the "service" keyword in a .proto file, but they are different
|
| +/// from API Services, which represent a concrete implementation of an
|
| +/// interface
|
| +/// as opposed to simply a description of methods and bindings. They are also
|
| +/// sometimes simply referred to as "APIs" in other contexts, such as the name
|
| +/// of
|
| +/// this message itself. See https://cloud.google.com/apis/design/glossary for
|
| +/// detailed terminology.
|
| class Api {
|
| - /** The methods of this interface, in unspecified order. */
|
| + /// The methods of this interface, in unspecified order.
|
| core.List<Method> methods;
|
| - /** Included interfaces. See Mixin. */
|
| +
|
| + /// Included interfaces. See Mixin.
|
| core.List<Mixin> mixins;
|
| - /**
|
| - * The fully qualified name of this interface, including package name
|
| - * followed by the interface's simple name.
|
| - */
|
| +
|
| + /// The fully qualified name of this interface, including package name
|
| + /// followed by the interface's simple name.
|
| core.String name;
|
| - /** Any metadata attached to the interface. */
|
| +
|
| + /// Any metadata attached to the interface.
|
| core.List<Option> options;
|
| - /**
|
| - * Source context for the protocol buffer service represented by this
|
| - * message.
|
| - */
|
| +
|
| + /// Source context for the protocol buffer service represented by this
|
| + /// message.
|
| SourceContext sourceContext;
|
| - /**
|
| - * The source syntax of the service.
|
| - * Possible string values are:
|
| - * - "SYNTAX_PROTO2" : Syntax `proto2`.
|
| - * - "SYNTAX_PROTO3" : Syntax `proto3`.
|
| - */
|
| +
|
| + /// The source syntax of the service.
|
| + /// Possible string values are:
|
| + /// - "SYNTAX_PROTO2" : Syntax `proto2`.
|
| + /// - "SYNTAX_PROTO3" : Syntax `proto3`.
|
| core.String syntax;
|
| - /**
|
| - * A version string for this interface. If specified, must have the form
|
| - * `major-version.minor-version`, as in `1.10`. If the minor version is
|
| - * omitted, it defaults to zero. If the entire version field is empty, the
|
| - * major version is derived from the package name, as outlined below. If the
|
| - * field is not empty, the version in the package name will be verified to be
|
| - * consistent with what is provided here.
|
| - *
|
| - * The versioning schema uses [semantic
|
| - * versioning](http://semver.org) where the major version number
|
| - * indicates a breaking change and the minor version an additive,
|
| - * non-breaking change. Both version numbers are signals to users
|
| - * what to expect from different versions, and should be carefully
|
| - * chosen based on the product plan.
|
| - *
|
| - * The major version is also reflected in the package name of the
|
| - * interface, which must end in `v<major-version>`, as in
|
| - * `google.feature.v1`. For major versions 0 and 1, the suffix can
|
| - * be omitted. Zero major versions must only be used for
|
| - * experimental, non-GA interfaces.
|
| - */
|
| +
|
| + /// A version string for this interface. If specified, must have the form
|
| + /// `major-version.minor-version`, as in `1.10`. If the minor version is
|
| + /// omitted, it defaults to zero. If the entire version field is empty, the
|
| + /// major version is derived from the package name, as outlined below. If the
|
| + /// field is not empty, the version in the package name will be verified to
|
| + /// be
|
| + /// consistent with what is provided here.
|
| + ///
|
| + /// The versioning schema uses [semantic
|
| + /// versioning](http://semver.org) where the major version number
|
| + /// indicates a breaking change and the minor version an additive,
|
| + /// non-breaking change. Both version numbers are signals to users
|
| + /// what to expect from different versions, and should be carefully
|
| + /// chosen based on the product plan.
|
| + ///
|
| + /// The major version is also reflected in the package name of the
|
| + /// interface, which must end in `v<major-version>`, as in
|
| + /// `google.feature.v1`. For major versions 0 and 1, the suffix can
|
| + /// be omitted. Zero major versions must only be used for
|
| + /// experimental, non-GA interfaces.
|
| core.String version;
|
|
|
| Api();
|
|
|
| Api.fromJson(core.Map _json) {
|
| if (_json.containsKey("methods")) {
|
| - methods = _json["methods"].map((value) => new Method.fromJson(value)).toList();
|
| + methods =
|
| + _json["methods"].map((value) => new Method.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("mixins")) {
|
| - mixins = _json["mixins"].map((value) => new Mixin.fromJson(value)).toList();
|
| + mixins =
|
| + _json["mixins"].map((value) => new Mixin.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("name")) {
|
| name = _json["name"];
|
| }
|
| if (_json.containsKey("options")) {
|
| - options = _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| + options =
|
| + _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("sourceContext")) {
|
| sourceContext = new SourceContext.fromJson(_json["sourceContext"]);
|
| @@ -366,7 +362,8 @@ class Api {
|
| }
|
|
|
| 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 (methods != null) {
|
| _json["methods"] = methods.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -392,63 +389,56 @@ class Api {
|
| }
|
| }
|
|
|
| -/**
|
| - * Configuration for an anthentication provider, including support for
|
| - * [JSON Web Token
|
| - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
| - */
|
| +/// Configuration for an anthentication provider, including support for
|
| +/// [JSON Web Token
|
| +/// (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
| class AuthProvider {
|
| - /**
|
| - * The list of JWT
|
| - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
|
| - * that are allowed to access. A JWT containing any of these audiences will
|
| - * be accepted. When this setting is absent, only JWTs with audience
|
| - * "https://Service_name/API_name"
|
| - * will be accepted. For example, if no audiences are in the setting,
|
| - * LibraryService API will only accept JWTs with the following audience
|
| - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
|
| - *
|
| - * Example:
|
| - *
|
| - * audiences: bookstore_android.apps.googleusercontent.com,
|
| - * bookstore_web.apps.googleusercontent.com
|
| - */
|
| + /// The list of JWT
|
| + /// [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
|
| + /// that are allowed to access. A JWT containing any of these audiences will
|
| + /// be accepted. When this setting is absent, only JWTs with audience
|
| + /// "https://Service_name/API_name"
|
| + /// will be accepted. For example, if no audiences are in the setting,
|
| + /// LibraryService API will only accept JWTs with the following audience
|
| + /// "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
|
| + ///
|
| + /// Example:
|
| + ///
|
| + /// audiences: bookstore_android.apps.googleusercontent.com,
|
| + /// bookstore_web.apps.googleusercontent.com
|
| core.String audiences;
|
| - /**
|
| - * Redirect URL if JWT token is required but no present or is expired.
|
| - * Implement authorizationUrl of securityDefinitions in OpenAPI spec.
|
| - */
|
| +
|
| + /// Redirect URL if JWT token is required but no present or is expired.
|
| + /// Implement authorizationUrl of securityDefinitions in OpenAPI spec.
|
| core.String authorizationUrl;
|
| - /**
|
| - * The unique identifier of the auth provider. It will be referred to by
|
| - * `AuthRequirement.provider_id`.
|
| - *
|
| - * Example: "bookstore_auth".
|
| - */
|
| +
|
| + /// The unique identifier of the auth provider. It will be referred to by
|
| + /// `AuthRequirement.provider_id`.
|
| + ///
|
| + /// Example: "bookstore_auth".
|
| core.String id;
|
| - /**
|
| - * Identifies the principal that issued the JWT. See
|
| - * https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
|
| - * Usually a URL or an email address.
|
| - *
|
| - * Example: https://securetoken.google.com
|
| - * Example: 1234567-compute@developer.gserviceaccount.com
|
| - */
|
| +
|
| + /// Identifies the principal that issued the JWT. See
|
| + /// https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
|
| + /// Usually a URL or an email address.
|
| + ///
|
| + /// Example: https://securetoken.google.com
|
| + /// Example: 1234567-compute@developer.gserviceaccount.com
|
| core.String issuer;
|
| - /**
|
| - * URL of the provider's public key set to validate signature of the JWT. See
|
| - * [OpenID
|
| - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
|
| - * Optional if the key set document:
|
| - * - can be retrieved from
|
| - * [OpenID
|
| - * Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
|
| - * of the issuer.
|
| - * - can be inferred from the email domain of the issuer (e.g. a Google
|
| - * service account).
|
| - *
|
| - * Example: https://www.googleapis.com/oauth2/v1/certs
|
| - */
|
| +
|
| + /// URL of the provider's public key set to validate signature of the JWT.
|
| + /// See
|
| + /// [OpenID
|
| + /// Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
|
| + /// Optional if the key set document:
|
| + /// - can be retrieved from
|
| + /// [OpenID
|
| + /// Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
|
| + /// of the issuer.
|
| + /// - can be inferred from the email domain of the issuer (e.g. a Google
|
| + /// service account).
|
| + ///
|
| + /// Example: https://www.googleapis.com/oauth2/v1/certs
|
| core.String jwksUri;
|
|
|
| AuthProvider();
|
| @@ -472,7 +462,8 @@ class AuthProvider {
|
| }
|
|
|
| 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 (audiences != null) {
|
| _json["audiences"] = audiences;
|
| }
|
| @@ -492,38 +483,33 @@ class AuthProvider {
|
| }
|
| }
|
|
|
| -/**
|
| - * User-defined authentication requirements, including support for
|
| - * [JSON Web Token
|
| - * (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
| - */
|
| +/// User-defined authentication requirements, including support for
|
| +/// [JSON Web Token
|
| +/// (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
|
| class AuthRequirement {
|
| - /**
|
| - * NOTE: This will be deprecated soon, once AuthProvider.audiences is
|
| - * implemented and accepted in all the runtime components.
|
| - *
|
| - * The list of JWT
|
| - * [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
|
| - * that are allowed to access. A JWT containing any of these audiences will
|
| - * be accepted. When this setting is absent, only JWTs with audience
|
| - * "https://Service_name/API_name"
|
| - * will be accepted. For example, if no audiences are in the setting,
|
| - * LibraryService API will only accept JWTs with the following audience
|
| - * "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
|
| - *
|
| - * Example:
|
| - *
|
| - * audiences: bookstore_android.apps.googleusercontent.com,
|
| - * bookstore_web.apps.googleusercontent.com
|
| - */
|
| + /// NOTE: This will be deprecated soon, once AuthProvider.audiences is
|
| + /// implemented and accepted in all the runtime components.
|
| + ///
|
| + /// The list of JWT
|
| + /// [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
|
| + /// that are allowed to access. A JWT containing any of these audiences will
|
| + /// be accepted. When this setting is absent, only JWTs with audience
|
| + /// "https://Service_name/API_name"
|
| + /// will be accepted. For example, if no audiences are in the setting,
|
| + /// LibraryService API will only accept JWTs with the following audience
|
| + /// "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
|
| + ///
|
| + /// Example:
|
| + ///
|
| + /// audiences: bookstore_android.apps.googleusercontent.com,
|
| + /// bookstore_web.apps.googleusercontent.com
|
| core.String audiences;
|
| - /**
|
| - * id from authentication provider.
|
| - *
|
| - * Example:
|
| - *
|
| - * provider_id: bookstore_auth
|
| - */
|
| +
|
| + /// id from authentication provider.
|
| + ///
|
| + /// Example:
|
| + ///
|
| + /// provider_id: bookstore_auth
|
| core.String providerId;
|
|
|
| AuthRequirement();
|
| @@ -538,7 +524,8 @@ class AuthRequirement {
|
| }
|
|
|
| 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 (audiences != null) {
|
| _json["audiences"] = audiences;
|
| }
|
| @@ -549,45 +536,47 @@ class AuthRequirement {
|
| }
|
| }
|
|
|
| -/**
|
| - * `Authentication` defines the authentication configuration for an API.
|
| - *
|
| - * Example for an API targeted for external use:
|
| - *
|
| - * name: calendar.googleapis.com
|
| - * authentication:
|
| - * providers:
|
| - * - id: google_calendar_auth
|
| - * jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
| - * issuer: https://securetoken.google.com
|
| - * rules:
|
| - * - selector: "*"
|
| - * requirements:
|
| - * provider_id: google_calendar_auth
|
| - */
|
| +/// `Authentication` defines the authentication configuration for an API.
|
| +///
|
| +/// Example for an API targeted for external use:
|
| +///
|
| +/// name: calendar.googleapis.com
|
| +/// authentication:
|
| +/// providers:
|
| +/// - id: google_calendar_auth
|
| +/// jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
| +/// issuer: https://securetoken.google.com
|
| +/// rules:
|
| +/// - selector: "*"
|
| +/// requirements:
|
| +/// provider_id: google_calendar_auth
|
| class Authentication {
|
| - /** Defines a set of authentication providers that a service supports. */
|
| + /// Defines a set of authentication providers that a service supports.
|
| core.List<AuthProvider> providers;
|
| - /**
|
| - * A list of authentication rules that apply to individual API methods.
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| +
|
| + /// A list of authentication rules that apply to individual API methods.
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<AuthenticationRule> rules;
|
|
|
| Authentication();
|
|
|
| Authentication.fromJson(core.Map _json) {
|
| if (_json.containsKey("providers")) {
|
| - providers = _json["providers"].map((value) => new AuthProvider.fromJson(value)).toList();
|
| + providers = _json["providers"]
|
| + .map((value) => new AuthProvider.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new AuthenticationRule.fromJson(value)).toList();
|
| + rules = _json["rules"]
|
| + .map((value) => new AuthenticationRule.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 (providers != null) {
|
| _json["providers"] = providers.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -598,39 +587,38 @@ class Authentication {
|
| }
|
| }
|
|
|
| -/**
|
| - * Authentication rules for the service.
|
| - *
|
| - * By default, if a method has any authentication requirements, every request
|
| - * must include a valid credential matching one of the requirements.
|
| - * It's an error to include more than one kind of credential in a single
|
| - * request.
|
| - *
|
| - * If a method doesn't have any auth requirements, request credentials will be
|
| - * ignored.
|
| - */
|
| +/// Authentication rules for the service.
|
| +///
|
| +/// By default, if a method has any authentication requirements, every request
|
| +/// must include a valid credential matching one of the requirements.
|
| +/// It's an error to include more than one kind of credential in a single
|
| +/// request.
|
| +///
|
| +/// If a method doesn't have any auth requirements, request credentials will be
|
| +/// ignored.
|
| class AuthenticationRule {
|
| - /**
|
| - * Whether to allow requests without a credential. The credential can be
|
| - * an OAuth token, Google cookies (first-party auth) or EndUserCreds.
|
| - *
|
| - * For requests without credentials, if the service control environment is
|
| - * specified, each incoming request **must** be associated with a service
|
| - * consumer. This can be done by passing an API key that belongs to a consumer
|
| - * project.
|
| - */
|
| + /// Whether to allow requests without a credential. The credential can be
|
| + /// an OAuth token, Google cookies (first-party auth) or EndUserCreds.
|
| + ///
|
| + /// For requests without credentials, if the service control environment is
|
| + /// specified, each incoming request **must** be associated with a service
|
| + /// consumer. This can be done by passing an API key that belongs to a
|
| + /// consumer
|
| + /// project.
|
| core.bool allowWithoutCredential;
|
| - /** Configuration for custom authentication. */
|
| +
|
| + /// Configuration for custom authentication.
|
| CustomAuthRequirements customAuth;
|
| - /** The requirements for OAuth credentials. */
|
| +
|
| + /// The requirements for OAuth credentials.
|
| OAuthRequirements oauth;
|
| - /** Requirements for additional authentication providers. */
|
| +
|
| + /// Requirements for additional authentication providers.
|
| core.List<AuthRequirement> requirements;
|
| - /**
|
| - * Selects the methods to which this rule applies.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects the methods to which this rule applies.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| AuthenticationRule();
|
| @@ -646,7 +634,9 @@ class AuthenticationRule {
|
| oauth = new OAuthRequirements.fromJson(_json["oauth"]);
|
| }
|
| if (_json.containsKey("requirements")) {
|
| - requirements = _json["requirements"].map((value) => new AuthRequirement.fromJson(value)).toList();
|
| + requirements = _json["requirements"]
|
| + .map((value) => new AuthRequirement.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("selector")) {
|
| selector = _json["selector"];
|
| @@ -654,7 +644,8 @@ class AuthenticationRule {
|
| }
|
|
|
| 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 (allowWithoutCredential != null) {
|
| _json["allowWithoutCredential"] = allowWithoutCredential;
|
| }
|
| @@ -665,7 +656,8 @@ class AuthenticationRule {
|
| _json["oauth"] = (oauth).toJson();
|
| }
|
| if (requirements != null) {
|
| - _json["requirements"] = requirements.map((value) => (value).toJson()).toList();
|
| + _json["requirements"] =
|
| + requirements.map((value) => (value).toJson()).toList();
|
| }
|
| if (selector != null) {
|
| _json["selector"] = selector;
|
| @@ -674,23 +666,19 @@ class AuthenticationRule {
|
| }
|
| }
|
|
|
| -/**
|
| - * Configuration of authorization.
|
| - *
|
| - * This section determines the authorization provider, if unspecified, then no
|
| - * authorization check will be done.
|
| - *
|
| - * Example:
|
| - *
|
| - * experimental:
|
| - * authorization:
|
| - * provider: firebaserules.googleapis.com
|
| - */
|
| +/// Configuration of authorization.
|
| +///
|
| +/// This section determines the authorization provider, if unspecified, then no
|
| +/// authorization check will be done.
|
| +///
|
| +/// Example:
|
| +///
|
| +/// experimental:
|
| +/// authorization:
|
| +/// provider: firebaserules.googleapis.com
|
| class AuthorizationConfig {
|
| - /**
|
| - * The name of the authorization provider, such as
|
| - * firebaserules.googleapis.com.
|
| - */
|
| + /// The name of the authorization provider, such as
|
| + /// firebaserules.googleapis.com.
|
| core.String provider;
|
|
|
| AuthorizationConfig();
|
| @@ -702,7 +690,8 @@ class AuthorizationConfig {
|
| }
|
|
|
| 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 (provider != null) {
|
| _json["provider"] = provider;
|
| }
|
| @@ -710,41 +699,37 @@ class AuthorizationConfig {
|
| }
|
| }
|
|
|
| -/**
|
| - * Authorization rule for API services.
|
| - *
|
| - * It specifies the permission(s) required for an API element for the overall
|
| - * API request to succeed. It is typically used to mark request message fields
|
| - * that contain the name of the resource and indicates the permissions that
|
| - * will be checked on that resource.
|
| - *
|
| - * For example:
|
| - *
|
| - * package google.storage.v1;
|
| - *
|
| - * message CopyObjectRequest {
|
| - * string source = 1 [
|
| - * (google.api.authz).permissions = "storage.objects.get"];
|
| - *
|
| - * string destination = 2 [
|
| - * (google.api.authz).permissions =
|
| - * "storage.objects.create,storage.objects.update"];
|
| - * }
|
| - */
|
| +/// Authorization rule for API services.
|
| +///
|
| +/// It specifies the permission(s) required for an API element for the overall
|
| +/// API request to succeed. It is typically used to mark request message fields
|
| +/// that contain the name of the resource and indicates the permissions that
|
| +/// will be checked on that resource.
|
| +///
|
| +/// For example:
|
| +///
|
| +/// package google.storage.v1;
|
| +///
|
| +/// message CopyObjectRequest {
|
| +/// string source = 1 [
|
| +/// (google.api.authz).permissions = "storage.objects.get"];
|
| +///
|
| +/// string destination = 2 [
|
| +/// (google.api.authz).permissions =
|
| +/// "storage.objects.create,storage.objects.update"];
|
| +/// }
|
| class AuthorizationRule {
|
| - /**
|
| - * The required permissions. The acceptable values vary depend on the
|
| - * authorization system used. For Google APIs, it should be a comma-separated
|
| - * Google IAM permission values. When multiple permissions are listed, the
|
| - * semantics is not defined by the system. Additional documentation must
|
| - * be provided manually.
|
| - */
|
| + /// The required permissions. The acceptable values vary depend on the
|
| + /// authorization system used. For Google APIs, it should be a
|
| + /// comma-separated
|
| + /// Google IAM permission values. When multiple permissions are listed, the
|
| + /// semantics is not defined by the system. Additional documentation must
|
| + /// be provided manually.
|
| core.String permissions;
|
| - /**
|
| - * Selects the API elements to which this rule applies.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects the API elements to which this rule applies.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| AuthorizationRule();
|
| @@ -759,7 +744,8 @@ class AuthorizationRule {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -770,25 +756,26 @@ class AuthorizationRule {
|
| }
|
| }
|
|
|
| -/** `Backend` defines the backend configuration for a service. */
|
| +/// `Backend` defines the backend configuration for a service.
|
| class Backend {
|
| - /**
|
| - * A list of API backend rules that apply to individual API methods.
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| + /// A list of API backend rules that apply to individual API methods.
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<BackendRule> rules;
|
|
|
| Backend();
|
|
|
| Backend.fromJson(core.Map _json) {
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new BackendRule.fromJson(value)).toList();
|
| + rules = _json["rules"]
|
| + .map((value) => new BackendRule.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 (rules != null) {
|
| _json["rules"] = rules.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -796,25 +783,23 @@ class Backend {
|
| }
|
| }
|
|
|
| -/** A backend rule provides configuration for an individual API element. */
|
| +/// A backend rule provides configuration for an individual API element.
|
| class BackendRule {
|
| - /** The address of the API backend. */
|
| + /// The address of the API backend.
|
| core.String address;
|
| - /**
|
| - * The number of seconds to wait for a response from a request. The
|
| - * default depends on the deployment context.
|
| - */
|
| +
|
| + /// The number of seconds to wait for a response from a request. The default
|
| + /// deadline for gRPC and HTTP requests is 5 seconds. For Stubby requests,
|
| + /// the default is no deadline.
|
| core.double deadline;
|
| - /**
|
| - * Minimum deadline in seconds needed for this method. Calls having deadline
|
| - * value lower than this will be rejected.
|
| - */
|
| +
|
| + /// Minimum deadline in seconds needed for this method. Calls having deadline
|
| + /// value lower than this will be rejected.
|
| core.double minDeadline;
|
| - /**
|
| - * Selects the methods to which this rule applies.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects the methods to which this rule applies.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| BackendRule();
|
| @@ -835,7 +820,8 @@ class BackendRule {
|
| }
|
|
|
| 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 (address != null) {
|
| _json["address"] = address;
|
| }
|
| @@ -852,43 +838,42 @@ class BackendRule {
|
| }
|
| }
|
|
|
| -/**
|
| - * `Context` defines which contexts an API requests.
|
| - *
|
| - * Example:
|
| - *
|
| - * context:
|
| - * rules:
|
| - * - selector: "*"
|
| - * requested:
|
| - * - google.rpc.context.ProjectContext
|
| - * - google.rpc.context.OriginContext
|
| - *
|
| - * The above specifies that all methods in the API request
|
| - * `google.rpc.context.ProjectContext` and
|
| - * `google.rpc.context.OriginContext`.
|
| - *
|
| - * Available context types are defined in package
|
| - * `google.rpc.context`.
|
| - */
|
| +/// `Context` defines which contexts an API requests.
|
| +///
|
| +/// Example:
|
| +///
|
| +/// context:
|
| +/// rules:
|
| +/// - selector: "*"
|
| +/// requested:
|
| +/// - google.rpc.context.ProjectContext
|
| +/// - google.rpc.context.OriginContext
|
| +///
|
| +/// The above specifies that all methods in the API request
|
| +/// `google.rpc.context.ProjectContext` and
|
| +/// `google.rpc.context.OriginContext`.
|
| +///
|
| +/// Available context types are defined in package
|
| +/// `google.rpc.context`.
|
| class Context {
|
| - /**
|
| - * A list of RPC context rules that apply to individual API methods.
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| + /// A list of RPC context rules that apply to individual API methods.
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<ContextRule> rules;
|
|
|
| Context();
|
|
|
| Context.fromJson(core.Map _json) {
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new ContextRule.fromJson(value)).toList();
|
| + rules = _json["rules"]
|
| + .map((value) => new ContextRule.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 (rules != null) {
|
| _json["rules"] = rules.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -896,20 +881,18 @@ class Context {
|
| }
|
| }
|
|
|
| -/**
|
| - * A context rule provides information about the context for an individual API
|
| - * element.
|
| - */
|
| +/// A context rule provides information about the context for an individual API
|
| +/// element.
|
| class ContextRule {
|
| - /** A list of full type names of provided contexts. */
|
| + /// A list of full type names of provided contexts.
|
| core.List<core.String> provided;
|
| - /** A list of full type names of requested contexts. */
|
| +
|
| + /// A list of full type names of requested contexts.
|
| core.List<core.String> requested;
|
| - /**
|
| - * Selects the methods to which this rule applies.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects the methods to which this rule applies.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| ContextRule();
|
| @@ -927,7 +910,8 @@ class ContextRule {
|
| }
|
|
|
| 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 (provided != null) {
|
| _json["provided"] = provided;
|
| }
|
| @@ -941,16 +925,12 @@ class ContextRule {
|
| }
|
| }
|
|
|
| -/**
|
| - * Selects and configures the service controller used by the service. The
|
| - * service controller handles features like abuse, quota, billing, logging,
|
| - * monitoring, etc.
|
| - */
|
| +/// Selects and configures the service controller used by the service. The
|
| +/// service controller handles features like abuse, quota, billing, logging,
|
| +/// monitoring, etc.
|
| class Control {
|
| - /**
|
| - * The service control environment to use. If empty, no control plane
|
| - * feature (like quota and billing) will be enabled.
|
| - */
|
| + /// The service control environment to use. If empty, no control plane
|
| + /// feature (like quota and billing) will be enabled.
|
| core.String environment;
|
|
|
| Control();
|
| @@ -962,7 +942,8 @@ class Control {
|
| }
|
|
|
| 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 (environment != null) {
|
| _json["environment"] = environment;
|
| }
|
| @@ -970,13 +951,11 @@ class Control {
|
| }
|
| }
|
|
|
| -/** Configuration for a custom authentication provider. */
|
| +/// Configuration for a custom authentication provider.
|
| class CustomAuthRequirements {
|
| - /**
|
| - * A configuration string containing connection information for the
|
| - * authentication provider, typically formatted as a SmartService string
|
| - * (go/smartservice).
|
| - */
|
| + /// A configuration string containing connection information for the
|
| + /// authentication provider, typically formatted as a SmartService string
|
| + /// (go/smartservice).
|
| core.String provider;
|
|
|
| CustomAuthRequirements();
|
| @@ -988,7 +967,8 @@ class CustomAuthRequirements {
|
| }
|
|
|
| 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 (provider != null) {
|
| _json["provider"] = provider;
|
| }
|
| @@ -996,35 +976,32 @@ class CustomAuthRequirements {
|
| }
|
| }
|
|
|
| -/**
|
| - * Customize service error responses. For example, list any service
|
| - * specific protobuf types that can appear in error detail lists of
|
| - * error responses.
|
| - *
|
| - * Example:
|
| - *
|
| - * custom_error:
|
| - * types:
|
| - * - google.foo.v1.CustomError
|
| - * - google.foo.v1.AnotherError
|
| - */
|
| +/// Customize service error responses. For example, list any service
|
| +/// specific protobuf types that can appear in error detail lists of
|
| +/// error responses.
|
| +///
|
| +/// Example:
|
| +///
|
| +/// custom_error:
|
| +/// types:
|
| +/// - google.foo.v1.CustomError
|
| +/// - google.foo.v1.AnotherError
|
| class CustomError {
|
| - /**
|
| - * The list of custom error rules that apply to individual API messages.
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| + /// The list of custom error rules that apply to individual API messages.
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<CustomErrorRule> rules;
|
| - /**
|
| - * The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
|
| - */
|
| +
|
| + /// The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
|
| core.List<core.String> types;
|
|
|
| CustomError();
|
|
|
| CustomError.fromJson(core.Map _json) {
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new CustomErrorRule.fromJson(value)).toList();
|
| + rules = _json["rules"]
|
| + .map((value) => new CustomErrorRule.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("types")) {
|
| types = _json["types"];
|
| @@ -1032,7 +1009,8 @@ class CustomError {
|
| }
|
|
|
| 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 (rules != null) {
|
| _json["rules"] = rules.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -1043,18 +1021,15 @@ class CustomError {
|
| }
|
| }
|
|
|
| -/** A custom error rule. */
|
| +/// A custom error rule.
|
| class CustomErrorRule {
|
| - /**
|
| - * Mark this message as possible payload in error response. Otherwise,
|
| - * objects of this type will be filtered when they appear in error payload.
|
| - */
|
| + /// Mark this message as possible payload in error response. Otherwise,
|
| + /// objects of this type will be filtered when they appear in error payload.
|
| core.bool isErrorType;
|
| - /**
|
| - * Selects messages to which this rule applies.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects messages to which this rule applies.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| CustomErrorRule();
|
| @@ -1069,7 +1044,8 @@ class CustomErrorRule {
|
| }
|
|
|
| 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 (isErrorType != null) {
|
| _json["isErrorType"] = isErrorType;
|
| }
|
| @@ -1080,11 +1056,12 @@ class CustomErrorRule {
|
| }
|
| }
|
|
|
| -/** A custom pattern is used for defining custom HTTP verb. */
|
| +/// A custom pattern is used for defining custom HTTP verb.
|
| class CustomHttpPattern {
|
| - /** The name of this custom HTTP verb. */
|
| + /// The name of this custom HTTP verb.
|
| core.String kind;
|
| - /** The path matched by this custom verb. */
|
| +
|
| + /// The path matched by this custom verb.
|
| core.String path;
|
|
|
| CustomHttpPattern();
|
| @@ -1099,7 +1076,8 @@ class CustomHttpPattern {
|
| }
|
|
|
| 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 (kind != null) {
|
| _json["kind"] = kind;
|
| }
|
| @@ -1110,110 +1088,105 @@ class CustomHttpPattern {
|
| }
|
| }
|
|
|
| -/** Request message for DisableService method. */
|
| +/// Request message for DisableService method.
|
| class DisableServiceRequest {
|
| -
|
| DisableServiceRequest();
|
|
|
| - DisableServiceRequest.fromJson(core.Map _json) {
|
| - }
|
| + DisableServiceRequest.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;
|
| }
|
| }
|
|
|
| -/**
|
| - * `Documentation` provides the information for describing a service.
|
| - *
|
| - * Example:
|
| - * <pre><code>documentation:
|
| - * summary: >
|
| - * The Google Calendar API gives access
|
| - * to most calendar features.
|
| - * pages:
|
| - * - name: Overview
|
| - * content: (== include google/foo/overview.md ==)
|
| - * - name: Tutorial
|
| - * content: (== include google/foo/tutorial.md ==)
|
| - * subpages;
|
| - * - name: Java
|
| - * content: (== include google/foo/tutorial_java.md ==)
|
| - * rules:
|
| - * - selector: google.calendar.Calendar.Get
|
| - * description: >
|
| - * ...
|
| - * - selector: google.calendar.Calendar.Put
|
| - * description: >
|
| - * ...
|
| - * </code></pre>
|
| - * Documentation is provided in markdown syntax. In addition to
|
| - * standard markdown features, definition lists, tables and fenced
|
| - * code blocks are supported. Section headers can be provided and are
|
| - * interpreted relative to the section nesting of the context where
|
| - * a documentation fragment is embedded.
|
| - *
|
| - * Documentation from the IDL is merged with documentation defined
|
| - * via the config at normalization time, where documentation provided
|
| - * by config rules overrides IDL provided.
|
| - *
|
| - * A number of constructs specific to the API platform are supported
|
| - * in documentation text.
|
| - *
|
| - * In order to reference a proto element, the following
|
| - * notation can be used:
|
| - * <pre><code>[fully.qualified.proto.name][]</code></pre>
|
| - * To override the display text used for the link, this can be used:
|
| - * <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
| - * Text can be excluded from doc using the following notation:
|
| - * <pre><code>(-- internal comment --)</code></pre>
|
| - * Comments can be made conditional using a visibility label. The below
|
| - * text will be only rendered if the `BETA` label is available:
|
| - * <pre><code>(--BETA: comment for BETA users --)</code></pre>
|
| - * A few directives are available in documentation. Note that
|
| - * directives must appear on a single line to be properly
|
| - * identified. The `include` directive includes a markdown file from
|
| - * an external source:
|
| - * <pre><code>(== include path/to/file ==)</code></pre>
|
| - * The `resource_for` directive marks a message to be the resource of
|
| - * a collection in REST view. If it is not specified, tools attempt
|
| - * to infer the resource from the operations in a collection:
|
| - * <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
| - * The directive `suppress_warning` does not directly affect documentation
|
| - * and is documented together with service config validation.
|
| - */
|
| +/// `Documentation` provides the information for describing a service.
|
| +///
|
| +/// Example:
|
| +/// <pre><code>documentation:
|
| +/// summary: >
|
| +/// The Google Calendar API gives access
|
| +/// to most calendar features.
|
| +/// pages:
|
| +/// - name: Overview
|
| +/// content: (== include google/foo/overview.md ==)
|
| +/// - name: Tutorial
|
| +/// content: (== include google/foo/tutorial.md ==)
|
| +/// subpages;
|
| +/// - name: Java
|
| +/// content: (== include google/foo/tutorial_java.md ==)
|
| +/// rules:
|
| +/// - selector: google.calendar.Calendar.Get
|
| +/// description: >
|
| +/// ...
|
| +/// - selector: google.calendar.Calendar.Put
|
| +/// description: >
|
| +/// ...
|
| +/// </code></pre>
|
| +/// Documentation is provided in markdown syntax. In addition to
|
| +/// standard markdown features, definition lists, tables and fenced
|
| +/// code blocks are supported. Section headers can be provided and are
|
| +/// interpreted relative to the section nesting of the context where
|
| +/// a documentation fragment is embedded.
|
| +///
|
| +/// Documentation from the IDL is merged with documentation defined
|
| +/// via the config at normalization time, where documentation provided
|
| +/// by config rules overrides IDL provided.
|
| +///
|
| +/// A number of constructs specific to the API platform are supported
|
| +/// in documentation text.
|
| +///
|
| +/// In order to reference a proto element, the following
|
| +/// notation can be used:
|
| +/// <pre><code>[fully.qualified.proto.name][]</code></pre>
|
| +/// To override the display text used for the link, this can be used:
|
| +/// <pre><code>[display text][fully.qualified.proto.name]</code></pre>
|
| +/// Text can be excluded from doc using the following notation:
|
| +/// <pre><code>(-- internal comment --)</code></pre>
|
| +/// Comments can be made conditional using a visibility label. The below
|
| +/// text will be only rendered if the `BETA` label is available:
|
| +/// <pre><code>(--BETA: comment for BETA users --)</code></pre>
|
| +/// A few directives are available in documentation. Note that
|
| +/// directives must appear on a single line to be properly
|
| +/// identified. The `include` directive includes a markdown file from
|
| +/// an external source:
|
| +/// <pre><code>(== include path/to/file ==)</code></pre>
|
| +/// The `resource_for` directive marks a message to be the resource of
|
| +/// a collection in REST view. If it is not specified, tools attempt
|
| +/// to infer the resource from the operations in a collection:
|
| +/// <pre><code>(== resource_for v1.shelves.books ==)</code></pre>
|
| +/// The directive `suppress_warning` does not directly affect documentation
|
| +/// and is documented together with service config validation.
|
| class Documentation {
|
| - /** The URL to the root of documentation. */
|
| + /// The URL to the root of documentation.
|
| core.String documentationRootUrl;
|
| - /**
|
| - * Declares a single overview page. For example:
|
| - * <pre><code>documentation:
|
| - * summary: ...
|
| - * overview: (== include overview.md ==)
|
| - * </code></pre>
|
| - * This is a shortcut for the following declaration (using pages style):
|
| - * <pre><code>documentation:
|
| - * summary: ...
|
| - * pages:
|
| - * - name: Overview
|
| - * content: (== include overview.md ==)
|
| - * </code></pre>
|
| - * Note: you cannot specify both `overview` field and `pages` field.
|
| - */
|
| +
|
| + /// Declares a single overview page. For example:
|
| + /// <pre><code>documentation:
|
| + /// summary: ...
|
| + /// overview: (== include overview.md ==)
|
| + /// </code></pre>
|
| + /// This is a shortcut for the following declaration (using pages style):
|
| + /// <pre><code>documentation:
|
| + /// summary: ...
|
| + /// pages:
|
| + /// - name: Overview
|
| + /// content: (== include overview.md ==)
|
| + /// </code></pre>
|
| + /// Note: you cannot specify both `overview` field and `pages` field.
|
| core.String overview;
|
| - /** The top level pages for the documentation set. */
|
| +
|
| + /// The top level pages for the documentation set.
|
| core.List<Page> pages;
|
| - /**
|
| - * A list of documentation rules that apply to individual API elements.
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| +
|
| + /// A list of documentation rules that apply to individual API elements.
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<DocumentationRule> rules;
|
| - /**
|
| - * A short summary of what the service does. Can only be provided by
|
| - * plain text.
|
| - */
|
| +
|
| + /// A short summary of what the service does. Can only be provided by
|
| + /// plain text.
|
| core.String summary;
|
|
|
| Documentation();
|
| @@ -1229,7 +1202,9 @@ class Documentation {
|
| pages = _json["pages"].map((value) => new Page.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new DocumentationRule.fromJson(value)).toList();
|
| + rules = _json["rules"]
|
| + .map((value) => new DocumentationRule.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("summary")) {
|
| summary = _json["summary"];
|
| @@ -1237,7 +1212,8 @@ class Documentation {
|
| }
|
|
|
| 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 (documentationRootUrl != null) {
|
| _json["documentationRootUrl"] = documentationRootUrl;
|
| }
|
| @@ -1257,24 +1233,23 @@ class Documentation {
|
| }
|
| }
|
|
|
| -/** A documentation rule provides information about individual API elements. */
|
| +/// A documentation rule provides information about individual API elements.
|
| class DocumentationRule {
|
| - /**
|
| - * Deprecation description of the selected element(s). It can be provided if
|
| - * an
|
| - * element is marked as `deprecated`.
|
| - */
|
| + /// Deprecation description of the selected element(s). It can be provided if
|
| + /// an
|
| + /// element is marked as `deprecated`.
|
| core.String deprecationDescription;
|
| - /** Description of the selected API(s). */
|
| +
|
| + /// Description of the selected API(s).
|
| core.String description;
|
| - /**
|
| - * The selector is a comma-separated list of patterns. Each pattern is a
|
| - * qualified name of the element which may end in "*", indicating a wildcard.
|
| - * Wildcards are only allowed at the end and for a whole component of the
|
| - * qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
|
| - * specify a default for all applicable elements, the whole pattern "*"
|
| - * is used.
|
| - */
|
| +
|
| + /// The selector is a comma-separated list of patterns. Each pattern is a
|
| + /// qualified name of the element which may end in "*", indicating a
|
| + /// wildcard.
|
| + /// Wildcards are only allowed at the end and for a whole component of the
|
| + /// qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". To
|
| + /// specify a default for all applicable elements, the whole pattern "*"
|
| + /// is used.
|
| core.String selector;
|
|
|
| DocumentationRule();
|
| @@ -1292,7 +1267,8 @@ class DocumentationRule {
|
| }
|
|
|
| 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 (deprecationDescription != null) {
|
| _json["deprecationDescription"] = deprecationDescription;
|
| }
|
| @@ -1306,74 +1282,72 @@ class DocumentationRule {
|
| }
|
| }
|
|
|
| -/** Request message for EnableService method. */
|
| +/// Request message for EnableService method.
|
| class EnableServiceRequest {
|
| -
|
| EnableServiceRequest();
|
|
|
| - EnableServiceRequest.fromJson(core.Map _json) {
|
| - }
|
| + EnableServiceRequest.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;
|
| }
|
| }
|
|
|
| -/**
|
| - * `Endpoint` describes a network endpoint that serves a set of APIs.
|
| - * A service may expose any number of endpoints, and all endpoints share the
|
| - * same service configuration, such as quota configuration and monitoring
|
| - * configuration.
|
| - *
|
| - * Example service configuration:
|
| - *
|
| - * name: library-example.googleapis.com
|
| - * endpoints:
|
| - * # Below entry makes 'google.example.library.v1.Library'
|
| - * # API be served from endpoint address library-example.googleapis.com.
|
| - * # It also allows HTTP OPTIONS calls to be passed to the backend, for
|
| - * # it to decide whether the subsequent cross-origin request is
|
| - * # allowed to proceed.
|
| - * - name: library-example.googleapis.com
|
| - * allow_cors: true
|
| - */
|
| +/// `Endpoint` describes a network endpoint that serves a set of APIs.
|
| +/// A service may expose any number of endpoints, and all endpoints share the
|
| +/// same service configuration, such as quota configuration and monitoring
|
| +/// configuration.
|
| +///
|
| +/// Example service configuration:
|
| +///
|
| +/// name: library-example.googleapis.com
|
| +/// endpoints:
|
| +/// # Below entry makes 'google.example.library.v1.Library'
|
| +/// # API be served from endpoint address library-example.googleapis.com.
|
| +/// # It also allows HTTP OPTIONS calls to be passed to the backend, for
|
| +/// # it to decide whether the subsequent cross-origin request is
|
| +/// # allowed to proceed.
|
| +/// - name: library-example.googleapis.com
|
| +/// allow_cors: true
|
| class Endpoint {
|
| - /**
|
| - * DEPRECATED: This field is no longer supported. Instead of using aliases,
|
| - * please specify multiple google.api.Endpoint for each of the intented
|
| - * alias.
|
| - *
|
| - * Additional names that this endpoint will be hosted on.
|
| - */
|
| + /// DEPRECATED: This field is no longer supported. Instead of using aliases,
|
| + /// please specify multiple google.api.Endpoint for each of the intented
|
| + /// alias.
|
| + ///
|
| + /// Additional names that this endpoint will be hosted on.
|
| core.List<core.String> aliases;
|
| - /**
|
| - * Allowing
|
| - * [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
|
| - * cross-domain traffic, would allow the backends served from this endpoint to
|
| - * receive and respond to HTTP OPTIONS requests. The response will be used by
|
| - * the browser to determine whether the subsequent cross-origin request is
|
| - * allowed to proceed.
|
| - */
|
| +
|
| + /// Allowing
|
| + /// [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka
|
| + /// cross-domain traffic, would allow the backends served from this endpoint
|
| + /// to
|
| + /// receive and respond to HTTP OPTIONS requests. The response will be used
|
| + /// by
|
| + /// the browser to determine whether the subsequent cross-origin request is
|
| + /// allowed to proceed.
|
| core.bool allowCors;
|
| - /**
|
| - * The list of APIs served by this endpoint.
|
| - *
|
| - * If no APIs are specified this translates to "all APIs" exported by the
|
| - * service, as defined in the top-level service configuration.
|
| - */
|
| +
|
| + /// The list of APIs served by this endpoint.
|
| + ///
|
| + /// If no APIs are specified this translates to "all APIs" exported by the
|
| + /// service, as defined in the top-level service configuration.
|
| core.List<core.String> apis;
|
| - /** The list of features enabled on this endpoint. */
|
| +
|
| + /// The list of features enabled on this endpoint.
|
| core.List<core.String> features;
|
| - /** The canonical name of this endpoint. */
|
| +
|
| + /// The canonical name of this endpoint.
|
| core.String name;
|
| - /**
|
| - * The specification of an Internet routable address of API frontend that will
|
| - * handle requests to this [API
|
| - * Endpoint](https://cloud.google.com/apis/design/glossary).
|
| - * It should be either a valid IPv4 address or a fully-qualified domain name.
|
| - * For example, "8.8.8.8" or "myservice.appspot.com".
|
| - */
|
| +
|
| + /// The specification of an Internet routable address of API frontend that
|
| + /// will
|
| + /// handle requests to this [API
|
| + /// Endpoint](https://cloud.google.com/apis/design/glossary).
|
| + /// It should be either a valid IPv4 address or a fully-qualified domain
|
| + /// name.
|
| + /// For example, "8.8.8.8" or "myservice.appspot.com".
|
| core.String target;
|
|
|
| Endpoint();
|
| @@ -1400,7 +1374,8 @@ class Endpoint {
|
| }
|
|
|
| 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 (aliases != null) {
|
| _json["aliases"] = aliases;
|
| }
|
| @@ -1423,35 +1398,40 @@ class Endpoint {
|
| }
|
| }
|
|
|
| -/** Enum type definition. */
|
| +/// Enum type definition.
|
| class Enum {
|
| - /** Enum value definitions. */
|
| + /// Enum value definitions.
|
| core.List<EnumValue> enumvalue;
|
| - /** Enum type name. */
|
| +
|
| + /// Enum type name.
|
| core.String name;
|
| - /** Protocol buffer options. */
|
| +
|
| + /// Protocol buffer options.
|
| core.List<Option> options;
|
| - /** The source context. */
|
| +
|
| + /// The source context.
|
| SourceContext sourceContext;
|
| - /**
|
| - * The source syntax.
|
| - * Possible string values are:
|
| - * - "SYNTAX_PROTO2" : Syntax `proto2`.
|
| - * - "SYNTAX_PROTO3" : Syntax `proto3`.
|
| - */
|
| +
|
| + /// The source syntax.
|
| + /// Possible string values are:
|
| + /// - "SYNTAX_PROTO2" : Syntax `proto2`.
|
| + /// - "SYNTAX_PROTO3" : Syntax `proto3`.
|
| core.String syntax;
|
|
|
| Enum();
|
|
|
| Enum.fromJson(core.Map _json) {
|
| if (_json.containsKey("enumvalue")) {
|
| - enumvalue = _json["enumvalue"].map((value) => new EnumValue.fromJson(value)).toList();
|
| + enumvalue = _json["enumvalue"]
|
| + .map((value) => new EnumValue.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("name")) {
|
| name = _json["name"];
|
| }
|
| if (_json.containsKey("options")) {
|
| - options = _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| + options =
|
| + _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("sourceContext")) {
|
| sourceContext = new SourceContext.fromJson(_json["sourceContext"]);
|
| @@ -1462,7 +1442,8 @@ class Enum {
|
| }
|
|
|
| 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 (enumvalue != null) {
|
| _json["enumvalue"] = enumvalue.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -1482,13 +1463,15 @@ class Enum {
|
| }
|
| }
|
|
|
| -/** Enum value definition. */
|
| +/// Enum value definition.
|
| class EnumValue {
|
| - /** Enum value name. */
|
| + /// Enum value name.
|
| core.String name;
|
| - /** Enum value number. */
|
| +
|
| + /// Enum value number.
|
| core.int number;
|
| - /** Protocol buffer options. */
|
| +
|
| + /// Protocol buffer options.
|
| core.List<Option> options;
|
|
|
| EnumValue();
|
| @@ -1501,12 +1484,14 @@ class EnumValue {
|
| number = _json["number"];
|
| }
|
| if (_json.containsKey("options")) {
|
| - options = _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| + options =
|
| + _json["options"].map((value) => new Option.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 (name != null) {
|
| _json["name"] = name;
|
| }
|
| @@ -1520,12 +1505,10 @@ class EnumValue {
|
| }
|
| }
|
|
|
| -/**
|
| - * Experimental service configuration. These configuration options can
|
| - * only be used by whitelisted users.
|
| - */
|
| +/// Experimental service configuration. These configuration options can
|
| +/// only be used by whitelisted users.
|
| class Experimental {
|
| - /** Authorization configuration. */
|
| + /// Authorization configuration.
|
| AuthorizationConfig authorization;
|
|
|
| Experimental();
|
| @@ -1537,7 +1520,8 @@ class Experimental {
|
| }
|
|
|
| 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 (authorization != null) {
|
| _json["authorization"] = (authorization).toJson();
|
| }
|
| @@ -1545,64 +1529,64 @@ class Experimental {
|
| }
|
| }
|
|
|
| -/** A single field of a message type. */
|
| +/// A single field of a message type.
|
| class Field {
|
| - /**
|
| - * The field cardinality.
|
| - * Possible string values are:
|
| - * - "CARDINALITY_UNKNOWN" : For fields with unknown cardinality.
|
| - * - "CARDINALITY_OPTIONAL" : For optional fields.
|
| - * - "CARDINALITY_REQUIRED" : For required fields. Proto2 syntax only.
|
| - * - "CARDINALITY_REPEATED" : For repeated fields.
|
| - */
|
| + /// The field cardinality.
|
| + /// Possible string values are:
|
| + /// - "CARDINALITY_UNKNOWN" : For fields with unknown cardinality.
|
| + /// - "CARDINALITY_OPTIONAL" : For optional fields.
|
| + /// - "CARDINALITY_REQUIRED" : For required fields. Proto2 syntax only.
|
| + /// - "CARDINALITY_REPEATED" : For repeated fields.
|
| core.String cardinality;
|
| - /**
|
| - * The string value of the default value of this field. Proto2 syntax only.
|
| - */
|
| +
|
| + /// The string value of the default value of this field. Proto2 syntax only.
|
| core.String defaultValue;
|
| - /** The field JSON name. */
|
| +
|
| + /// The field JSON name.
|
| core.String jsonName;
|
| - /**
|
| - * The field type.
|
| - * Possible string values are:
|
| - * - "TYPE_UNKNOWN" : Field type unknown.
|
| - * - "TYPE_DOUBLE" : Field type double.
|
| - * - "TYPE_FLOAT" : Field type float.
|
| - * - "TYPE_INT64" : Field type int64.
|
| - * - "TYPE_UINT64" : Field type uint64.
|
| - * - "TYPE_INT32" : Field type int32.
|
| - * - "TYPE_FIXED64" : Field type fixed64.
|
| - * - "TYPE_FIXED32" : Field type fixed32.
|
| - * - "TYPE_BOOL" : Field type bool.
|
| - * - "TYPE_STRING" : Field type string.
|
| - * - "TYPE_GROUP" : Field type group. Proto2 syntax only, and deprecated.
|
| - * - "TYPE_MESSAGE" : Field type message.
|
| - * - "TYPE_BYTES" : Field type bytes.
|
| - * - "TYPE_UINT32" : Field type uint32.
|
| - * - "TYPE_ENUM" : Field type enum.
|
| - * - "TYPE_SFIXED32" : Field type sfixed32.
|
| - * - "TYPE_SFIXED64" : Field type sfixed64.
|
| - * - "TYPE_SINT32" : Field type sint32.
|
| - * - "TYPE_SINT64" : Field type sint64.
|
| - */
|
| +
|
| + /// The field type.
|
| + /// Possible string values are:
|
| + /// - "TYPE_UNKNOWN" : Field type unknown.
|
| + /// - "TYPE_DOUBLE" : Field type double.
|
| + /// - "TYPE_FLOAT" : Field type float.
|
| + /// - "TYPE_INT64" : Field type int64.
|
| + /// - "TYPE_UINT64" : Field type uint64.
|
| + /// - "TYPE_INT32" : Field type int32.
|
| + /// - "TYPE_FIXED64" : Field type fixed64.
|
| + /// - "TYPE_FIXED32" : Field type fixed32.
|
| + /// - "TYPE_BOOL" : Field type bool.
|
| + /// - "TYPE_STRING" : Field type string.
|
| + /// - "TYPE_GROUP" : Field type group. Proto2 syntax only, and deprecated.
|
| + /// - "TYPE_MESSAGE" : Field type message.
|
| + /// - "TYPE_BYTES" : Field type bytes.
|
| + /// - "TYPE_UINT32" : Field type uint32.
|
| + /// - "TYPE_ENUM" : Field type enum.
|
| + /// - "TYPE_SFIXED32" : Field type sfixed32.
|
| + /// - "TYPE_SFIXED64" : Field type sfixed64.
|
| + /// - "TYPE_SINT32" : Field type sint32.
|
| + /// - "TYPE_SINT64" : Field type sint64.
|
| core.String kind;
|
| - /** The field name. */
|
| +
|
| + /// The field name.
|
| core.String name;
|
| - /** The field number. */
|
| +
|
| + /// The field number.
|
| core.int number;
|
| - /**
|
| - * The index of the field type in `Type.oneofs`, for message or enumeration
|
| - * types. The first type has index 1; zero means the type is not in the list.
|
| - */
|
| +
|
| + /// The index of the field type in `Type.oneofs`, for message or enumeration
|
| + /// types. The first type has index 1; zero means the type is not in the
|
| + /// list.
|
| core.int oneofIndex;
|
| - /** The protocol buffer options. */
|
| +
|
| + /// The protocol buffer options.
|
| core.List<Option> options;
|
| - /** Whether to use alternative packed wire representation. */
|
| +
|
| + /// Whether to use alternative packed wire representation.
|
| core.bool packed;
|
| - /**
|
| - * The field type URL, without the scheme, for message or enumeration
|
| - * types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
| - */
|
| +
|
| + /// The field type URL, without the scheme, for message or enumeration
|
| + /// types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`.
|
| core.String typeUrl;
|
|
|
| Field();
|
| @@ -1630,7 +1614,8 @@ class Field {
|
| oneofIndex = _json["oneofIndex"];
|
| }
|
| if (_json.containsKey("options")) {
|
| - options = _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| + options =
|
| + _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("packed")) {
|
| packed = _json["packed"];
|
| @@ -1641,7 +1626,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 (cardinality != null) {
|
| _json["cardinality"] = cardinality;
|
| }
|
| @@ -1676,26 +1662,23 @@ class Field {
|
| }
|
| }
|
|
|
| -/**
|
| - * Defines the HTTP configuration for an API service. It contains a list of
|
| - * HttpRule, each specifying the mapping of an RPC method
|
| - * to one or more HTTP REST API methods.
|
| - */
|
| +/// Defines the HTTP configuration for an API service. It contains a list of
|
| +/// HttpRule, each specifying the mapping of an RPC method
|
| +/// to one or more HTTP REST API methods.
|
| class Http {
|
| - /**
|
| - * When set to true, URL path parmeters will be fully URI-decoded except in
|
| - * cases of single segment matches in reserved expansion, where "%2F" will be
|
| - * left encoded.
|
| - *
|
| - * The default behavior is to not decode RFC 6570 reserved characters in multi
|
| - * segment matches.
|
| - */
|
| + /// When set to true, URL path parmeters will be fully URI-decoded except in
|
| + /// cases of single segment matches in reserved expansion, where "%2F" will
|
| + /// be
|
| + /// left encoded.
|
| + ///
|
| + /// The default behavior is to not decode RFC 6570 reserved characters in
|
| + /// multi
|
| + /// segment matches.
|
| core.bool fullyDecodeReservedExpansion;
|
| - /**
|
| - * A list of HTTP configuration rules that apply to individual API methods.
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| +
|
| + /// A list of HTTP configuration rules that apply to individual API methods.
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<HttpRule> rules;
|
|
|
| Http();
|
| @@ -1705,12 +1688,14 @@ class Http {
|
| fullyDecodeReservedExpansion = _json["fullyDecodeReservedExpansion"];
|
| }
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new HttpRule.fromJson(value)).toList();
|
| + rules =
|
| + _json["rules"].map((value) => new HttpRule.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 (fullyDecodeReservedExpansion != null) {
|
| _json["fullyDecodeReservedExpansion"] = fullyDecodeReservedExpansion;
|
| }
|
| @@ -1721,347 +1706,349 @@ class Http {
|
| }
|
| }
|
|
|
| -/**
|
| - * `HttpRule` defines the mapping of an RPC method to one or more HTTP
|
| - * REST API methods. The mapping specifies how different portions of the RPC
|
| - * request message are mapped to URL path, URL query parameters, and
|
| - * HTTP request body. The mapping is typically specified as an
|
| - * `google.api.http` annotation on the RPC method,
|
| - * see "google/api/annotations.proto" for details.
|
| - *
|
| - * The mapping consists of a field specifying the path template and
|
| - * method kind. The path template can refer to fields in the request
|
| - * message, as in the example below which describes a REST GET
|
| - * operation on a resource collection of messages:
|
| - *
|
| - *
|
| - * service Messaging {
|
| - * rpc GetMessage(GetMessageRequest) returns (Message) {
|
| - * option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
|
| - * }
|
| - * }
|
| - * message GetMessageRequest {
|
| - * message SubMessage {
|
| - * string subfield = 1;
|
| - * }
|
| - * string message_id = 1; // mapped to the URL
|
| - * SubMessage sub = 2; // `sub.subfield` is url-mapped
|
| - * }
|
| - * message Message {
|
| - * string text = 1; // content of the resource
|
| - * }
|
| - *
|
| - * The same http annotation can alternatively be expressed inside the
|
| - * `GRPC API Configuration` YAML file.
|
| - *
|
| - * http:
|
| - * rules:
|
| - * - selector: <proto_package_name>.Messaging.GetMessage
|
| - * get: /v1/messages/{message_id}/{sub.subfield}
|
| - *
|
| - * This definition enables an automatic, bidrectional mapping of HTTP
|
| - * JSON to RPC. Example:
|
| - *
|
| - * HTTP | RPC
|
| - * -----|-----
|
| - * `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub:
|
| - * SubMessage(subfield: "foo"))`
|
| - *
|
| - * In general, not only fields but also field paths can be referenced
|
| - * from a path pattern. Fields mapped to the path pattern cannot be
|
| - * repeated and must have a primitive (non-message) type.
|
| - *
|
| - * Any fields in the request message which are not bound by the path
|
| - * pattern automatically become (optional) HTTP query
|
| - * parameters. Assume the following definition of the request message:
|
| - *
|
| - *
|
| - * service Messaging {
|
| - * rpc GetMessage(GetMessageRequest) returns (Message) {
|
| - * option (google.api.http).get = "/v1/messages/{message_id}";
|
| - * }
|
| - * }
|
| - * message GetMessageRequest {
|
| - * message SubMessage {
|
| - * string subfield = 1;
|
| - * }
|
| - * string message_id = 1; // mapped to the URL
|
| - * int64 revision = 2; // becomes a parameter
|
| - * SubMessage sub = 3; // `sub.subfield` becomes a parameter
|
| - * }
|
| - *
|
| - *
|
| - * This enables a HTTP JSON to RPC mapping as below:
|
| - *
|
| - * HTTP | RPC
|
| - * -----|-----
|
| - * `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
|
| - * `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
|
| - * "foo"))`
|
| - *
|
| - * Note that fields which are mapped to HTTP parameters must have a
|
| - * primitive type or a repeated primitive type. Message types are not
|
| - * allowed. In the case of a repeated type, the parameter can be
|
| - * repeated in the URL, as in `...?param=A¶m=B`.
|
| - *
|
| - * For HTTP method kinds which allow a request body, the `body` field
|
| - * specifies the mapping. Consider a REST update method on the
|
| - * message resource collection:
|
| - *
|
| - *
|
| - * service Messaging {
|
| - * rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
|
| - * option (google.api.http) = {
|
| - * put: "/v1/messages/{message_id}"
|
| - * body: "message"
|
| - * };
|
| - * }
|
| - * }
|
| - * message UpdateMessageRequest {
|
| - * string message_id = 1; // mapped to the URL
|
| - * Message message = 2; // mapped to the body
|
| - * }
|
| - *
|
| - *
|
| - * The following HTTP JSON to RPC mapping is enabled, where the
|
| - * representation of the JSON in the request body is determined by
|
| - * protos JSON encoding:
|
| - *
|
| - * HTTP | RPC
|
| - * -----|-----
|
| - * `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
|
| - * "123456" message { text: "Hi!" })`
|
| - *
|
| - * The special name `*` can be used in the body mapping to define that
|
| - * every field not bound by the path template should be mapped to the
|
| - * request body. This enables the following alternative definition of
|
| - * the update method:
|
| - *
|
| - * service Messaging {
|
| - * rpc UpdateMessage(Message) returns (Message) {
|
| - * option (google.api.http) = {
|
| - * put: "/v1/messages/{message_id}"
|
| - * body: "*"
|
| - * };
|
| - * }
|
| - * }
|
| - * message Message {
|
| - * string message_id = 1;
|
| - * string text = 2;
|
| - * }
|
| - *
|
| - *
|
| - * The following HTTP JSON to RPC mapping is enabled:
|
| - *
|
| - * HTTP | RPC
|
| - * -----|-----
|
| - * `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
|
| - * "123456" text: "Hi!")`
|
| - *
|
| - * Note that when using `*` in the body mapping, it is not possible to
|
| - * have HTTP parameters, as all fields not bound by the path end in
|
| - * the body. This makes this option more rarely used in practice of
|
| - * defining REST APIs. The common usage of `*` is in custom methods
|
| - * which don't use the URL at all for transferring data.
|
| - *
|
| - * It is possible to define multiple HTTP methods for one RPC by using
|
| - * the `additional_bindings` option. Example:
|
| - *
|
| - * service Messaging {
|
| - * rpc GetMessage(GetMessageRequest) returns (Message) {
|
| - * option (google.api.http) = {
|
| - * get: "/v1/messages/{message_id}"
|
| - * additional_bindings {
|
| - * get: "/v1/users/{user_id}/messages/{message_id}"
|
| - * }
|
| - * };
|
| - * }
|
| - * }
|
| - * message GetMessageRequest {
|
| - * string message_id = 1;
|
| - * string user_id = 2;
|
| - * }
|
| - *
|
| - *
|
| - * This enables the following two alternative HTTP JSON to RPC
|
| - * mappings:
|
| - *
|
| - * HTTP | RPC
|
| - * -----|-----
|
| - * `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
|
| - * `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
|
| - * "123456")`
|
| - *
|
| - * # Rules for HTTP mapping
|
| - *
|
| - * The rules for mapping HTTP path, query parameters, and body fields
|
| - * to the request message are as follows:
|
| - *
|
| - * 1. The `body` field specifies either `*` or a field path, or is
|
| - * omitted. If omitted, it indicates there is no HTTP request body.
|
| - * 2. Leaf fields (recursive expansion of nested messages in the
|
| - * request) can be classified into three types:
|
| - * (a) Matched in the URL template.
|
| - * (b) Covered by body (if body is `*`, everything except (a) fields;
|
| - * else everything under the body field)
|
| - * (c) All other fields.
|
| - * 3. URL query parameters found in the HTTP request are mapped to (c) fields.
|
| - * 4. Any body sent with an HTTP request can contain only (b) fields.
|
| - *
|
| - * The syntax of the path template is as follows:
|
| - *
|
| - * Template = "/" Segments [ Verb ] ;
|
| - * Segments = Segment { "/" Segment } ;
|
| - * Segment = "*" | "**" | LITERAL | Variable ;
|
| - * Variable = "{" FieldPath [ "=" Segments ] "}" ;
|
| - * FieldPath = IDENT { "." IDENT } ;
|
| - * Verb = ":" LITERAL ;
|
| - *
|
| - * The syntax `*` matches a single path segment. The syntax `**` matches zero
|
| - * or more path segments, which must be the last part of the path except the
|
| - * `Verb`. The syntax `LITERAL` matches literal text in the path.
|
| - *
|
| - * The syntax `Variable` matches part of the URL path as specified by its
|
| - * template. A variable template must not contain other variables. If a variable
|
| - * matches a single path segment, its template may be omitted, e.g. `{var}`
|
| - * is equivalent to `{var=*}`.
|
| - *
|
| - * If a variable contains exactly one path segment, such as `"{var}"` or
|
| - * `"{var=*}"`, when such a variable is expanded into a URL path, all characters
|
| - * except `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the
|
| - * Discovery Document as `{var}`.
|
| - *
|
| - * If a variable contains one or more path segments, such as `"{var=foo / * }"`
|
| - * or `"{var=**}"`, when such a variable is expanded into a URL path, all
|
| - * characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables
|
| - * show up in the Discovery Document as `{+var}`.
|
| - *
|
| - * NOTE: While the single segment variable matches the semantics of
|
| - * [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2
|
| - * Simple String Expansion, the multi segment variable **does not** match
|
| - * RFC 6570 Reserved Expansion. The reason is that the Reserved Expansion
|
| - * does not expand special characters like `?` and `#`, which would lead
|
| - * to invalid URLs.
|
| - *
|
| - * NOTE: the field paths in variables and in the `body` must not refer to
|
| - * repeated fields or map fields.
|
| - */
|
| +/// `HttpRule` defines the mapping of an RPC method to one or more HTTP
|
| +/// REST API methods. The mapping specifies how different portions of the RPC
|
| +/// request message are mapped to URL path, URL query parameters, and
|
| +/// HTTP request body. The mapping is typically specified as an
|
| +/// `google.api.http` annotation on the RPC method,
|
| +/// see "google/api/annotations.proto" for details.
|
| +///
|
| +/// The mapping consists of a field specifying the path template and
|
| +/// method kind. The path template can refer to fields in the request
|
| +/// message, as in the example below which describes a REST GET
|
| +/// operation on a resource collection of messages:
|
| +///
|
| +///
|
| +/// service Messaging {
|
| +/// rpc GetMessage(GetMessageRequest) returns (Message) {
|
| +/// option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
|
| +/// }
|
| +/// }
|
| +/// message GetMessageRequest {
|
| +/// message SubMessage {
|
| +/// string subfield = 1;
|
| +/// }
|
| +/// string message_id = 1; // mapped to the URL
|
| +/// SubMessage sub = 2; // `sub.subfield` is url-mapped
|
| +/// }
|
| +/// message Message {
|
| +/// string text = 1; // content of the resource
|
| +/// }
|
| +///
|
| +/// The same http annotation can alternatively be expressed inside the
|
| +/// `GRPC API Configuration` YAML file.
|
| +///
|
| +/// http:
|
| +/// rules:
|
| +/// - selector: <proto_package_name>.Messaging.GetMessage
|
| +/// get: /v1/messages/{message_id}/{sub.subfield}
|
| +///
|
| +/// This definition enables an automatic, bidrectional mapping of HTTP
|
| +/// JSON to RPC. Example:
|
| +///
|
| +/// HTTP | RPC
|
| +/// -----|-----
|
| +/// `GET /v1/messages/123456/foo` | `GetMessage(message_id: "123456" sub:
|
| +/// SubMessage(subfield: "foo"))`
|
| +///
|
| +/// In general, not only fields but also field paths can be referenced
|
| +/// from a path pattern. Fields mapped to the path pattern cannot be
|
| +/// repeated and must have a primitive (non-message) type.
|
| +///
|
| +/// Any fields in the request message which are not bound by the path
|
| +/// pattern automatically become (optional) HTTP query
|
| +/// parameters. Assume the following definition of the request message:
|
| +///
|
| +///
|
| +/// service Messaging {
|
| +/// rpc GetMessage(GetMessageRequest) returns (Message) {
|
| +/// option (google.api.http).get = "/v1/messages/{message_id}";
|
| +/// }
|
| +/// }
|
| +/// message GetMessageRequest {
|
| +/// message SubMessage {
|
| +/// string subfield = 1;
|
| +/// }
|
| +/// string message_id = 1; // mapped to the URL
|
| +/// int64 revision = 2; // becomes a parameter
|
| +/// SubMessage sub = 3; // `sub.subfield` becomes a parameter
|
| +/// }
|
| +///
|
| +///
|
| +/// This enables a HTTP JSON to RPC mapping as below:
|
| +///
|
| +/// HTTP | RPC
|
| +/// -----|-----
|
| +/// `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
|
| +/// `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
|
| +/// "foo"))`
|
| +///
|
| +/// Note that fields which are mapped to HTTP parameters must have a
|
| +/// primitive type or a repeated primitive type. Message types are not
|
| +/// allowed. In the case of a repeated type, the parameter can be
|
| +/// repeated in the URL, as in `...?param=A¶m=B`.
|
| +///
|
| +/// For HTTP method kinds which allow a request body, the `body` field
|
| +/// specifies the mapping. Consider a REST update method on the
|
| +/// message resource collection:
|
| +///
|
| +///
|
| +/// service Messaging {
|
| +/// rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
|
| +/// option (google.api.http) = {
|
| +/// put: "/v1/messages/{message_id}"
|
| +/// body: "message"
|
| +/// };
|
| +/// }
|
| +/// }
|
| +/// message UpdateMessageRequest {
|
| +/// string message_id = 1; // mapped to the URL
|
| +/// Message message = 2; // mapped to the body
|
| +/// }
|
| +///
|
| +///
|
| +/// The following HTTP JSON to RPC mapping is enabled, where the
|
| +/// representation of the JSON in the request body is determined by
|
| +/// protos JSON encoding:
|
| +///
|
| +/// HTTP | RPC
|
| +/// -----|-----
|
| +/// `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
|
| +/// "123456" message { text: "Hi!" })`
|
| +///
|
| +/// The special name `*` can be used in the body mapping to define that
|
| +/// every field not bound by the path template should be mapped to the
|
| +/// request body. This enables the following alternative definition of
|
| +/// the update method:
|
| +///
|
| +/// service Messaging {
|
| +/// rpc UpdateMessage(Message) returns (Message) {
|
| +/// option (google.api.http) = {
|
| +/// put: "/v1/messages/{message_id}"
|
| +/// body: "*"
|
| +/// };
|
| +/// }
|
| +/// }
|
| +/// message Message {
|
| +/// string message_id = 1;
|
| +/// string text = 2;
|
| +/// }
|
| +///
|
| +///
|
| +/// The following HTTP JSON to RPC mapping is enabled:
|
| +///
|
| +/// HTTP | RPC
|
| +/// -----|-----
|
| +/// `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
|
| +/// "123456" text: "Hi!")`
|
| +///
|
| +/// Note that when using `*` in the body mapping, it is not possible to
|
| +/// have HTTP parameters, as all fields not bound by the path end in
|
| +/// the body. This makes this option more rarely used in practice of
|
| +/// defining REST APIs. The common usage of `*` is in custom methods
|
| +/// which don't use the URL at all for transferring data.
|
| +///
|
| +/// It is possible to define multiple HTTP methods for one RPC by using
|
| +/// the `additional_bindings` option. Example:
|
| +///
|
| +/// service Messaging {
|
| +/// rpc GetMessage(GetMessageRequest) returns (Message) {
|
| +/// option (google.api.http) = {
|
| +/// get: "/v1/messages/{message_id}"
|
| +/// additional_bindings {
|
| +/// get: "/v1/users/{user_id}/messages/{message_id}"
|
| +/// }
|
| +/// };
|
| +/// }
|
| +/// }
|
| +/// message GetMessageRequest {
|
| +/// string message_id = 1;
|
| +/// string user_id = 2;
|
| +/// }
|
| +///
|
| +///
|
| +/// This enables the following two alternative HTTP JSON to RPC
|
| +/// mappings:
|
| +///
|
| +/// HTTP | RPC
|
| +/// -----|-----
|
| +/// `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
|
| +/// `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
|
| +/// "123456")`
|
| +///
|
| +/// # Rules for HTTP mapping
|
| +///
|
| +/// The rules for mapping HTTP path, query parameters, and body fields
|
| +/// to the request message are as follows:
|
| +///
|
| +/// 1. The `body` field specifies either `*` or a field path, or is
|
| +/// omitted. If omitted, it indicates there is no HTTP request body.
|
| +/// 2. Leaf fields (recursive expansion of nested messages in the
|
| +/// request) can be classified into three types:
|
| +/// (a) Matched in the URL template.
|
| +/// (b) Covered by body (if body is `*`, everything except (a) fields;
|
| +/// else everything under the body field)
|
| +/// (c) All other fields.
|
| +/// 3. URL query parameters found in the HTTP request are mapped to (c) fields.
|
| +/// 4. Any body sent with an HTTP request can contain only (b) fields.
|
| +///
|
| +/// The syntax of the path template is as follows:
|
| +///
|
| +/// Template = "/" Segments [ Verb ] ;
|
| +/// Segments = Segment { "/" Segment } ;
|
| +/// Segment = "*" | "**" | LITERAL | Variable ;
|
| +/// Variable = "{" FieldPath [ "=" Segments ] "}" ;
|
| +/// FieldPath = IDENT { "." IDENT } ;
|
| +/// Verb = ":" LITERAL ;
|
| +///
|
| +/// The syntax `*` matches a single path segment. The syntax `**` matches zero
|
| +/// or more path segments, which must be the last part of the path except the
|
| +/// `Verb`. The syntax `LITERAL` matches literal text in the path.
|
| +///
|
| +/// The syntax `Variable` matches part of the URL path as specified by its
|
| +/// template. A variable template must not contain other variables. If a
|
| +/// variable
|
| +/// matches a single path segment, its template may be omitted, e.g. `{var}`
|
| +/// is equivalent to `{var=*}`.
|
| +///
|
| +/// If a variable contains exactly one path segment, such as `"{var}"` or
|
| +/// `"{var=*}"`, when such a variable is expanded into a URL path, all
|
| +/// characters
|
| +/// except `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the
|
| +/// Discovery Document as `{var}`.
|
| +///
|
| +/// If a variable contains one or more path segments, such as `"{var=foo / *
|
| +/// }"`
|
| +/// or `"{var=**}"`, when such a variable is expanded into a URL path, all
|
| +/// characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables
|
| +/// show up in the Discovery Document as `{+var}`.
|
| +///
|
| +/// NOTE: While the single segment variable matches the semantics of
|
| +/// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2
|
| +/// Simple String Expansion, the multi segment variable **does not** match
|
| +/// RFC 6570 Reserved Expansion. The reason is that the Reserved Expansion
|
| +/// does not expand special characters like `?` and `#`, which would lead
|
| +/// to invalid URLs.
|
| +///
|
| +/// NOTE: the field paths in variables and in the `body` must not refer to
|
| +/// repeated fields or map fields.
|
| class HttpRule {
|
| - /**
|
| - * Additional HTTP bindings for the selector. Nested bindings must
|
| - * not contain an `additional_bindings` field themselves (that is,
|
| - * the nesting may only be one level deep).
|
| - */
|
| + /// Additional HTTP bindings for the selector. Nested bindings must
|
| + /// not contain an `additional_bindings` field themselves (that is,
|
| + /// the nesting may only be one level deep).
|
| core.List<HttpRule> additionalBindings;
|
| - /**
|
| - * Specifies the permission(s) required for an API element for the overall
|
| - * API request to succeed. It is typically used to mark request message fields
|
| - * that contain the name of the resource and indicates the permissions that
|
| - * will be checked on that resource.
|
| - */
|
| +
|
| + /// Specifies the permission(s) required for an API element for the overall
|
| + /// API request to succeed. It is typically used to mark request message
|
| + /// fields
|
| + /// that contain the name of the resource and indicates the permissions that
|
| + /// will be checked on that resource.
|
| core.List<AuthorizationRule> authorizations;
|
| - /**
|
| - * The name of the request field whose value is mapped to the HTTP body, or
|
| - * `*` for mapping all fields not captured by the path pattern to the HTTP
|
| - * body. NOTE: the referred field must not be a repeated field and must be
|
| - * present at the top-level of request message type.
|
| - */
|
| +
|
| + /// The name of the request field whose value is mapped to the HTTP body, or
|
| + /// `*` for mapping all fields not captured by the path pattern to the HTTP
|
| + /// body. NOTE: the referred field must not be a repeated field and must be
|
| + /// present at the top-level of request message type.
|
| core.String body;
|
| - /**
|
| - * The custom pattern is used for specifying an HTTP method that is not
|
| - * included in the `pattern` field, such as HEAD, or "*" to leave the
|
| - * HTTP method unspecified for this rule. The wild-card rule is useful
|
| - * for services that provide content to Web (HTML) clients.
|
| - */
|
| +
|
| + /// The custom pattern is used for specifying an HTTP method that is not
|
| + /// included in the `pattern` field, such as HEAD, or "*" to leave the
|
| + /// HTTP method unspecified for this rule. The wild-card rule is useful
|
| + /// for services that provide content to Web (HTML) clients.
|
| CustomHttpPattern custom;
|
| - /** Used for deleting a resource. */
|
| +
|
| + /// Used for deleting a resource.
|
| core.String delete;
|
| - /** Used for listing and getting information about resources. */
|
| +
|
| + /// Used for listing and getting information about resources.
|
| core.String get;
|
| - /**
|
| - * Use this only for Scotty Requests. Do not use this for bytestream methods.
|
| - * For media support, add instead [][google.bytestream.RestByteStream] as an
|
| - * API to your configuration.
|
| - */
|
| +
|
| + /// Use this only for Scotty Requests. Do not use this for bytestream
|
| + /// methods.
|
| + /// For media support, add instead [][google.bytestream.RestByteStream] as an
|
| + /// API to your configuration.
|
| MediaDownload mediaDownload;
|
| - /**
|
| - * Use this only for Scotty Requests. Do not use this for media support using
|
| - * Bytestream, add instead
|
| - * [][google.bytestream.RestByteStream] as an API to your
|
| - * configuration for Bytestream methods.
|
| - */
|
| +
|
| + /// Use this only for Scotty Requests. Do not use this for media support
|
| + /// using
|
| + /// Bytestream, add instead
|
| + /// [][google.bytestream.RestByteStream] as an API to your
|
| + /// configuration for Bytestream methods.
|
| MediaUpload mediaUpload;
|
| - /** Used for updating a resource. */
|
| +
|
| + /// Used for updating a resource.
|
| core.String patch;
|
| - /** Used for creating a resource. */
|
| +
|
| + /// Used for creating a resource.
|
| core.String post;
|
| - /** Used for updating a resource. */
|
| +
|
| + /// Used for updating a resource.
|
| core.String put;
|
| - /**
|
| - * The name of the response field whose value is mapped to the HTTP body of
|
| - * response. Other response fields are ignored. This field is optional. When
|
| - * not set, the response message will be used as HTTP body of response.
|
| - * NOTE: the referred field must be not a repeated field and must be present
|
| - * at the top-level of response message type.
|
| - */
|
| +
|
| + /// The name of the response field whose value is mapped to the HTTP body of
|
| + /// response. Other response fields are ignored. This field is optional. When
|
| + /// not set, the response message will be used as HTTP body of response.
|
| + /// NOTE: the referred field must be not a repeated field and must be present
|
| + /// at the top-level of response message type.
|
| core.String responseBody;
|
| - /**
|
| - * DO NOT USE. This is an experimental field.
|
| - *
|
| - * Optional. The REST collection name is by default derived from the URL
|
| - * pattern. If specified, this field overrides the default collection name.
|
| - * Example:
|
| - *
|
| - * rpc AddressesAggregatedList(AddressesAggregatedListRequest)
|
| - * returns (AddressesAggregatedListResponse) {
|
| - * option (google.api.http) = {
|
| - * get: "/v1/projects/{project_id}/aggregated/addresses"
|
| - * rest_collection: "projects.addresses"
|
| - * };
|
| - * }
|
| - *
|
| - * This method has the automatically derived collection name
|
| - * "projects.aggregated". Because, semantically, this rpc is actually an
|
| - * operation on the "projects.addresses" collection, the `rest_collection`
|
| - * field is configured to override the derived collection name.
|
| - */
|
| +
|
| + /// DO NOT USE. This is an experimental field.
|
| + ///
|
| + /// Optional. The REST collection name is by default derived from the URL
|
| + /// pattern. If specified, this field overrides the default collection name.
|
| + /// Example:
|
| + ///
|
| + /// rpc AddressesAggregatedList(AddressesAggregatedListRequest)
|
| + /// returns (AddressesAggregatedListResponse) {
|
| + /// option (google.api.http) = {
|
| + /// get: "/v1/projects/{project_id}/aggregated/addresses"
|
| + /// rest_collection: "projects.addresses"
|
| + /// };
|
| + /// }
|
| + ///
|
| + /// This method has the automatically derived collection name
|
| + /// "projects.aggregated". Because, semantically, this rpc is actually an
|
| + /// operation on the "projects.addresses" collection, the `rest_collection`
|
| + /// field is configured to override the derived collection name.
|
| core.String restCollection;
|
| - /**
|
| - * DO NOT USE. This is an experimental field.
|
| - *
|
| - * Optional. The rest method name is by default derived from the URL
|
| - * pattern. If specified, this field overrides the default method name.
|
| - * Example:
|
| - *
|
| - * rpc CreateResource(CreateResourceRequest)
|
| - * returns (CreateResourceResponse) {
|
| - * option (google.api.http) = {
|
| - * post: "/v1/resources",
|
| - * body: "resource",
|
| - * rest_method_name: "insert"
|
| - * };
|
| - * }
|
| - *
|
| - * This method has the automatically derived rest method name
|
| - * "create", but for backwards compatibility with apiary, it is specified as
|
| - * insert.
|
| - */
|
| +
|
| + /// DO NOT USE. This is an experimental field.
|
| + ///
|
| + /// Optional. The rest method name is by default derived from the URL
|
| + /// pattern. If specified, this field overrides the default method name.
|
| + /// Example:
|
| + ///
|
| + /// rpc CreateResource(CreateResourceRequest)
|
| + /// returns (CreateResourceResponse) {
|
| + /// option (google.api.http) = {
|
| + /// post: "/v1/resources",
|
| + /// body: "resource",
|
| + /// rest_method_name: "insert"
|
| + /// };
|
| + /// }
|
| + ///
|
| + /// This method has the automatically derived rest method name
|
| + /// "create", but for backwards compatibility with apiary, it is specified as
|
| + /// insert.
|
| core.String restMethodName;
|
| - /**
|
| - * Selects methods to which this rule applies.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects methods to which this rule applies.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| HttpRule();
|
|
|
| HttpRule.fromJson(core.Map _json) {
|
| if (_json.containsKey("additionalBindings")) {
|
| - additionalBindings = _json["additionalBindings"].map((value) => new HttpRule.fromJson(value)).toList();
|
| + additionalBindings = _json["additionalBindings"]
|
| + .map((value) => new HttpRule.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("authorizations")) {
|
| - authorizations = _json["authorizations"].map((value) => new AuthorizationRule.fromJson(value)).toList();
|
| + authorizations = _json["authorizations"]
|
| + .map((value) => new AuthorizationRule.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("body")) {
|
| body = _json["body"];
|
| @@ -2105,12 +2092,15 @@ class HttpRule {
|
| }
|
|
|
| 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 (additionalBindings != null) {
|
| - _json["additionalBindings"] = additionalBindings.map((value) => (value).toJson()).toList();
|
| + _json["additionalBindings"] =
|
| + additionalBindings.map((value) => (value).toJson()).toList();
|
| }
|
| if (authorizations != null) {
|
| - _json["authorizations"] = authorizations.map((value) => (value).toJson()).toList();
|
| + _json["authorizations"] =
|
| + authorizations.map((value) => (value).toJson()).toList();
|
| }
|
| if (body != null) {
|
| _json["body"] = body;
|
| @@ -2155,19 +2145,19 @@ class HttpRule {
|
| }
|
| }
|
|
|
| -/** A description of a label. */
|
| +/// A description of a label.
|
| class LabelDescriptor {
|
| - /** A human-readable description for the label. */
|
| + /// A human-readable description for the label.
|
| core.String description;
|
| - /** The label key. */
|
| +
|
| + /// The label key.
|
| core.String key;
|
| - /**
|
| - * The type of data that can be assigned to the label.
|
| - * Possible string values are:
|
| - * - "STRING" : A variable-length string. This is the default.
|
| - * - "BOOL" : Boolean; true or false.
|
| - * - "INT64" : A 64-bit signed integer.
|
| - */
|
| +
|
| + /// The type of data that can be assigned to the label.
|
| + /// Possible string values are:
|
| + /// - "STRING" : A variable-length string. This is the default.
|
| + /// - "BOOL" : Boolean; true or false.
|
| + /// - "INT64" : A 64-bit signed integer.
|
| core.String valueType;
|
|
|
| LabelDescriptor();
|
| @@ -2185,7 +2175,8 @@ class LabelDescriptor {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -2199,14 +2190,13 @@ class LabelDescriptor {
|
| }
|
| }
|
|
|
| -/** Response message for `ListEnabledServices` method. */
|
| +/// Response message for `ListEnabledServices` method.
|
| class ListEnabledServicesResponse {
|
| - /**
|
| - * Token that can be passed to `ListEnabledServices` to resume a paginated
|
| - * query.
|
| - */
|
| + /// Token that can be passed to `ListEnabledServices` to resume a paginated
|
| + /// query.
|
| core.String nextPageToken;
|
| - /** Services enabled for the specified parent. */
|
| +
|
| + /// Services enabled for the specified parent.
|
| core.List<PublishedService> services;
|
|
|
| ListEnabledServicesResponse();
|
| @@ -2216,12 +2206,15 @@ class ListEnabledServicesResponse {
|
| nextPageToken = _json["nextPageToken"];
|
| }
|
| if (_json.containsKey("services")) {
|
| - services = _json["services"].map((value) => new PublishedService.fromJson(value)).toList();
|
| + services = _json["services"]
|
| + .map((value) => new PublishedService.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;
|
| }
|
| @@ -2232,39 +2225,32 @@ class ListEnabledServicesResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * A description of a log type. Example in YAML format:
|
| - *
|
| - * - name: library.googleapis.com/activity_history
|
| - * description: The history of borrowing and returning library items.
|
| - * display_name: Activity
|
| - * labels:
|
| - * - key: /customer_id
|
| - * description: Identifier of a library customer
|
| - */
|
| +/// A description of a log type. Example in YAML format:
|
| +///
|
| +/// - name: library.googleapis.com/activity_history
|
| +/// description: The history of borrowing and returning library items.
|
| +/// display_name: Activity
|
| +/// labels:
|
| +/// - key: /customer_id
|
| +/// description: Identifier of a library customer
|
| class LogDescriptor {
|
| - /**
|
| - * A human-readable description of this log. This information appears in
|
| - * the documentation and can contain details.
|
| - */
|
| + /// A human-readable description of this log. This information appears in
|
| + /// the documentation and can contain details.
|
| core.String description;
|
| - /**
|
| - * The human-readable name for this log. This information appears on
|
| - * the user interface and should be concise.
|
| - */
|
| +
|
| + /// The human-readable name for this log. This information appears on
|
| + /// the user interface and should be concise.
|
| core.String displayName;
|
| - /**
|
| - * The set of labels that are available to describe a specific log entry.
|
| - * Runtime requests that contain labels not specified here are
|
| - * considered invalid.
|
| - */
|
| +
|
| + /// The set of labels that are available to describe a specific log entry.
|
| + /// Runtime requests that contain labels not specified here are
|
| + /// considered invalid.
|
| core.List<LabelDescriptor> labels;
|
| - /**
|
| - * The name of the log. It must be less than 512 characters long and can
|
| - * include the following characters: upper- and lower-case alphanumeric
|
| - * characters [A-Za-z0-9], and punctuation characters including
|
| - * slash, underscore, hyphen, period [/_-.].
|
| - */
|
| +
|
| + /// The name of the log. It must be less than 512 characters long and can
|
| + /// include the following characters: upper- and lower-case alphanumeric
|
| + /// characters [A-Za-z0-9], and punctuation characters including
|
| + /// slash, underscore, hyphen, period [/_-.].
|
| core.String name;
|
|
|
| LogDescriptor();
|
| @@ -2277,7 +2263,9 @@ class LogDescriptor {
|
| displayName = _json["displayName"];
|
| }
|
| if (_json.containsKey("labels")) {
|
| - labels = _json["labels"].map((value) => new LabelDescriptor.fromJson(value)).toList();
|
| + labels = _json["labels"]
|
| + .map((value) => new LabelDescriptor.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("name")) {
|
| name = _json["name"];
|
| @@ -2285,7 +2273,8 @@ class LogDescriptor {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -2302,92 +2291,89 @@ class LogDescriptor {
|
| }
|
| }
|
|
|
| -/**
|
| - * Logging configuration of the service.
|
| - *
|
| - * The following example shows how to configure logs to be sent to the
|
| - * producer and consumer projects. In the example, the `activity_history`
|
| - * log is sent to both the producer and consumer projects, whereas the
|
| - * `purchase_history` log is only sent to the producer project.
|
| - *
|
| - * monitored_resources:
|
| - * - type: library.googleapis.com/branch
|
| - * labels:
|
| - * - key: /city
|
| - * description: The city where the library branch is located in.
|
| - * - key: /name
|
| - * description: The name of the branch.
|
| - * logs:
|
| - * - name: activity_history
|
| - * labels:
|
| - * - key: /customer_id
|
| - * - name: purchase_history
|
| - * logging:
|
| - * producer_destinations:
|
| - * - monitored_resource: library.googleapis.com/branch
|
| - * logs:
|
| - * - activity_history
|
| - * - purchase_history
|
| - * consumer_destinations:
|
| - * - monitored_resource: library.googleapis.com/branch
|
| - * logs:
|
| - * - activity_history
|
| - */
|
| +/// Logging configuration of the service.
|
| +///
|
| +/// The following example shows how to configure logs to be sent to the
|
| +/// producer and consumer projects. In the example, the `activity_history`
|
| +/// log is sent to both the producer and consumer projects, whereas the
|
| +/// `purchase_history` log is only sent to the producer project.
|
| +///
|
| +/// monitored_resources:
|
| +/// - type: library.googleapis.com/branch
|
| +/// labels:
|
| +/// - key: /city
|
| +/// description: The city where the library branch is located in.
|
| +/// - key: /name
|
| +/// description: The name of the branch.
|
| +/// logs:
|
| +/// - name: activity_history
|
| +/// labels:
|
| +/// - key: /customer_id
|
| +/// - name: purchase_history
|
| +/// logging:
|
| +/// producer_destinations:
|
| +/// - monitored_resource: library.googleapis.com/branch
|
| +/// logs:
|
| +/// - activity_history
|
| +/// - purchase_history
|
| +/// consumer_destinations:
|
| +/// - monitored_resource: library.googleapis.com/branch
|
| +/// logs:
|
| +/// - activity_history
|
| class Logging {
|
| - /**
|
| - * Logging configurations for sending logs to the consumer project.
|
| - * There can be multiple consumer destinations, each one must have a
|
| - * different monitored resource type. A log can be used in at most
|
| - * one consumer destination.
|
| - */
|
| + /// Logging configurations for sending logs to the consumer project.
|
| + /// There can be multiple consumer destinations, each one must have a
|
| + /// different monitored resource type. A log can be used in at most
|
| + /// one consumer destination.
|
| core.List<LoggingDestination> consumerDestinations;
|
| - /**
|
| - * Logging configurations for sending logs to the producer project.
|
| - * There can be multiple producer destinations, each one must have a
|
| - * different monitored resource type. A log can be used in at most
|
| - * one producer destination.
|
| - */
|
| +
|
| + /// Logging configurations for sending logs to the producer project.
|
| + /// There can be multiple producer destinations, each one must have a
|
| + /// different monitored resource type. A log can be used in at most
|
| + /// one producer destination.
|
| core.List<LoggingDestination> producerDestinations;
|
|
|
| Logging();
|
|
|
| Logging.fromJson(core.Map _json) {
|
| if (_json.containsKey("consumerDestinations")) {
|
| - consumerDestinations = _json["consumerDestinations"].map((value) => new LoggingDestination.fromJson(value)).toList();
|
| + consumerDestinations = _json["consumerDestinations"]
|
| + .map((value) => new LoggingDestination.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("producerDestinations")) {
|
| - producerDestinations = _json["producerDestinations"].map((value) => new LoggingDestination.fromJson(value)).toList();
|
| + producerDestinations = _json["producerDestinations"]
|
| + .map((value) => new LoggingDestination.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 (consumerDestinations != null) {
|
| - _json["consumerDestinations"] = consumerDestinations.map((value) => (value).toJson()).toList();
|
| + _json["consumerDestinations"] =
|
| + consumerDestinations.map((value) => (value).toJson()).toList();
|
| }
|
| if (producerDestinations != null) {
|
| - _json["producerDestinations"] = producerDestinations.map((value) => (value).toJson()).toList();
|
| + _json["producerDestinations"] =
|
| + producerDestinations.map((value) => (value).toJson()).toList();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * Configuration of a specific logging destination (the producer project
|
| - * or the consumer project).
|
| - */
|
| +/// Configuration of a specific logging destination (the producer project
|
| +/// or the consumer project).
|
| class LoggingDestination {
|
| - /**
|
| - * Names of the logs to be sent to this destination. Each name must
|
| - * be defined in the Service.logs section. If the log name is
|
| - * not a domain scoped name, it will be automatically prefixed with
|
| - * the service name followed by "/".
|
| - */
|
| + /// Names of the logs to be sent to this destination. Each name must
|
| + /// be defined in the Service.logs section. If the log name is
|
| + /// not a domain scoped name, it will be automatically prefixed with
|
| + /// the service name followed by "/".
|
| core.List<core.String> logs;
|
| - /**
|
| - * The monitored resource type. The type must be defined in the
|
| - * Service.monitored_resources section.
|
| - */
|
| +
|
| + /// The monitored resource type. The type must be defined in the
|
| + /// Service.monitored_resources section.
|
| core.String monitoredResource;
|
|
|
| LoggingDestination();
|
| @@ -2402,7 +2388,8 @@ class LoggingDestination {
|
| }
|
|
|
| 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 (logs != null) {
|
| _json["logs"] = logs;
|
| }
|
| @@ -2413,37 +2400,32 @@ class LoggingDestination {
|
| }
|
| }
|
|
|
| -/**
|
| - * Defines the Media configuration for a service in case of a download.
|
| - * Use this only for Scotty Requests. Do not use this for media support using
|
| - * Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
|
| - * your configuration for Bytestream methods.
|
| - */
|
| +/// Defines the Media configuration for a service in case of a download.
|
| +/// Use this only for Scotty Requests. Do not use this for media support using
|
| +/// Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
|
| +/// your configuration for Bytestream methods.
|
| class MediaDownload {
|
| - /**
|
| - * A boolean that determines whether a notification for the completion of a
|
| - * download should be sent to the backend.
|
| - */
|
| + /// A boolean that determines whether a notification for the completion of a
|
| + /// download should be sent to the backend.
|
| core.bool completeNotification;
|
| - /**
|
| - * DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
|
| - *
|
| - * Specify name of the download service if one is used for download.
|
| - */
|
| +
|
| + /// DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
|
| + ///
|
| + /// Specify name of the download service if one is used for download.
|
| core.String downloadService;
|
| - /** Name of the Scotty dropzone to use for the current API. */
|
| +
|
| + /// Name of the Scotty dropzone to use for the current API.
|
| core.String dropzone;
|
| - /** Whether download is enabled. */
|
| +
|
| + /// Whether download is enabled.
|
| core.bool enabled;
|
| - /**
|
| - * Optional maximum acceptable size for direct download.
|
| - * The size is specified in bytes.
|
| - */
|
| +
|
| + /// Optional maximum acceptable size for direct download.
|
| + /// The size is specified in bytes.
|
| core.String maxDirectDownloadSize;
|
| - /**
|
| - * A boolean that determines if direct download from ESF should be used for
|
| - * download of this media.
|
| - */
|
| +
|
| + /// A boolean that determines if direct download from ESF should be used for
|
| + /// download of this media.
|
| core.bool useDirectDownload;
|
|
|
| MediaDownload();
|
| @@ -2470,7 +2452,8 @@ class MediaDownload {
|
| }
|
|
|
| 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 (completeNotification != null) {
|
| _json["completeNotification"] = completeNotification;
|
| }
|
| @@ -2493,44 +2476,41 @@ class MediaDownload {
|
| }
|
| }
|
|
|
| -/**
|
| - * Defines the Media configuration for a service in case of an upload.
|
| - * Use this only for Scotty Requests. Do not use this for media support using
|
| - * Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
|
| - * your configuration for Bytestream methods.
|
| - */
|
| +/// Defines the Media configuration for a service in case of an upload.
|
| +/// Use this only for Scotty Requests. Do not use this for media support using
|
| +/// Bytestream, add instead [][google.bytestream.RestByteStream] as an API to
|
| +/// your configuration for Bytestream methods.
|
| class MediaUpload {
|
| - /**
|
| - * A boolean that determines whether a notification for the completion of an
|
| - * upload should be sent to the backend. These notifications will not be seen
|
| - * by the client and will not consume quota.
|
| - */
|
| + /// A boolean that determines whether a notification for the completion of an
|
| + /// upload should be sent to the backend. These notifications will not be
|
| + /// seen
|
| + /// by the client and will not consume quota.
|
| core.bool completeNotification;
|
| - /** Name of the Scotty dropzone to use for the current API. */
|
| +
|
| + /// Name of the Scotty dropzone to use for the current API.
|
| core.String dropzone;
|
| - /** Whether upload is enabled. */
|
| +
|
| + /// Whether upload is enabled.
|
| core.bool enabled;
|
| - /**
|
| - * Optional maximum acceptable size for an upload.
|
| - * The size is specified in bytes.
|
| - */
|
| +
|
| + /// Optional maximum acceptable size for an upload.
|
| + /// The size is specified in bytes.
|
| core.String maxSize;
|
| - /**
|
| - * An array of mimetype patterns. Esf will only accept uploads that match one
|
| - * of the given patterns.
|
| - */
|
| +
|
| + /// An array of mimetype patterns. Esf will only accept uploads that match
|
| + /// one
|
| + /// of the given patterns.
|
| core.List<core.String> mimeTypes;
|
| - /**
|
| - * Whether to receive a notification for progress changes of media upload.
|
| - */
|
| +
|
| + /// Whether to receive a notification for progress changes of media upload.
|
| core.bool progressNotification;
|
| - /** Whether to receive a notification on the start of media upload. */
|
| +
|
| + /// Whether to receive a notification on the start of media upload.
|
| core.bool startNotification;
|
| - /**
|
| - * DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
|
| - *
|
| - * Specify name of the upload service if one is used for upload.
|
| - */
|
| +
|
| + /// DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.
|
| + ///
|
| + /// Specify name of the upload service if one is used for upload.
|
| core.String uploadService;
|
|
|
| MediaUpload();
|
| @@ -2563,7 +2543,8 @@ class MediaUpload {
|
| }
|
|
|
| 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 (completeNotification != null) {
|
| _json["completeNotification"] = completeNotification;
|
| }
|
| @@ -2592,26 +2573,30 @@ class MediaUpload {
|
| }
|
| }
|
|
|
| -/** Method represents a method of an API interface. */
|
| +/// Method represents a method of an API interface.
|
| class Method {
|
| - /** The simple name of this method. */
|
| + /// The simple name of this method.
|
| core.String name;
|
| - /** Any metadata attached to the method. */
|
| +
|
| + /// Any metadata attached to the method.
|
| core.List<Option> options;
|
| - /** If true, the request is streamed. */
|
| +
|
| + /// If true, the request is streamed.
|
| core.bool requestStreaming;
|
| - /** A URL of the input message type. */
|
| +
|
| + /// A URL of the input message type.
|
| core.String requestTypeUrl;
|
| - /** If true, the response is streamed. */
|
| +
|
| + /// If true, the response is streamed.
|
| core.bool responseStreaming;
|
| - /** The URL of the output message type. */
|
| +
|
| + /// The URL of the output message type.
|
| core.String responseTypeUrl;
|
| - /**
|
| - * The source syntax of this method.
|
| - * Possible string values are:
|
| - * - "SYNTAX_PROTO2" : Syntax `proto2`.
|
| - * - "SYNTAX_PROTO3" : Syntax `proto3`.
|
| - */
|
| +
|
| + /// The source syntax of this method.
|
| + /// Possible string values are:
|
| + /// - "SYNTAX_PROTO2" : Syntax `proto2`.
|
| + /// - "SYNTAX_PROTO3" : Syntax `proto3`.
|
| core.String syntax;
|
|
|
| Method();
|
| @@ -2621,7 +2606,8 @@ class Method {
|
| name = _json["name"];
|
| }
|
| if (_json.containsKey("options")) {
|
| - options = _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| + options =
|
| + _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("requestStreaming")) {
|
| requestStreaming = _json["requestStreaming"];
|
| @@ -2641,7 +2627,8 @@ class Method {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -2667,146 +2654,137 @@ class Method {
|
| }
|
| }
|
|
|
| -/**
|
| - * Defines a metric type and its schema. Once a metric descriptor is created,
|
| - * deleting or altering it stops data collection and makes the metric type's
|
| - * existing data unusable.
|
| - */
|
| +/// Defines a metric type and its schema. Once a metric descriptor is created,
|
| +/// deleting or altering it stops data collection and makes the metric type's
|
| +/// existing data unusable.
|
| class MetricDescriptor {
|
| - /**
|
| - * A detailed description of the metric, which can be used in documentation.
|
| - */
|
| + /// A detailed description of the metric, which can be used in documentation.
|
| core.String description;
|
| - /**
|
| - * A concise name for the metric, which can be displayed in user interfaces.
|
| - * Use sentence case without an ending period, for example "Request count".
|
| - */
|
| +
|
| + /// A concise name for the metric, which can be displayed in user interfaces.
|
| + /// Use sentence case without an ending period, for example "Request count".
|
| core.String displayName;
|
| - /**
|
| - * The set of labels that can be used to describe a specific
|
| - * instance of this metric type. For example, the
|
| - * `appengine.googleapis.com/http/server/response_latencies` metric
|
| - * type has a label for the HTTP response code, `response_code`, so
|
| - * you can look at latencies for successful responses or just
|
| - * for responses that failed.
|
| - */
|
| +
|
| + /// The set of labels that can be used to describe a specific
|
| + /// instance of this metric type. For example, the
|
| + /// `appengine.googleapis.com/http/server/response_latencies` metric
|
| + /// type has a label for the HTTP response code, `response_code`, so
|
| + /// you can look at latencies for successful responses or just
|
| + /// for responses that failed.
|
| core.List<LabelDescriptor> labels;
|
| - /**
|
| - * Whether the metric records instantaneous values, changes to a value, etc.
|
| - * Some combinations of `metric_kind` and `value_type` might not be supported.
|
| - * Possible string values are:
|
| - * - "METRIC_KIND_UNSPECIFIED" : Do not use this default value.
|
| - * - "GAUGE" : An instantaneous measurement of a value.
|
| - * - "DELTA" : The change in a value during a time interval.
|
| - * - "CUMULATIVE" : A value accumulated over a time interval. Cumulative
|
| - * measurements in a time series should have the same start time
|
| - * and increasing end times, until an event resets the cumulative
|
| - * value to zero and sets a new start time for the following
|
| - * points.
|
| - */
|
| +
|
| + /// Whether the metric records instantaneous values, changes to a value, etc.
|
| + /// Some combinations of `metric_kind` and `value_type` might not be
|
| + /// supported.
|
| + /// Possible string values are:
|
| + /// - "METRIC_KIND_UNSPECIFIED" : Do not use this default value.
|
| + /// - "GAUGE" : An instantaneous measurement of a value.
|
| + /// - "DELTA" : The change in a value during a time interval.
|
| + /// - "CUMULATIVE" : A value accumulated over a time interval. Cumulative
|
| + /// measurements in a time series should have the same start time
|
| + /// and increasing end times, until an event resets the cumulative
|
| + /// value to zero and sets a new start time for the following
|
| + /// points.
|
| core.String metricKind;
|
| - /**
|
| - * The resource name of the metric descriptor. Depending on the
|
| - * implementation, the name typically includes: (1) the parent resource name
|
| - * that defines the scope of the metric type or of its data; and (2) the
|
| - * metric's URL-encoded type, which also appears in the `type` field of this
|
| - * descriptor. For example, following is the resource name of a custom
|
| - * metric within the GCP project `my-project-id`:
|
| - *
|
| - * "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
|
| - */
|
| +
|
| + /// The resource name of the metric descriptor. Depending on the
|
| + /// implementation, the name typically includes: (1) the parent resource name
|
| + /// that defines the scope of the metric type or of its data; and (2) the
|
| + /// metric's URL-encoded type, which also appears in the `type` field of this
|
| + /// descriptor. For example, following is the resource name of a custom
|
| + /// metric within the GCP project `my-project-id`:
|
| + ///
|
| + /// "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
|
| core.String name;
|
| - /**
|
| - * The metric type, including its DNS name prefix. The type is not
|
| - * URL-encoded. All user-defined custom metric types have the DNS name
|
| - * `custom.googleapis.com`. Metric types should use a natural hierarchical
|
| - * grouping. For example:
|
| - *
|
| - * "custom.googleapis.com/invoice/paid/amount"
|
| - * "appengine.googleapis.com/http/server/response_latencies"
|
| - */
|
| +
|
| + /// The metric type, including its DNS name prefix. The type is not
|
| + /// URL-encoded. All user-defined custom metric types have the DNS name
|
| + /// `custom.googleapis.com`. Metric types should use a natural hierarchical
|
| + /// grouping. For example:
|
| + ///
|
| + /// "custom.googleapis.com/invoice/paid/amount"
|
| + /// "appengine.googleapis.com/http/server/response_latencies"
|
| core.String type;
|
| - /**
|
| - * The unit in which the metric value is reported. It is only applicable
|
| - * if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
|
| - * supported units are a subset of [The Unified Code for Units of
|
| - * Measure](http://unitsofmeasure.org/ucum.html) standard:
|
| - *
|
| - * **Basic units (UNIT)**
|
| - *
|
| - * * `bit` bit
|
| - * * `By` byte
|
| - * * `s` second
|
| - * * `min` minute
|
| - * * `h` hour
|
| - * * `d` day
|
| - *
|
| - * **Prefixes (PREFIX)**
|
| - *
|
| - * * `k` kilo (10**3)
|
| - * * `M` mega (10**6)
|
| - * * `G` giga (10**9)
|
| - * * `T` tera (10**12)
|
| - * * `P` peta (10**15)
|
| - * * `E` exa (10**18)
|
| - * * `Z` zetta (10**21)
|
| - * * `Y` yotta (10**24)
|
| - * * `m` milli (10**-3)
|
| - * * `u` micro (10**-6)
|
| - * * `n` nano (10**-9)
|
| - * * `p` pico (10**-12)
|
| - * * `f` femto (10**-15)
|
| - * * `a` atto (10**-18)
|
| - * * `z` zepto (10**-21)
|
| - * * `y` yocto (10**-24)
|
| - * * `Ki` kibi (2**10)
|
| - * * `Mi` mebi (2**20)
|
| - * * `Gi` gibi (2**30)
|
| - * * `Ti` tebi (2**40)
|
| - *
|
| - * **Grammar**
|
| - *
|
| - * The grammar includes the dimensionless unit `1`, such as `1/s`.
|
| - *
|
| - * The grammar also includes these connectors:
|
| - *
|
| - * * `/` division (as an infix operator, e.g. `1/s`).
|
| - * * `.` multiplication (as an infix operator, e.g. `GBy.d`)
|
| - *
|
| - * The grammar for a unit is as follows:
|
| - *
|
| - * Expression = Component { "." Component } { "/" Component } ;
|
| - *
|
| - * Component = [ PREFIX ] UNIT [ Annotation ]
|
| - * | Annotation
|
| - * | "1"
|
| - * ;
|
| - *
|
| - * Annotation = "{" NAME "}" ;
|
| - *
|
| - * Notes:
|
| - *
|
| - * * `Annotation` is just a comment if it follows a `UNIT` and is
|
| - * equivalent to `1` if it is used alone. For examples,
|
| - * `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
|
| - * * `NAME` is a sequence of non-blank printable ASCII characters not
|
| - * containing '{' or '}'.
|
| - */
|
| +
|
| + /// The unit in which the metric value is reported. It is only applicable
|
| + /// if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
|
| + /// supported units are a subset of [The Unified Code for Units of
|
| + /// Measure](http://unitsofmeasure.org/ucum.html) standard:
|
| + ///
|
| + /// **Basic units (UNIT)**
|
| + ///
|
| + /// * `bit` bit
|
| + /// * `By` byte
|
| + /// * `s` second
|
| + /// * `min` minute
|
| + /// * `h` hour
|
| + /// * `d` day
|
| + ///
|
| + /// **Prefixes (PREFIX)**
|
| + ///
|
| + /// * `k` kilo (10**3)
|
| + /// * `M` mega (10**6)
|
| + /// * `G` giga (10**9)
|
| + /// * `T` tera (10**12)
|
| + /// * `P` peta (10**15)
|
| + /// * `E` exa (10**18)
|
| + /// * `Z` zetta (10**21)
|
| + /// * `Y` yotta (10**24)
|
| + /// * `m` milli (10**-3)
|
| + /// * `u` micro (10**-6)
|
| + /// * `n` nano (10**-9)
|
| + /// * `p` pico (10**-12)
|
| + /// * `f` femto (10**-15)
|
| + /// * `a` atto (10**-18)
|
| + /// * `z` zepto (10**-21)
|
| + /// * `y` yocto (10**-24)
|
| + /// * `Ki` kibi (2**10)
|
| + /// * `Mi` mebi (2**20)
|
| + /// * `Gi` gibi (2**30)
|
| + /// * `Ti` tebi (2**40)
|
| + ///
|
| + /// **Grammar**
|
| + ///
|
| + /// The grammar includes the dimensionless unit `1`, such as `1/s`.
|
| + ///
|
| + /// The grammar also includes these connectors:
|
| + ///
|
| + /// * `/` division (as an infix operator, e.g. `1/s`).
|
| + /// * `.` multiplication (as an infix operator, e.g. `GBy.d`)
|
| + ///
|
| + /// The grammar for a unit is as follows:
|
| + ///
|
| + /// Expression = Component { "." Component } { "/" Component } ;
|
| + ///
|
| + /// Component = [ PREFIX ] UNIT [ Annotation ]
|
| + /// | Annotation
|
| + /// | "1"
|
| + /// ;
|
| + ///
|
| + /// Annotation = "{" NAME "}" ;
|
| + ///
|
| + /// Notes:
|
| + ///
|
| + /// * `Annotation` is just a comment if it follows a `UNIT` and is
|
| + /// equivalent to `1` if it is used alone. For examples,
|
| + /// `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
|
| + /// * `NAME` is a sequence of non-blank printable ASCII characters not
|
| + /// containing '{' or '}'.
|
| core.String unit;
|
| - /**
|
| - * Whether the measurement is an integer, a floating-point number, etc.
|
| - * Some combinations of `metric_kind` and `value_type` might not be supported.
|
| - * Possible string values are:
|
| - * - "VALUE_TYPE_UNSPECIFIED" : Do not use this default value.
|
| - * - "BOOL" : The value is a boolean.
|
| - * This value type can be used only if the metric kind is `GAUGE`.
|
| - * - "INT64" : The value is a signed 64-bit integer.
|
| - * - "DOUBLE" : The value is a double precision floating point number.
|
| - * - "STRING" : The value is a text string.
|
| - * This value type can be used only if the metric kind is `GAUGE`.
|
| - * - "DISTRIBUTION" : The value is a `Distribution`.
|
| - * - "MONEY" : The value is money.
|
| - */
|
| +
|
| + /// Whether the measurement is an integer, a floating-point number, etc.
|
| + /// Some combinations of `metric_kind` and `value_type` might not be
|
| + /// supported.
|
| + /// Possible string values are:
|
| + /// - "VALUE_TYPE_UNSPECIFIED" : Do not use this default value.
|
| + /// - "BOOL" : The value is a boolean.
|
| + /// This value type can be used only if the metric kind is `GAUGE`.
|
| + /// - "INT64" : The value is a signed 64-bit integer.
|
| + /// - "DOUBLE" : The value is a double precision floating point number.
|
| + /// - "STRING" : The value is a text string.
|
| + /// This value type can be used only if the metric kind is `GAUGE`.
|
| + /// - "DISTRIBUTION" : The value is a `Distribution`.
|
| + /// - "MONEY" : The value is money.
|
| core.String valueType;
|
|
|
| MetricDescriptor();
|
| @@ -2819,7 +2797,9 @@ class MetricDescriptor {
|
| displayName = _json["displayName"];
|
| }
|
| if (_json.containsKey("labels")) {
|
| - labels = _json["labels"].map((value) => new LabelDescriptor.fromJson(value)).toList();
|
| + labels = _json["labels"]
|
| + .map((value) => new LabelDescriptor.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("metricKind")) {
|
| metricKind = _json["metricKind"];
|
| @@ -2839,7 +2819,8 @@ class MetricDescriptor {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -2868,25 +2849,21 @@ class MetricDescriptor {
|
| }
|
| }
|
|
|
| -/**
|
| - * Bind API methods to metrics. Binding a method to a metric causes that
|
| - * metric's configured quota behaviors to apply to the method call.
|
| - */
|
| +/// Bind API methods to metrics. Binding a method to a metric causes that
|
| +/// metric's configured quota behaviors to apply to the method call.
|
| class MetricRule {
|
| - /**
|
| - * Metrics to update when the selected methods are called, and the associated
|
| - * cost applied to each metric.
|
| - *
|
| - * The key of the map is the metric name, and the values are the amount
|
| - * increased for the metric against which the quota limits are defined.
|
| - * The value must not be negative.
|
| - */
|
| + /// Metrics to update when the selected methods are called, and the
|
| + /// associated
|
| + /// cost applied to each metric.
|
| + ///
|
| + /// The key of the map is the metric name, and the values are the amount
|
| + /// increased for the metric against which the quota limits are defined.
|
| + /// The value must not be negative.
|
| core.Map<core.String, core.String> metricCosts;
|
| - /**
|
| - * Selects the methods to which this rule applies.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects the methods to which this rule applies.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| MetricRule();
|
| @@ -2901,7 +2878,8 @@ class MetricRule {
|
| }
|
|
|
| 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 (metricCosts != null) {
|
| _json["metricCosts"] = metricCosts;
|
| }
|
| @@ -2912,93 +2890,90 @@ class MetricRule {
|
| }
|
| }
|
|
|
| -/**
|
| - * Declares an API Interface to be included in this interface. The including
|
| - * interface must redeclare all the methods from the included interface, but
|
| - * documentation and options are inherited as follows:
|
| - *
|
| - * - If after comment and whitespace stripping, the documentation
|
| - * string of the redeclared method is empty, it will be inherited
|
| - * from the original method.
|
| - *
|
| - * - Each annotation belonging to the service config (http,
|
| - * visibility) which is not set in the redeclared method will be
|
| - * inherited.
|
| - *
|
| - * - If an http annotation is inherited, the path pattern will be
|
| - * modified as follows. Any version prefix will be replaced by the
|
| - * version of the including interface plus the root path if
|
| - * specified.
|
| - *
|
| - * Example of a simple mixin:
|
| - *
|
| - * package google.acl.v1;
|
| - * service AccessControl {
|
| - * // Get the underlying ACL object.
|
| - * rpc GetAcl(GetAclRequest) returns (Acl) {
|
| - * option (google.api.http).get = "/v1/{resource=**}:getAcl";
|
| - * }
|
| - * }
|
| - *
|
| - * package google.storage.v2;
|
| - * service Storage {
|
| - * // rpc GetAcl(GetAclRequest) returns (Acl);
|
| - *
|
| - * // Get a data record.
|
| - * rpc GetData(GetDataRequest) returns (Data) {
|
| - * option (google.api.http).get = "/v2/{resource=**}";
|
| - * }
|
| - * }
|
| - *
|
| - * Example of a mixin configuration:
|
| - *
|
| - * apis:
|
| - * - name: google.storage.v2.Storage
|
| - * mixins:
|
| - * - name: google.acl.v1.AccessControl
|
| - *
|
| - * The mixin construct implies that all methods in `AccessControl` are
|
| - * also declared with same name and request/response types in
|
| - * `Storage`. A documentation generator or annotation processor will
|
| - * see the effective `Storage.GetAcl` method after inherting
|
| - * documentation and annotations as follows:
|
| - *
|
| - * service Storage {
|
| - * // Get the underlying ACL object.
|
| - * rpc GetAcl(GetAclRequest) returns (Acl) {
|
| - * option (google.api.http).get = "/v2/{resource=**}:getAcl";
|
| - * }
|
| - * ...
|
| - * }
|
| - *
|
| - * Note how the version in the path pattern changed from `v1` to `v2`.
|
| - *
|
| - * If the `root` field in the mixin is specified, it should be a
|
| - * relative path under which inherited HTTP paths are placed. Example:
|
| - *
|
| - * apis:
|
| - * - name: google.storage.v2.Storage
|
| - * mixins:
|
| - * - name: google.acl.v1.AccessControl
|
| - * root: acls
|
| - *
|
| - * This implies the following inherited HTTP annotation:
|
| - *
|
| - * service Storage {
|
| - * // Get the underlying ACL object.
|
| - * rpc GetAcl(GetAclRequest) returns (Acl) {
|
| - * option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
|
| - * }
|
| - * ...
|
| - * }
|
| - */
|
| +/// Declares an API Interface to be included in this interface. The including
|
| +/// interface must redeclare all the methods from the included interface, but
|
| +/// documentation and options are inherited as follows:
|
| +///
|
| +/// - If after comment and whitespace stripping, the documentation
|
| +/// string of the redeclared method is empty, it will be inherited
|
| +/// from the original method.
|
| +///
|
| +/// - Each annotation belonging to the service config (http,
|
| +/// visibility) which is not set in the redeclared method will be
|
| +/// inherited.
|
| +///
|
| +/// - If an http annotation is inherited, the path pattern will be
|
| +/// modified as follows. Any version prefix will be replaced by the
|
| +/// version of the including interface plus the root path if
|
| +/// specified.
|
| +///
|
| +/// Example of a simple mixin:
|
| +///
|
| +/// package google.acl.v1;
|
| +/// service AccessControl {
|
| +/// // Get the underlying ACL object.
|
| +/// rpc GetAcl(GetAclRequest) returns (Acl) {
|
| +/// option (google.api.http).get = "/v1/{resource=**}:getAcl";
|
| +/// }
|
| +/// }
|
| +///
|
| +/// package google.storage.v2;
|
| +/// service Storage {
|
| +/// // rpc GetAcl(GetAclRequest) returns (Acl);
|
| +///
|
| +/// // Get a data record.
|
| +/// rpc GetData(GetDataRequest) returns (Data) {
|
| +/// option (google.api.http).get = "/v2/{resource=**}";
|
| +/// }
|
| +/// }
|
| +///
|
| +/// Example of a mixin configuration:
|
| +///
|
| +/// apis:
|
| +/// - name: google.storage.v2.Storage
|
| +/// mixins:
|
| +/// - name: google.acl.v1.AccessControl
|
| +///
|
| +/// The mixin construct implies that all methods in `AccessControl` are
|
| +/// also declared with same name and request/response types in
|
| +/// `Storage`. A documentation generator or annotation processor will
|
| +/// see the effective `Storage.GetAcl` method after inherting
|
| +/// documentation and annotations as follows:
|
| +///
|
| +/// service Storage {
|
| +/// // Get the underlying ACL object.
|
| +/// rpc GetAcl(GetAclRequest) returns (Acl) {
|
| +/// option (google.api.http).get = "/v2/{resource=**}:getAcl";
|
| +/// }
|
| +/// ...
|
| +/// }
|
| +///
|
| +/// Note how the version in the path pattern changed from `v1` to `v2`.
|
| +///
|
| +/// If the `root` field in the mixin is specified, it should be a
|
| +/// relative path under which inherited HTTP paths are placed. Example:
|
| +///
|
| +/// apis:
|
| +/// - name: google.storage.v2.Storage
|
| +/// mixins:
|
| +/// - name: google.acl.v1.AccessControl
|
| +/// root: acls
|
| +///
|
| +/// This implies the following inherited HTTP annotation:
|
| +///
|
| +/// service Storage {
|
| +/// // Get the underlying ACL object.
|
| +/// rpc GetAcl(GetAclRequest) returns (Acl) {
|
| +/// option (google.api.http).get = "/v2/acls/{resource=**}:getAcl";
|
| +/// }
|
| +/// ...
|
| +/// }
|
| class Mixin {
|
| - /** The fully qualified name of the interface which is included. */
|
| + /// The fully qualified name of the interface which is included.
|
| core.String name;
|
| - /**
|
| - * If non-empty specifies a path under which inherited HTTP paths
|
| - * are rooted.
|
| - */
|
| +
|
| + /// If non-empty specifies a path under which inherited HTTP paths
|
| + /// are rooted.
|
| core.String root;
|
|
|
| Mixin();
|
| @@ -3013,7 +2988,8 @@ class Mixin {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -3024,50 +3000,45 @@ class Mixin {
|
| }
|
| }
|
|
|
| -/**
|
| - * An object that describes the schema of a MonitoredResource object using a
|
| - * type name and a set of labels. For example, the monitored resource
|
| - * descriptor for Google Compute Engine VM instances has a type of
|
| - * `"gce_instance"` and specifies the use of the labels `"instance_id"` and
|
| - * `"zone"` to identify particular VM instances.
|
| - *
|
| - * Different APIs can support different monitored resource types. APIs generally
|
| - * provide a `list` method that returns the monitored resource descriptors used
|
| - * by the API.
|
| - */
|
| +/// An object that describes the schema of a MonitoredResource object using a
|
| +/// type name and a set of labels. For example, the monitored resource
|
| +/// descriptor for Google Compute Engine VM instances has a type of
|
| +/// `"gce_instance"` and specifies the use of the labels `"instance_id"` and
|
| +/// `"zone"` to identify particular VM instances.
|
| +///
|
| +/// Different APIs can support different monitored resource types. APIs
|
| +/// generally
|
| +/// provide a `list` method that returns the monitored resource descriptors
|
| +/// used
|
| +/// by the API.
|
| class MonitoredResourceDescriptor {
|
| - /**
|
| - * Optional. A detailed description of the monitored resource type that might
|
| - * be used in documentation.
|
| - */
|
| + /// Optional. A detailed description of the monitored resource type that
|
| + /// might
|
| + /// be used in documentation.
|
| core.String description;
|
| - /**
|
| - * Optional. A concise name for the monitored resource type that might be
|
| - * displayed in user interfaces. It should be a Title Cased Noun Phrase,
|
| - * without any article or other determiners. For example,
|
| - * `"Google Cloud SQL Database"`.
|
| - */
|
| +
|
| + /// Optional. A concise name for the monitored resource type that might be
|
| + /// displayed in user interfaces. It should be a Title Cased Noun Phrase,
|
| + /// without any article or other determiners. For example,
|
| + /// `"Google Cloud SQL Database"`.
|
| core.String displayName;
|
| - /**
|
| - * Required. A set of labels used to describe instances of this monitored
|
| - * resource type. For example, an individual Google Cloud SQL database is
|
| - * identified by values for the labels `"database_id"` and `"zone"`.
|
| - */
|
| +
|
| + /// Required. A set of labels used to describe instances of this monitored
|
| + /// resource type. For example, an individual Google Cloud SQL database is
|
| + /// identified by values for the labels `"database_id"` and `"zone"`.
|
| core.List<LabelDescriptor> labels;
|
| - /**
|
| - * Optional. The resource name of the monitored resource descriptor:
|
| - * `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
|
| - * {type} is the value of the `type` field in this object and
|
| - * {project_id} is a project ID that provides API-specific context for
|
| - * accessing the type. APIs that do not use project information can use the
|
| - * resource name format `"monitoredResourceDescriptors/{type}"`.
|
| - */
|
| +
|
| + /// Optional. The resource name of the monitored resource descriptor:
|
| + /// `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
|
| + /// {type} is the value of the `type` field in this object and
|
| + /// {project_id} is a project ID that provides API-specific context for
|
| + /// accessing the type. APIs that do not use project information can use the
|
| + /// resource name format `"monitoredResourceDescriptors/{type}"`.
|
| core.String name;
|
| - /**
|
| - * Required. The monitored resource type. For example, the type
|
| - * `"cloudsql_database"` represents databases in Google Cloud SQL.
|
| - * The maximum length of this value is 256 characters.
|
| - */
|
| +
|
| + /// Required. The monitored resource type. For example, the type
|
| + /// `"cloudsql_database"` represents databases in Google Cloud SQL.
|
| + /// The maximum length of this value is 256 characters.
|
| core.String type;
|
|
|
| MonitoredResourceDescriptor();
|
| @@ -3080,7 +3051,9 @@ class MonitoredResourceDescriptor {
|
| displayName = _json["displayName"];
|
| }
|
| if (_json.containsKey("labels")) {
|
| - labels = _json["labels"].map((value) => new LabelDescriptor.fromJson(value)).toList();
|
| + labels = _json["labels"]
|
| + .map((value) => new LabelDescriptor.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("name")) {
|
| name = _json["name"];
|
| @@ -3091,7 +3064,8 @@ class MonitoredResourceDescriptor {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -3111,98 +3085,95 @@ class MonitoredResourceDescriptor {
|
| }
|
| }
|
|
|
| -/**
|
| - * Monitoring configuration of the service.
|
| - *
|
| - * The example below shows how to configure monitored resources and metrics
|
| - * for monitoring. In the example, a monitored resource and two metrics are
|
| - * defined. The `library.googleapis.com/book/returned_count` metric is sent
|
| - * to both producer and consumer projects, whereas the
|
| - * `library.googleapis.com/book/overdue_count` metric is only sent to the
|
| - * consumer project.
|
| - *
|
| - * monitored_resources:
|
| - * - type: library.googleapis.com/branch
|
| - * labels:
|
| - * - key: /city
|
| - * description: The city where the library branch is located in.
|
| - * - key: /name
|
| - * description: The name of the branch.
|
| - * metrics:
|
| - * - name: library.googleapis.com/book/returned_count
|
| - * metric_kind: DELTA
|
| - * value_type: INT64
|
| - * labels:
|
| - * - key: /customer_id
|
| - * - name: library.googleapis.com/book/overdue_count
|
| - * metric_kind: GAUGE
|
| - * value_type: INT64
|
| - * labels:
|
| - * - key: /customer_id
|
| - * monitoring:
|
| - * producer_destinations:
|
| - * - monitored_resource: library.googleapis.com/branch
|
| - * metrics:
|
| - * - library.googleapis.com/book/returned_count
|
| - * consumer_destinations:
|
| - * - monitored_resource: library.googleapis.com/branch
|
| - * metrics:
|
| - * - library.googleapis.com/book/returned_count
|
| - * - library.googleapis.com/book/overdue_count
|
| - */
|
| +/// Monitoring configuration of the service.
|
| +///
|
| +/// The example below shows how to configure monitored resources and metrics
|
| +/// for monitoring. In the example, a monitored resource and two metrics are
|
| +/// defined. The `library.googleapis.com/book/returned_count` metric is sent
|
| +/// to both producer and consumer projects, whereas the
|
| +/// `library.googleapis.com/book/overdue_count` metric is only sent to the
|
| +/// consumer project.
|
| +///
|
| +/// monitored_resources:
|
| +/// - type: library.googleapis.com/branch
|
| +/// labels:
|
| +/// - key: /city
|
| +/// description: The city where the library branch is located in.
|
| +/// - key: /name
|
| +/// description: The name of the branch.
|
| +/// metrics:
|
| +/// - name: library.googleapis.com/book/returned_count
|
| +/// metric_kind: DELTA
|
| +/// value_type: INT64
|
| +/// labels:
|
| +/// - key: /customer_id
|
| +/// - name: library.googleapis.com/book/overdue_count
|
| +/// metric_kind: GAUGE
|
| +/// value_type: INT64
|
| +/// labels:
|
| +/// - key: /customer_id
|
| +/// monitoring:
|
| +/// producer_destinations:
|
| +/// - monitored_resource: library.googleapis.com/branch
|
| +/// metrics:
|
| +/// - library.googleapis.com/book/returned_count
|
| +/// consumer_destinations:
|
| +/// - monitored_resource: library.googleapis.com/branch
|
| +/// metrics:
|
| +/// - library.googleapis.com/book/returned_count
|
| +/// - library.googleapis.com/book/overdue_count
|
| class Monitoring {
|
| - /**
|
| - * Monitoring configurations for sending metrics to the consumer project.
|
| - * There can be multiple consumer destinations, each one must have a
|
| - * different monitored resource type. A metric can be used in at most
|
| - * one consumer destination.
|
| - */
|
| + /// Monitoring configurations for sending metrics to the consumer project.
|
| + /// There can be multiple consumer destinations, each one must have a
|
| + /// different monitored resource type. A metric can be used in at most
|
| + /// one consumer destination.
|
| core.List<MonitoringDestination> consumerDestinations;
|
| - /**
|
| - * Monitoring configurations for sending metrics to the producer project.
|
| - * There can be multiple producer destinations, each one must have a
|
| - * different monitored resource type. A metric can be used in at most
|
| - * one producer destination.
|
| - */
|
| +
|
| + /// Monitoring configurations for sending metrics to the producer project.
|
| + /// There can be multiple producer destinations, each one must have a
|
| + /// different monitored resource type. A metric can be used in at most
|
| + /// one producer destination.
|
| core.List<MonitoringDestination> producerDestinations;
|
|
|
| Monitoring();
|
|
|
| Monitoring.fromJson(core.Map _json) {
|
| if (_json.containsKey("consumerDestinations")) {
|
| - consumerDestinations = _json["consumerDestinations"].map((value) => new MonitoringDestination.fromJson(value)).toList();
|
| + consumerDestinations = _json["consumerDestinations"]
|
| + .map((value) => new MonitoringDestination.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("producerDestinations")) {
|
| - producerDestinations = _json["producerDestinations"].map((value) => new MonitoringDestination.fromJson(value)).toList();
|
| + producerDestinations = _json["producerDestinations"]
|
| + .map((value) => new MonitoringDestination.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 (consumerDestinations != null) {
|
| - _json["consumerDestinations"] = consumerDestinations.map((value) => (value).toJson()).toList();
|
| + _json["consumerDestinations"] =
|
| + consumerDestinations.map((value) => (value).toJson()).toList();
|
| }
|
| if (producerDestinations != null) {
|
| - _json["producerDestinations"] = producerDestinations.map((value) => (value).toJson()).toList();
|
| + _json["producerDestinations"] =
|
| + producerDestinations.map((value) => (value).toJson()).toList();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * Configuration of a specific monitoring destination (the producer project
|
| - * or the consumer project).
|
| - */
|
| +/// Configuration of a specific monitoring destination (the producer project
|
| +/// or the consumer project).
|
| class MonitoringDestination {
|
| - /**
|
| - * Names of the metrics to report to this monitoring destination.
|
| - * Each name must be defined in Service.metrics section.
|
| - */
|
| + /// Names of the metrics to report to this monitoring destination.
|
| + /// Each name must be defined in Service.metrics section.
|
| core.List<core.String> metrics;
|
| - /**
|
| - * The monitored resource type. The type must be defined in
|
| - * Service.monitored_resources section.
|
| - */
|
| +
|
| + /// The monitored resource type. The type must be defined in
|
| + /// Service.monitored_resources section.
|
| core.String monitoredResource;
|
|
|
| MonitoringDestination();
|
| @@ -3217,7 +3188,8 @@ class MonitoringDestination {
|
| }
|
|
|
| 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 (metrics != null) {
|
| _json["metrics"] = metrics;
|
| }
|
| @@ -3228,36 +3200,34 @@ class MonitoringDestination {
|
| }
|
| }
|
|
|
| -/**
|
| - * OAuth scopes are a way to define data and permissions on data. For example,
|
| - * there are scopes defined for "Read-only access to Google Calendar" and
|
| - * "Access to Cloud Platform". Users can consent to a scope for an application,
|
| - * giving it permission to access that data on their behalf.
|
| - *
|
| - * OAuth scope specifications should be fairly coarse grained; a user will need
|
| - * to see and understand the text description of what your scope means.
|
| - *
|
| - * In most cases: use one or at most two OAuth scopes for an entire family of
|
| - * products. If your product has multiple APIs, you should probably be sharing
|
| - * the OAuth scope across all of those APIs.
|
| - *
|
| - * When you need finer grained OAuth consent screens: talk with your product
|
| - * management about how developers will use them in practice.
|
| - *
|
| - * Please note that even though each of the canonical scopes is enough for a
|
| - * request to be accepted and passed to the backend, a request can still fail
|
| - * due to the backend requiring additional scopes or permissions.
|
| - */
|
| +/// OAuth scopes are a way to define data and permissions on data. For example,
|
| +/// there are scopes defined for "Read-only access to Google Calendar" and
|
| +/// "Access to Cloud Platform". Users can consent to a scope for an
|
| +/// application,
|
| +/// giving it permission to access that data on their behalf.
|
| +///
|
| +/// OAuth scope specifications should be fairly coarse grained; a user will
|
| +/// need
|
| +/// to see and understand the text description of what your scope means.
|
| +///
|
| +/// In most cases: use one or at most two OAuth scopes for an entire family of
|
| +/// products. If your product has multiple APIs, you should probably be sharing
|
| +/// the OAuth scope across all of those APIs.
|
| +///
|
| +/// When you need finer grained OAuth consent screens: talk with your product
|
| +/// management about how developers will use them in practice.
|
| +///
|
| +/// Please note that even though each of the canonical scopes is enough for a
|
| +/// request to be accepted and passed to the backend, a request can still fail
|
| +/// due to the backend requiring additional scopes or permissions.
|
| class OAuthRequirements {
|
| - /**
|
| - * The list of publicly documented OAuth scopes that are allowed access. An
|
| - * OAuth token containing any of these scopes will be accepted.
|
| - *
|
| - * Example:
|
| - *
|
| - * canonical_scopes: https://www.googleapis.com/auth/calendar,
|
| - * https://www.googleapis.com/auth/calendar.read
|
| - */
|
| + /// The list of publicly documented OAuth scopes that are allowed access. An
|
| + /// OAuth token containing any of these scopes will be accepted.
|
| + ///
|
| + /// Example:
|
| + ///
|
| + /// canonical_scopes: https://www.googleapis.com/auth/calendar,
|
| + /// https://www.googleapis.com/auth/calendar.read
|
| core.String canonicalScopes;
|
|
|
| OAuthRequirements();
|
| @@ -3269,7 +3239,8 @@ class OAuthRequirements {
|
| }
|
|
|
| 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 (canonicalScopes != null) {
|
| _json["canonicalScopes"] = canonicalScopes;
|
| }
|
| @@ -3277,48 +3248,44 @@ class OAuthRequirements {
|
| }
|
| }
|
|
|
| -/**
|
| - * 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();
|
| @@ -3342,7 +3309,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;
|
| }
|
| @@ -3362,18 +3330,19 @@ class Operation {
|
| }
|
| }
|
|
|
| -/** The metadata associated with a long running operation resource. */
|
| +/// The metadata associated with a long running operation resource.
|
| class OperationMetadata {
|
| - /** Percentage of completion of this operation, ranging from 0 to 100. */
|
| + /// Percentage of completion of this operation, ranging from 0 to 100.
|
| core.int progressPercentage;
|
| - /**
|
| - * The full name of the resources that this operation is directly
|
| - * associated with.
|
| - */
|
| +
|
| + /// The full name of the resources that this operation is directly
|
| + /// associated with.
|
| core.List<core.String> resourceNames;
|
| - /** The start time of the operation. */
|
| +
|
| + /// The start time of the operation.
|
| core.String startTime;
|
| - /** Detailed status information for each step. The order is undetermined. */
|
| +
|
| + /// Detailed status information for each step. The order is undetermined.
|
| core.List<Step> steps;
|
|
|
| OperationMetadata();
|
| @@ -3394,7 +3363,8 @@ class OperationMetadata {
|
| }
|
|
|
| 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 (progressPercentage != null) {
|
| _json["progressPercentage"] = progressPercentage;
|
| }
|
| @@ -3411,27 +3381,22 @@ class OperationMetadata {
|
| }
|
| }
|
|
|
| -/**
|
| - * A protocol buffer option, which can be attached to a message, field,
|
| - * enumeration, etc.
|
| - */
|
| +/// A protocol buffer option, which can be attached to a message, field,
|
| +/// enumeration, etc.
|
| class Option {
|
| - /**
|
| - * The option's name. For protobuf built-in options (options defined in
|
| - * descriptor.proto), this is the short name. For example, `"map_entry"`.
|
| - * For custom options, it should be the fully-qualified name. For example,
|
| - * `"google.api.http"`.
|
| - */
|
| + /// The option's name. For protobuf built-in options (options defined in
|
| + /// descriptor.proto), this is the short name. For example, `"map_entry"`.
|
| + /// For custom options, it should be the fully-qualified name. For example,
|
| + /// `"google.api.http"`.
|
| core.String name;
|
| - /**
|
| - * The option's value packed in an Any message. If the value is a primitive,
|
| - * the corresponding wrapper type defined in google/protobuf/wrappers.proto
|
| - * should be used. If the value is an enum, it should be stored as an int32
|
| - * value using the google.protobuf.Int32Value type.
|
| - *
|
| - * 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 option's value packed in an Any message. If the value is a primitive,
|
| + /// the corresponding wrapper type defined in google/protobuf/wrappers.proto
|
| + /// should be used. If the value is an enum, it should be stored as an int32
|
| + /// value using the google.protobuf.Int32Value type.
|
| + ///
|
| + /// 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> value;
|
|
|
| Option();
|
| @@ -3446,7 +3411,8 @@ class Option {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -3457,38 +3423,32 @@ class Option {
|
| }
|
| }
|
|
|
| -/**
|
| - * Represents a documentation page. A page can contain subpages to represent
|
| - * nested documentation set structure.
|
| - */
|
| +/// Represents a documentation page. A page can contain subpages to represent
|
| +/// nested documentation set structure.
|
| class Page {
|
| - /**
|
| - * The Markdown content of the page. You can use <code>(== include {path}
|
| - * ==)</code>
|
| - * to include content from a Markdown file.
|
| - */
|
| + /// The Markdown content of the page. You can use <code>(== include
|
| + /// {path} ==)</code>
|
| + /// to include content from a Markdown file.
|
| core.String content;
|
| - /**
|
| - * The name of the page. It will be used as an identity of the page to
|
| - * generate URI of the page, text of the link to this page in navigation,
|
| - * etc. The full page name (start from the root page name to this page
|
| - * concatenated with `.`) can be used as reference to the page in your
|
| - * documentation. For example:
|
| - * <pre><code>pages:
|
| - * - name: Tutorial
|
| - * content: (== include tutorial.md ==)
|
| - * subpages:
|
| - * - name: Java
|
| - * content: (== include tutorial_java.md ==)
|
| - * </code></pre>
|
| - * You can reference `Java` page using Markdown reference link syntax:
|
| - * `Java`.
|
| - */
|
| +
|
| + /// The name of the page. It will be used as an identity of the page to
|
| + /// generate URI of the page, text of the link to this page in navigation,
|
| + /// etc. The full page name (start from the root page name to this page
|
| + /// concatenated with `.`) can be used as reference to the page in your
|
| + /// documentation. For example:
|
| + /// <pre><code>pages:
|
| + /// - name: Tutorial
|
| + /// content: (== include tutorial.md ==)
|
| + /// subpages:
|
| + /// - name: Java
|
| + /// content: (== include tutorial_java.md ==)
|
| + /// </code></pre>
|
| + /// You can reference `Java` page using Markdown reference link syntax:
|
| + /// `Java`.
|
| core.String name;
|
| - /**
|
| - * Subpages of this page. The order of subpages specified here will be
|
| - * honored in the generated docset.
|
| - */
|
| +
|
| + /// Subpages of this page. The order of subpages specified here will be
|
| + /// honored in the generated docset.
|
| core.List<Page> subpages;
|
|
|
| Page();
|
| @@ -3501,12 +3461,14 @@ class Page {
|
| name = _json["name"];
|
| }
|
| if (_json.containsKey("subpages")) {
|
| - subpages = _json["subpages"].map((value) => new Page.fromJson(value)).toList();
|
| + subpages =
|
| + _json["subpages"].map((value) => new Page.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 (content != null) {
|
| _json["content"] = content;
|
| }
|
| @@ -3520,19 +3482,16 @@ class Page {
|
| }
|
| }
|
|
|
| -/**
|
| - * The published version of a Service that is managed by
|
| - * Google Service Management.
|
| - */
|
| +/// The published version of a Service that is managed by
|
| +/// Google Service Management.
|
| class PublishedService {
|
| - /**
|
| - * The resource name of the service.
|
| - *
|
| - * A valid name would be:
|
| - * - services/serviceuser.googleapis.com
|
| - */
|
| + /// The resource name of the service.
|
| + ///
|
| + /// A valid name would be:
|
| + /// - services/serviceuser.googleapis.com
|
| core.String name;
|
| - /** The service's published configuration. */
|
| +
|
| + /// The service's published configuration.
|
| Service service;
|
|
|
| PublishedService();
|
| @@ -3547,7 +3506,8 @@ class PublishedService {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -3558,201 +3518,196 @@ class PublishedService {
|
| }
|
| }
|
|
|
| -/**
|
| - * Quota configuration helps to achieve fairness and budgeting in service
|
| - * usage.
|
| - *
|
| - * The quota configuration works this way:
|
| - * - The service configuration defines a set of metrics.
|
| - * - For API calls, the quota.metric_rules maps methods to metrics with
|
| - * corresponding costs.
|
| - * - The quota.limits defines limits on the metrics, which will be used for
|
| - * quota checks at runtime.
|
| - *
|
| - * An example quota configuration in yaml format:
|
| - *
|
| - * quota:
|
| - *
|
| - * - name: apiWriteQpsPerProject
|
| - * metric: library.googleapis.com/write_calls
|
| - * unit: "1/min/{project}" # rate limit for consumer projects
|
| - * values:
|
| - * STANDARD: 10000
|
| - *
|
| - *
|
| - * # The metric rules bind all methods to the read_calls metric,
|
| - * # except for the UpdateBook and DeleteBook methods. These two methods
|
| - * # are mapped to the write_calls metric, with the UpdateBook method
|
| - * # consuming at twice rate as the DeleteBook method.
|
| - * metric_rules:
|
| - * - selector: "*"
|
| - * metric_costs:
|
| - * library.googleapis.com/read_calls: 1
|
| - * - selector: google.example.library.v1.LibraryService.UpdateBook
|
| - * metric_costs:
|
| - * library.googleapis.com/write_calls: 2
|
| - * - selector: google.example.library.v1.LibraryService.DeleteBook
|
| - * metric_costs:
|
| - * library.googleapis.com/write_calls: 1
|
| - *
|
| - * Corresponding Metric definition:
|
| - *
|
| - * metrics:
|
| - * - name: library.googleapis.com/read_calls
|
| - * display_name: Read requests
|
| - * metric_kind: DELTA
|
| - * value_type: INT64
|
| - *
|
| - * - name: library.googleapis.com/write_calls
|
| - * display_name: Write requests
|
| - * metric_kind: DELTA
|
| - * value_type: INT64
|
| - */
|
| +/// Quota configuration helps to achieve fairness and budgeting in service
|
| +/// usage.
|
| +///
|
| +/// The quota configuration works this way:
|
| +/// - The service configuration defines a set of metrics.
|
| +/// - For API calls, the quota.metric_rules maps methods to metrics with
|
| +/// corresponding costs.
|
| +/// - The quota.limits defines limits on the metrics, which will be used for
|
| +/// quota checks at runtime.
|
| +///
|
| +/// An example quota configuration in yaml format:
|
| +///
|
| +/// quota:
|
| +///
|
| +/// - name: apiWriteQpsPerProject
|
| +/// metric: library.googleapis.com/write_calls
|
| +/// unit: "1/min/{project}" # rate limit for consumer projects
|
| +/// values:
|
| +/// STANDARD: 10000
|
| +///
|
| +///
|
| +/// # The metric rules bind all methods to the read_calls metric,
|
| +/// # except for the UpdateBook and DeleteBook methods. These two methods
|
| +/// # are mapped to the write_calls metric, with the UpdateBook method
|
| +/// # consuming at twice rate as the DeleteBook method.
|
| +/// metric_rules:
|
| +/// - selector: "*"
|
| +/// metric_costs:
|
| +/// library.googleapis.com/read_calls: 1
|
| +/// - selector: google.example.library.v1.LibraryService.UpdateBook
|
| +/// metric_costs:
|
| +/// library.googleapis.com/write_calls: 2
|
| +/// - selector: google.example.library.v1.LibraryService.DeleteBook
|
| +/// metric_costs:
|
| +/// library.googleapis.com/write_calls: 1
|
| +///
|
| +/// Corresponding Metric definition:
|
| +///
|
| +/// metrics:
|
| +/// - name: library.googleapis.com/read_calls
|
| +/// display_name: Read requests
|
| +/// metric_kind: DELTA
|
| +/// value_type: INT64
|
| +///
|
| +/// - name: library.googleapis.com/write_calls
|
| +/// display_name: Write requests
|
| +/// metric_kind: DELTA
|
| +/// value_type: INT64
|
| class Quota {
|
| - /** List of `QuotaLimit` definitions for the service. */
|
| + /// List of `QuotaLimit` definitions for the service.
|
| core.List<QuotaLimit> limits;
|
| - /**
|
| - * List of `MetricRule` definitions, each one mapping a selected method to one
|
| - * or more metrics.
|
| - */
|
| +
|
| + /// List of `MetricRule` definitions, each one mapping a selected method to
|
| + /// one
|
| + /// or more metrics.
|
| core.List<MetricRule> metricRules;
|
|
|
| Quota();
|
|
|
| Quota.fromJson(core.Map _json) {
|
| if (_json.containsKey("limits")) {
|
| - limits = _json["limits"].map((value) => new QuotaLimit.fromJson(value)).toList();
|
| + limits = _json["limits"]
|
| + .map((value) => new QuotaLimit.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("metricRules")) {
|
| - metricRules = _json["metricRules"].map((value) => new MetricRule.fromJson(value)).toList();
|
| + metricRules = _json["metricRules"]
|
| + .map((value) => new MetricRule.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 (limits != null) {
|
| _json["limits"] = limits.map((value) => (value).toJson()).toList();
|
| }
|
| if (metricRules != null) {
|
| - _json["metricRules"] = metricRules.map((value) => (value).toJson()).toList();
|
| + _json["metricRules"] =
|
| + metricRules.map((value) => (value).toJson()).toList();
|
| }
|
| return _json;
|
| }
|
| }
|
|
|
| -/**
|
| - * `QuotaLimit` defines a specific limit that applies over a specified duration
|
| - * for a limit type. There can be at most one limit for a duration and limit
|
| - * type combination defined within a `QuotaGroup`.
|
| - */
|
| +/// `QuotaLimit` defines a specific limit that applies over a specified
|
| +/// duration
|
| +/// for a limit type. There can be at most one limit for a duration and limit
|
| +/// type combination defined within a `QuotaGroup`.
|
| class QuotaLimit {
|
| - /**
|
| - * Default number of tokens that can be consumed during the specified
|
| - * duration. This is the number of tokens assigned when a client
|
| - * application developer activates the service for his/her project.
|
| - *
|
| - * Specifying a value of 0 will block all requests. This can be used if you
|
| - * are provisioning quota to selected consumers and blocking others.
|
| - * Similarly, a value of -1 will indicate an unlimited quota. No other
|
| - * negative values are allowed.
|
| - *
|
| - * Used by group-based quotas only.
|
| - */
|
| + /// Default number of tokens that can be consumed during the specified
|
| + /// duration. This is the number of tokens assigned when a client
|
| + /// application developer activates the service for his/her project.
|
| + ///
|
| + /// Specifying a value of 0 will block all requests. This can be used if you
|
| + /// are provisioning quota to selected consumers and blocking others.
|
| + /// Similarly, a value of -1 will indicate an unlimited quota. No other
|
| + /// negative values are allowed.
|
| + ///
|
| + /// Used by group-based quotas only.
|
| core.String defaultLimit;
|
| - /**
|
| - * Optional. User-visible, extended description for this quota limit.
|
| - * Should be used only when more context is needed to understand this limit
|
| - * than provided by the limit's display name (see: `display_name`).
|
| - */
|
| +
|
| + /// Optional. User-visible, extended description for this quota limit.
|
| + /// Should be used only when more context is needed to understand this limit
|
| + /// than provided by the limit's display name (see: `display_name`).
|
| core.String description;
|
| - /**
|
| - * User-visible display name for this limit.
|
| - * Optional. If not set, the UI will provide a default display name based on
|
| - * the quota configuration. This field can be used to override the default
|
| - * display name generated from the configuration.
|
| - */
|
| +
|
| + /// User-visible display name for this limit.
|
| + /// Optional. If not set, the UI will provide a default display name based on
|
| + /// the quota configuration. This field can be used to override the default
|
| + /// display name generated from the configuration.
|
| core.String displayName;
|
| - /**
|
| - * Duration of this limit in textual notation. Example: "100s", "24h", "1d".
|
| - * For duration longer than a day, only multiple of days is supported. We
|
| - * support only "100s" and "1d" for now. Additional support will be added in
|
| - * the future. "0" indicates indefinite duration.
|
| - *
|
| - * Used by group-based quotas only.
|
| - */
|
| +
|
| + /// Duration of this limit in textual notation. Example: "100s", "24h", "1d".
|
| + /// For duration longer than a day, only multiple of days is supported. We
|
| + /// support only "100s" and "1d" for now. Additional support will be added in
|
| + /// the future. "0" indicates indefinite duration.
|
| + ///
|
| + /// Used by group-based quotas only.
|
| core.String duration;
|
| - /**
|
| - * Free tier value displayed in the Developers Console for this limit.
|
| - * The free tier is the number of tokens that will be subtracted from the
|
| - * billed amount when billing is enabled.
|
| - * This field can only be set on a limit with duration "1d", in a billable
|
| - * group; it is invalid on any other limit. If this field is not set, it
|
| - * defaults to 0, indicating that there is no free tier for this service.
|
| - *
|
| - * Used by group-based quotas only.
|
| - */
|
| +
|
| + /// Free tier value displayed in the Developers Console for this limit.
|
| + /// The free tier is the number of tokens that will be subtracted from the
|
| + /// billed amount when billing is enabled.
|
| + /// This field can only be set on a limit with duration "1d", in a billable
|
| + /// group; it is invalid on any other limit. If this field is not set, it
|
| + /// defaults to 0, indicating that there is no free tier for this service.
|
| + ///
|
| + /// Used by group-based quotas only.
|
| core.String freeTier;
|
| - /**
|
| - * Maximum number of tokens that can be consumed during the specified
|
| - * duration. Client application developers can override the default limit up
|
| - * to this maximum. If specified, this value cannot be set to a value less
|
| - * than the default limit. If not specified, it is set to the default limit.
|
| - *
|
| - * To allow clients to apply overrides with no upper bound, set this to -1,
|
| - * indicating unlimited maximum quota.
|
| - *
|
| - * Used by group-based quotas only.
|
| - */
|
| +
|
| + /// Maximum number of tokens that can be consumed during the specified
|
| + /// duration. Client application developers can override the default limit up
|
| + /// to this maximum. If specified, this value cannot be set to a value less
|
| + /// than the default limit. If not specified, it is set to the default limit.
|
| + ///
|
| + /// To allow clients to apply overrides with no upper bound, set this to -1,
|
| + /// indicating unlimited maximum quota.
|
| + ///
|
| + /// Used by group-based quotas only.
|
| core.String maxLimit;
|
| - /**
|
| - * The name of the metric this quota limit applies to. The quota limits with
|
| - * the same metric will be checked together during runtime. The metric must be
|
| - * defined within the service config.
|
| - *
|
| - * Used by metric-based quotas only.
|
| - */
|
| +
|
| + /// The name of the metric this quota limit applies to. The quota limits with
|
| + /// the same metric will be checked together during runtime. The metric must
|
| + /// be
|
| + /// defined within the service config.
|
| + ///
|
| + /// Used by metric-based quotas only.
|
| core.String metric;
|
| - /**
|
| - * Name of the quota limit. The name is used to refer to the limit when
|
| - * overriding the default limit on per-consumer basis.
|
| - *
|
| - * For metric-based quota limits, the name must be provided, and it must be
|
| - * unique within the service. The name can only include alphanumeric
|
| - * characters as well as '-'.
|
| - *
|
| - * The maximum length of the limit name is 64 characters.
|
| - *
|
| - * The name of a limit is used as a unique identifier for this limit.
|
| - * Therefore, once a limit has been put into use, its name should be
|
| - * immutable. You can use the display_name field to provide a user-friendly
|
| - * name for the limit. The display name can be evolved over time without
|
| - * affecting the identity of the limit.
|
| - */
|
| +
|
| + /// Name of the quota limit. The name is used to refer to the limit when
|
| + /// overriding the default limit on per-consumer basis.
|
| + ///
|
| + /// For metric-based quota limits, the name must be provided, and it must be
|
| + /// unique within the service. The name can only include alphanumeric
|
| + /// characters as well as '-'.
|
| + ///
|
| + /// The maximum length of the limit name is 64 characters.
|
| + ///
|
| + /// The name of a limit is used as a unique identifier for this limit.
|
| + /// Therefore, once a limit has been put into use, its name should be
|
| + /// immutable. You can use the display_name field to provide a user-friendly
|
| + /// name for the limit. The display name can be evolved over time without
|
| + /// affecting the identity of the limit.
|
| core.String name;
|
| - /**
|
| - * Specify the unit of the quota limit. It uses the same syntax as
|
| - * Metric.unit. The supported unit kinds are determined by the quota
|
| - * backend system.
|
| - *
|
| - * The [Google Service Control](https://cloud.google.com/service-control)
|
| - * supports the following unit components:
|
| - * * One of the time intevals:
|
| - * * "/min" for quota every minute.
|
| - * * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
|
| - * * Otherwise the quota won't be reset by time, such as storage limit.
|
| - * * One and only one of the granted containers:
|
| - * * "/{project}" quota for a project
|
| - *
|
| - * Here are some examples:
|
| - * * "1/min/{project}" for quota per minute per project.
|
| - *
|
| - * Note: the order of unit components is insignificant.
|
| - * The "1" at the beginning is required to follow the metric unit syntax.
|
| - *
|
| - * Used by metric-based quotas only.
|
| - */
|
| +
|
| + /// Specify the unit of the quota limit. It uses the same syntax as
|
| + /// Metric.unit. The supported unit kinds are determined by the quota
|
| + /// backend system.
|
| + ///
|
| + /// The [Google Service Control](https://cloud.google.com/service-control)
|
| + /// supports the following unit components:
|
| + /// * One of the time intevals:
|
| + /// * "/min" for quota every minute.
|
| + /// * "/d" for quota every 24 hours, starting 00:00 US Pacific Time.
|
| + /// * Otherwise the quota won't be reset by time, such as storage limit.
|
| + /// * One and only one of the granted containers:
|
| + /// * "/{project}" quota for a project
|
| + ///
|
| + /// Here are some examples:
|
| + /// * "1/min/{project}" for quota per minute per project.
|
| + ///
|
| + /// Note: the order of unit components is insignificant.
|
| + /// The "1" at the beginning is required to follow the metric unit syntax.
|
| + ///
|
| + /// Used by metric-based quotas only.
|
| core.String unit;
|
| - /** Tiered limit values, currently only STANDARD is supported. */
|
| +
|
| + /// Tiered limit values, currently only STANDARD is supported.
|
| core.Map<core.String, core.String> values;
|
|
|
| QuotaLimit();
|
| @@ -3791,7 +3746,8 @@ class QuotaLimit {
|
| }
|
|
|
| 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 (defaultLimit != null) {
|
| _json["defaultLimit"] = defaultLimit;
|
| }
|
| @@ -3826,14 +3782,13 @@ class QuotaLimit {
|
| }
|
| }
|
|
|
| -/** Response message for SearchServices method. */
|
| +/// Response message for SearchServices method.
|
| class SearchServicesResponse {
|
| - /**
|
| - * Token that can be passed to `ListAvailableServices` to resume a paginated
|
| - * query.
|
| - */
|
| + /// Token that can be passed to `ListAvailableServices` to resume a paginated
|
| + /// query.
|
| core.String nextPageToken;
|
| - /** Services available publicly or available to the authenticated caller. */
|
| +
|
| + /// Services available publicly or available to the authenticated caller.
|
| core.List<PublishedService> services;
|
|
|
| SearchServicesResponse();
|
| @@ -3843,12 +3798,15 @@ class SearchServicesResponse {
|
| nextPageToken = _json["nextPageToken"];
|
| }
|
| if (_json.containsKey("services")) {
|
| - services = _json["services"].map((value) => new PublishedService.fromJson(value)).toList();
|
| + services = _json["services"]
|
| + .map((value) => new PublishedService.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;
|
| }
|
| @@ -3859,137 +3817,144 @@ class SearchServicesResponse {
|
| }
|
| }
|
|
|
| -/**
|
| - * `Service` is the root object of Google service configuration schema. It
|
| - * describes basic information about a service, such as the name and the
|
| - * title, and delegates other aspects to sub-sections. Each sub-section is
|
| - * either a proto message or a repeated proto message that configures a
|
| - * specific aspect, such as auth. See each proto message definition for details.
|
| - *
|
| - * Example:
|
| - *
|
| - * type: google.api.Service
|
| - * config_version: 3
|
| - * name: calendar.googleapis.com
|
| - * title: Google Calendar API
|
| - * apis:
|
| - * - name: google.calendar.v3.Calendar
|
| - * authentication:
|
| - * providers:
|
| - * - id: google_calendar_auth
|
| - * jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
| - * issuer: https://securetoken.google.com
|
| - * rules:
|
| - * - selector: "*"
|
| - * requirements:
|
| - * provider_id: google_calendar_auth
|
| - */
|
| +/// `Service` is the root object of Google service configuration schema. It
|
| +/// describes basic information about a service, such as the name and the
|
| +/// title, and delegates other aspects to sub-sections. Each sub-section is
|
| +/// either a proto message or a repeated proto message that configures a
|
| +/// specific aspect, such as auth. See each proto message definition for
|
| +/// details.
|
| +///
|
| +/// Example:
|
| +///
|
| +/// type: google.api.Service
|
| +/// config_version: 3
|
| +/// name: calendar.googleapis.com
|
| +/// title: Google Calendar API
|
| +/// apis:
|
| +/// - name: google.calendar.v3.Calendar
|
| +/// authentication:
|
| +/// providers:
|
| +/// - id: google_calendar_auth
|
| +/// jwks_uri: https://www.googleapis.com/oauth2/v1/certs
|
| +/// issuer: https://securetoken.google.com
|
| +/// rules:
|
| +/// - selector: "*"
|
| +/// requirements:
|
| +/// provider_id: google_calendar_auth
|
| class Service {
|
| - /**
|
| - * A list of API interfaces exported by this service. Only the `name` field
|
| - * of the google.protobuf.Api needs to be provided by the configuration
|
| - * author, as the remaining fields will be derived from the IDL during the
|
| - * normalization process. It is an error to specify an API interface here
|
| - * which cannot be resolved against the associated IDL files.
|
| - */
|
| + /// A list of API interfaces exported by this service. Only the `name` field
|
| + /// of the google.protobuf.Api needs to be provided by the configuration
|
| + /// author, as the remaining fields will be derived from the IDL during the
|
| + /// normalization process. It is an error to specify an API interface here
|
| + /// which cannot be resolved against the associated IDL files.
|
| core.List<Api> apis;
|
| - /** Auth configuration. */
|
| +
|
| + /// Auth configuration.
|
| Authentication authentication;
|
| - /** API backend configuration. */
|
| +
|
| + /// API backend configuration.
|
| Backend backend;
|
| - /**
|
| - * The semantic version of the service configuration. The config version
|
| - * affects the interpretation of the service configuration. For example,
|
| - * certain features are enabled by default for certain config versions.
|
| - * The latest config version is `3`.
|
| - */
|
| +
|
| + /// The semantic version of the service configuration. The config version
|
| + /// affects the interpretation of the service configuration. For example,
|
| + /// certain features are enabled by default for certain config versions.
|
| + /// The latest config version is `3`.
|
| core.int configVersion;
|
| - /** Context configuration. */
|
| +
|
| + /// Context configuration.
|
| Context context;
|
| - /** Configuration for the service control plane. */
|
| +
|
| + /// Configuration for the service control plane.
|
| Control control;
|
| - /** Custom error configuration. */
|
| +
|
| + /// Custom error configuration.
|
| CustomError customError;
|
| - /** Additional API documentation. */
|
| +
|
| + /// Additional API documentation.
|
| Documentation documentation;
|
| - /**
|
| - * Configuration for network endpoints. If this is empty, then an endpoint
|
| - * with the same name as the service is automatically generated to service all
|
| - * defined APIs.
|
| - */
|
| +
|
| + /// Configuration for network endpoints. If this is empty, then an endpoint
|
| + /// with the same name as the service is automatically generated to service
|
| + /// all
|
| + /// defined APIs.
|
| core.List<Endpoint> endpoints;
|
| - /**
|
| - * A list of all enum types included in this API service. Enums
|
| - * referenced directly or indirectly by the `apis` are automatically
|
| - * included. Enums which are not referenced but shall be included
|
| - * should be listed here by name. Example:
|
| - *
|
| - * enums:
|
| - * - name: google.someapi.v1.SomeEnum
|
| - */
|
| +
|
| + /// A list of all enum types included in this API service. Enums
|
| + /// referenced directly or indirectly by the `apis` are automatically
|
| + /// included. Enums which are not referenced but shall be included
|
| + /// should be listed here by name. Example:
|
| + ///
|
| + /// enums:
|
| + /// - name: google.someapi.v1.SomeEnum
|
| core.List<Enum> enums;
|
| - /** Experimental configuration. */
|
| +
|
| + /// Experimental configuration.
|
| Experimental experimental;
|
| - /** HTTP configuration. */
|
| +
|
| + /// HTTP configuration.
|
| Http http;
|
| - /**
|
| - * A unique ID for a specific instance of this message, typically assigned
|
| - * by the client for tracking purpose. If empty, the server may choose to
|
| - * generate one instead.
|
| - */
|
| +
|
| + /// A unique ID for a specific instance of this message, typically assigned
|
| + /// by the client for tracking purpose. If empty, the server may choose to
|
| + /// generate one instead.
|
| core.String id;
|
| - /** Logging configuration. */
|
| +
|
| + /// Logging configuration.
|
| Logging logging;
|
| - /** Defines the logs used by this service. */
|
| +
|
| + /// Defines the logs used by this service.
|
| core.List<LogDescriptor> logs;
|
| - /** Defines the metrics used by this service. */
|
| +
|
| + /// Defines the metrics used by this service.
|
| core.List<MetricDescriptor> metrics;
|
| - /**
|
| - * Defines the monitored resources used by this service. This is required
|
| - * by the Service.monitoring and Service.logging configurations.
|
| - */
|
| +
|
| + /// Defines the monitored resources used by this service. This is required
|
| + /// by the Service.monitoring and Service.logging configurations.
|
| core.List<MonitoredResourceDescriptor> monitoredResources;
|
| - /** Monitoring configuration. */
|
| +
|
| + /// Monitoring configuration.
|
| Monitoring monitoring;
|
| - /**
|
| - * The DNS address at which this service is available,
|
| - * e.g. `calendar.googleapis.com`.
|
| - */
|
| +
|
| + /// The DNS address at which this service is available,
|
| + /// e.g. `calendar.googleapis.com`.
|
| core.String name;
|
| - /** The Google project that owns this service. */
|
| +
|
| + /// The Google project that owns this service.
|
| core.String producerProjectId;
|
| - /** Quota configuration. */
|
| +
|
| + /// Quota configuration.
|
| Quota quota;
|
| - /**
|
| - * Output only. The source information for this configuration if available.
|
| - */
|
| +
|
| + /// Output only. The source information for this configuration if available.
|
| SourceInfo sourceInfo;
|
| - /** System parameter configuration. */
|
| +
|
| + /// System parameter configuration.
|
| SystemParameters systemParameters;
|
| - /**
|
| - * A list of all proto message types included in this API service.
|
| - * It serves similar purpose as [google.api.Service.types], except that
|
| - * these types are not needed by user-defined APIs. Therefore, they will not
|
| - * show up in the generated discovery doc. This field should only be used
|
| - * to define system APIs in ESF.
|
| - */
|
| +
|
| + /// A list of all proto message types included in this API service.
|
| + /// It serves similar purpose as [google.api.Service.types], except that
|
| + /// these types are not needed by user-defined APIs. Therefore, they will not
|
| + /// show up in the generated discovery doc. This field should only be used
|
| + /// to define system APIs in ESF.
|
| core.List<Type> systemTypes;
|
| - /** The product title for this service. */
|
| +
|
| + /// The product title for this service.
|
| core.String title;
|
| - /**
|
| - * A list of all proto message types included in this API service.
|
| - * Types referenced directly or indirectly by the `apis` are
|
| - * automatically included. Messages which are not referenced but
|
| - * shall be included, such as types used by the `google.protobuf.Any` type,
|
| - * should be listed here by name. Example:
|
| - *
|
| - * types:
|
| - * - name: google.protobuf.Int32
|
| - */
|
| +
|
| + /// A list of all proto message types included in this API service.
|
| + /// Types referenced directly or indirectly by the `apis` are
|
| + /// automatically included. Messages which are not referenced but
|
| + /// shall be included, such as types used by the `google.protobuf.Any` type,
|
| + /// should be listed here by name. Example:
|
| + ///
|
| + /// types:
|
| + /// - name: google.protobuf.Int32
|
| core.List<Type> types;
|
| - /** Configuration controlling usage of this service. */
|
| +
|
| + /// Configuration controlling usage of this service.
|
| Usage usage;
|
| - /** API visibility configuration. */
|
| +
|
| + /// API visibility configuration.
|
| Visibility visibility;
|
|
|
| Service();
|
| @@ -4020,7 +3985,9 @@ class Service {
|
| documentation = new Documentation.fromJson(_json["documentation"]);
|
| }
|
| if (_json.containsKey("endpoints")) {
|
| - endpoints = _json["endpoints"].map((value) => new Endpoint.fromJson(value)).toList();
|
| + endpoints = _json["endpoints"]
|
| + .map((value) => new Endpoint.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("enums")) {
|
| enums = _json["enums"].map((value) => new Enum.fromJson(value)).toList();
|
| @@ -4038,13 +4005,19 @@ class Service {
|
| logging = new Logging.fromJson(_json["logging"]);
|
| }
|
| if (_json.containsKey("logs")) {
|
| - logs = _json["logs"].map((value) => new LogDescriptor.fromJson(value)).toList();
|
| + logs = _json["logs"]
|
| + .map((value) => new LogDescriptor.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("metrics")) {
|
| - metrics = _json["metrics"].map((value) => new MetricDescriptor.fromJson(value)).toList();
|
| + metrics = _json["metrics"]
|
| + .map((value) => new MetricDescriptor.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("monitoredResources")) {
|
| - monitoredResources = _json["monitoredResources"].map((value) => new MonitoredResourceDescriptor.fromJson(value)).toList();
|
| + monitoredResources = _json["monitoredResources"]
|
| + .map((value) => new MonitoredResourceDescriptor.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("monitoring")) {
|
| monitoring = new Monitoring.fromJson(_json["monitoring"]);
|
| @@ -4062,10 +4035,13 @@ class Service {
|
| sourceInfo = new SourceInfo.fromJson(_json["sourceInfo"]);
|
| }
|
| if (_json.containsKey("systemParameters")) {
|
| - systemParameters = new SystemParameters.fromJson(_json["systemParameters"]);
|
| + systemParameters =
|
| + new SystemParameters.fromJson(_json["systemParameters"]);
|
| }
|
| if (_json.containsKey("systemTypes")) {
|
| - systemTypes = _json["systemTypes"].map((value) => new Type.fromJson(value)).toList();
|
| + systemTypes = _json["systemTypes"]
|
| + .map((value) => new Type.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("title")) {
|
| title = _json["title"];
|
| @@ -4082,7 +4058,8 @@ class Service {
|
| }
|
|
|
| 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 (apis != null) {
|
| _json["apis"] = apis.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -4132,7 +4109,8 @@ class Service {
|
| _json["metrics"] = metrics.map((value) => (value).toJson()).toList();
|
| }
|
| if (monitoredResources != null) {
|
| - _json["monitoredResources"] = monitoredResources.map((value) => (value).toJson()).toList();
|
| + _json["monitoredResources"] =
|
| + monitoredResources.map((value) => (value).toJson()).toList();
|
| }
|
| if (monitoring != null) {
|
| _json["monitoring"] = (monitoring).toJson();
|
| @@ -4153,7 +4131,8 @@ class Service {
|
| _json["systemParameters"] = (systemParameters).toJson();
|
| }
|
| if (systemTypes != null) {
|
| - _json["systemTypes"] = systemTypes.map((value) => (value).toJson()).toList();
|
| + _json["systemTypes"] =
|
| + systemTypes.map((value) => (value).toJson()).toList();
|
| }
|
| if (title != null) {
|
| _json["title"] = title;
|
| @@ -4171,15 +4150,11 @@ class Service {
|
| }
|
| }
|
|
|
| -/**
|
| - * `SourceContext` represents information about the source of a
|
| - * protobuf element, like the file in which it is defined.
|
| - */
|
| +/// `SourceContext` represents information about the source of a
|
| +/// protobuf element, like the file in which it is defined.
|
| class SourceContext {
|
| - /**
|
| - * The path-qualified name of the .proto file that contained the associated
|
| - * protobuf element. For example: `"google/protobuf/source_context.proto"`.
|
| - */
|
| + /// The path-qualified name of the .proto file that contained the associated
|
| + /// protobuf element. For example: `"google/protobuf/source_context.proto"`.
|
| core.String fileName;
|
|
|
| SourceContext();
|
| @@ -4191,7 +4166,8 @@ class SourceContext {
|
| }
|
|
|
| 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 (fileName != null) {
|
| _json["fileName"] = fileName;
|
| }
|
| @@ -4199,14 +4175,12 @@ class SourceContext {
|
| }
|
| }
|
|
|
| -/** Source information used to create a Service Config */
|
| +/// Source information used to create a Service Config
|
| class SourceInfo {
|
| - /**
|
| - * All files used during config generation.
|
| - *
|
| - * The values for Object must be JSON objects. It can consist of `num`,
|
| - * `String`, `bool` and `null` as well as `Map` and `List` values.
|
| - */
|
| + /// All files used during config generation.
|
| + ///
|
| + /// 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>> sourceFiles;
|
|
|
| SourceInfo();
|
| @@ -4218,7 +4192,8 @@ class SourceInfo {
|
| }
|
|
|
| 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 (sourceFiles != null) {
|
| _json["sourceFiles"] = sourceFiles;
|
| }
|
| @@ -4226,78 +4201,81 @@ class SourceInfo {
|
| }
|
| }
|
|
|
| -/**
|
| - * 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();
|
| @@ -4315,7 +4293,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;
|
| }
|
| @@ -4329,22 +4308,21 @@ class Status {
|
| }
|
| }
|
|
|
| -/** Represents the status of one operation step. */
|
| +/// Represents the status of one operation step.
|
| class Step {
|
| - /** The short description of the step. */
|
| + /// The short description of the step.
|
| core.String description;
|
| - /**
|
| - * The status code.
|
| - * Possible string values are:
|
| - * - "STATUS_UNSPECIFIED" : Unspecifed code.
|
| - * - "DONE" : The operation or step has completed without errors.
|
| - * - "NOT_STARTED" : The operation or step has not started yet.
|
| - * - "IN_PROGRESS" : The operation or step is in progress.
|
| - * - "FAILED" : The operation or step has completed with errors. If the
|
| - * operation is
|
| - * rollbackable, the rollback completed with errors too.
|
| - * - "CANCELLED" : The operation or step has completed with cancellation.
|
| - */
|
| +
|
| + /// The status code.
|
| + /// Possible string values are:
|
| + /// - "STATUS_UNSPECIFIED" : Unspecifed code.
|
| + /// - "DONE" : The operation or step has completed without errors.
|
| + /// - "NOT_STARTED" : The operation or step has not started yet.
|
| + /// - "IN_PROGRESS" : The operation or step is in progress.
|
| + /// - "FAILED" : The operation or step has completed with errors. If the
|
| + /// operation is
|
| + /// rollbackable, the rollback completed with errors too.
|
| + /// - "CANCELLED" : The operation or step has completed with cancellation.
|
| core.String status;
|
|
|
| Step();
|
| @@ -4359,7 +4337,8 @@ class Step {
|
| }
|
|
|
| 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;
|
| }
|
| @@ -4370,25 +4349,22 @@ class Step {
|
| }
|
| }
|
|
|
| -/**
|
| - * Define a parameter's name and location. The parameter may be passed as either
|
| - * an HTTP header or a URL query parameter, and if both are passed the behavior
|
| - * is implementation-dependent.
|
| - */
|
| +/// Define a parameter's name and location. The parameter may be passed as
|
| +/// either
|
| +/// an HTTP header or a URL query parameter, and if both are passed the
|
| +/// behavior
|
| +/// is implementation-dependent.
|
| class SystemParameter {
|
| - /**
|
| - * Define the HTTP header name to use for the parameter. It is case
|
| - * insensitive.
|
| - */
|
| + /// Define the HTTP header name to use for the parameter. It is case
|
| + /// insensitive.
|
| core.String httpHeader;
|
| - /**
|
| - * Define the name of the parameter, such as "api_key" . It is case sensitive.
|
| - */
|
| +
|
| + /// Define the name of the parameter, such as "api_key" . It is case
|
| + /// sensitive.
|
| core.String name;
|
| - /**
|
| - * Define the URL query parameter name to use for the parameter. It is case
|
| - * sensitive.
|
| - */
|
| +
|
| + /// Define the URL query parameter name to use for the parameter. It is case
|
| + /// sensitive.
|
| core.String urlQueryParameter;
|
|
|
| SystemParameter();
|
| @@ -4406,7 +4382,8 @@ class SystemParameter {
|
| }
|
|
|
| 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 (httpHeader != null) {
|
| _json["httpHeader"] = httpHeader;
|
| }
|
| @@ -4420,32 +4397,29 @@ class SystemParameter {
|
| }
|
| }
|
|
|
| -/**
|
| - * Define a system parameter rule mapping system parameter definitions to
|
| - * methods.
|
| - */
|
| +/// Define a system parameter rule mapping system parameter definitions to
|
| +/// methods.
|
| class SystemParameterRule {
|
| - /**
|
| - * Define parameters. Multiple names may be defined for a parameter.
|
| - * For a given method call, only one of them should be used. If multiple
|
| - * names are used the behavior is implementation-dependent.
|
| - * If none of the specified names are present the behavior is
|
| - * parameter-dependent.
|
| - */
|
| + /// Define parameters. Multiple names may be defined for a parameter.
|
| + /// For a given method call, only one of them should be used. If multiple
|
| + /// names are used the behavior is implementation-dependent.
|
| + /// If none of the specified names are present the behavior is
|
| + /// parameter-dependent.
|
| core.List<SystemParameter> parameters;
|
| - /**
|
| - * Selects the methods to which this rule applies. Use '*' to indicate all
|
| - * methods in all APIs.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects the methods to which this rule applies. Use '*' to indicate all
|
| + /// methods in all APIs.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| SystemParameterRule();
|
|
|
| SystemParameterRule.fromJson(core.Map _json) {
|
| if (_json.containsKey("parameters")) {
|
| - parameters = _json["parameters"].map((value) => new SystemParameter.fromJson(value)).toList();
|
| + parameters = _json["parameters"]
|
| + .map((value) => new SystemParameter.fromJson(value))
|
| + .toList();
|
| }
|
| if (_json.containsKey("selector")) {
|
| selector = _json["selector"];
|
| @@ -4453,9 +4427,11 @@ class SystemParameterRule {
|
| }
|
|
|
| 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 (parameters != null) {
|
| - _json["parameters"] = parameters.map((value) => (value).toJson()).toList();
|
| + _json["parameters"] =
|
| + parameters.map((value) => (value).toJson()).toList();
|
| }
|
| if (selector != null) {
|
| _json["selector"] = selector;
|
| @@ -4464,58 +4440,57 @@ class SystemParameterRule {
|
| }
|
| }
|
|
|
| -/**
|
| - * ### System parameter configuration
|
| - *
|
| - * A system parameter is a special kind of parameter defined by the API
|
| - * system, not by an individual API. It is typically mapped to an HTTP header
|
| - * and/or a URL query parameter. This configuration specifies which methods
|
| - * change the names of the system parameters.
|
| - */
|
| +/// ### System parameter configuration
|
| +///
|
| +/// A system parameter is a special kind of parameter defined by the API
|
| +/// system, not by an individual API. It is typically mapped to an HTTP header
|
| +/// and/or a URL query parameter. This configuration specifies which methods
|
| +/// change the names of the system parameters.
|
| class SystemParameters {
|
| - /**
|
| - * Define system parameters.
|
| - *
|
| - * The parameters defined here will override the default parameters
|
| - * implemented by the system. If this field is missing from the service
|
| - * config, default system parameters will be used. Default system parameters
|
| - * and names is implementation-dependent.
|
| - *
|
| - * Example: define api key for all methods
|
| - *
|
| - * system_parameters
|
| - * rules:
|
| - * - selector: "*"
|
| - * parameters:
|
| - * - name: api_key
|
| - * url_query_parameter: api_key
|
| - *
|
| - *
|
| - * Example: define 2 api key names for a specific method.
|
| - *
|
| - * system_parameters
|
| - * rules:
|
| - * - selector: "/ListShelves"
|
| - * parameters:
|
| - * - name: api_key
|
| - * http_header: Api-Key1
|
| - * - name: api_key
|
| - * http_header: Api-Key2
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| + /// Define system parameters.
|
| + ///
|
| + /// The parameters defined here will override the default parameters
|
| + /// implemented by the system. If this field is missing from the service
|
| + /// config, default system parameters will be used. Default system parameters
|
| + /// and names is implementation-dependent.
|
| + ///
|
| + /// Example: define api key for all methods
|
| + ///
|
| + /// system_parameters
|
| + /// rules:
|
| + /// - selector: "*"
|
| + /// parameters:
|
| + /// - name: api_key
|
| + /// url_query_parameter: api_key
|
| + ///
|
| + ///
|
| + /// Example: define 2 api key names for a specific method.
|
| + ///
|
| + /// system_parameters
|
| + /// rules:
|
| + /// - selector: "/ListShelves"
|
| + /// parameters:
|
| + /// - name: api_key
|
| + /// http_header: Api-Key1
|
| + /// - name: api_key
|
| + /// http_header: Api-Key2
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<SystemParameterRule> rules;
|
|
|
| SystemParameters();
|
|
|
| SystemParameters.fromJson(core.Map _json) {
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new SystemParameterRule.fromJson(value)).toList();
|
| + rules = _json["rules"]
|
| + .map((value) => new SystemParameterRule.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 (rules != null) {
|
| _json["rules"] = rules.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -4523,31 +4498,35 @@ class SystemParameters {
|
| }
|
| }
|
|
|
| -/** A protocol buffer message type. */
|
| +/// A protocol buffer message type.
|
| class Type {
|
| - /** The list of fields. */
|
| + /// The list of fields.
|
| core.List<Field> fields;
|
| - /** The fully qualified message name. */
|
| +
|
| + /// The fully qualified message name.
|
| core.String name;
|
| - /** The list of types appearing in `oneof` definitions in this type. */
|
| +
|
| + /// The list of types appearing in `oneof` definitions in this type.
|
| core.List<core.String> oneofs;
|
| - /** The protocol buffer options. */
|
| +
|
| + /// The protocol buffer options.
|
| core.List<Option> options;
|
| - /** The source context. */
|
| +
|
| + /// The source context.
|
| SourceContext sourceContext;
|
| - /**
|
| - * The source syntax.
|
| - * Possible string values are:
|
| - * - "SYNTAX_PROTO2" : Syntax `proto2`.
|
| - * - "SYNTAX_PROTO3" : Syntax `proto3`.
|
| - */
|
| +
|
| + /// The source syntax.
|
| + /// Possible string values are:
|
| + /// - "SYNTAX_PROTO2" : Syntax `proto2`.
|
| + /// - "SYNTAX_PROTO3" : Syntax `proto3`.
|
| core.String syntax;
|
|
|
| Type();
|
|
|
| Type.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();
|
| }
|
| if (_json.containsKey("name")) {
|
| name = _json["name"];
|
| @@ -4556,7 +4535,8 @@ class Type {
|
| oneofs = _json["oneofs"];
|
| }
|
| if (_json.containsKey("options")) {
|
| - options = _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| + options =
|
| + _json["options"].map((value) => new Option.fromJson(value)).toList();
|
| }
|
| if (_json.containsKey("sourceContext")) {
|
| sourceContext = new SourceContext.fromJson(_json["sourceContext"]);
|
| @@ -4567,7 +4547,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 (fields != null) {
|
| _json["fields"] = fields.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -4590,30 +4571,27 @@ class Type {
|
| }
|
| }
|
|
|
| -/** Configuration controlling usage of a service. */
|
| +/// Configuration controlling usage of a service.
|
| class Usage {
|
| - /**
|
| - * The full resource name of a channel used for sending notifications to the
|
| - * service producer.
|
| - *
|
| - * Google Service Management currently only supports
|
| - * [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
|
| - * channel. To use Google Cloud Pub/Sub as the channel, this must be the name
|
| - * of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
|
| - * documented in https://cloud.google.com/pubsub/docs/overview.
|
| - */
|
| + /// The full resource name of a channel used for sending notifications to the
|
| + /// service producer.
|
| + ///
|
| + /// Google Service Management currently only supports
|
| + /// [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification
|
| + /// channel. To use Google Cloud Pub/Sub as the channel, this must be the
|
| + /// name
|
| + /// of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format
|
| + /// documented in https://cloud.google.com/pubsub/docs/overview.
|
| core.String producerNotificationChannel;
|
| - /**
|
| - * Requirements that must be satisfied before a consumer project can use the
|
| - * service. Each requirement is of the form <service.name>/<requirement-id>;
|
| - * for example 'serviceusage.googleapis.com/billing-enabled'.
|
| - */
|
| +
|
| + /// Requirements that must be satisfied before a consumer project can use the
|
| + /// service. Each requirement is of the form <service.name>/<requirement-id>;
|
| + /// for example 'serviceusage.googleapis.com/billing-enabled'.
|
| core.List<core.String> requirements;
|
| - /**
|
| - * A list of usage rules that apply to individual API methods.
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| +
|
| + /// A list of usage rules that apply to individual API methods.
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<UsageRule> rules;
|
|
|
| Usage();
|
| @@ -4626,12 +4604,14 @@ class Usage {
|
| requirements = _json["requirements"];
|
| }
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new UsageRule.fromJson(value)).toList();
|
| + rules =
|
| + _json["rules"].map((value) => new UsageRule.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 (producerNotificationChannel != null) {
|
| _json["producerNotificationChannel"] = producerNotificationChannel;
|
| }
|
| @@ -4645,47 +4625,45 @@ class Usage {
|
| }
|
| }
|
|
|
| -/**
|
| - * Usage configuration rules for the service.
|
| - *
|
| - * NOTE: Under development.
|
| - *
|
| - *
|
| - * Use this rule to configure unregistered calls for the service. Unregistered
|
| - * calls are calls that do not contain consumer project identity.
|
| - * (Example: calls that do not contain an API key).
|
| - * By default, API methods do not allow unregistered calls, and each method call
|
| - * must be identified by a consumer project identity. Use this rule to
|
| - * allow/disallow unregistered calls.
|
| - *
|
| - * Example of an API that wants to allow unregistered calls for entire service.
|
| - *
|
| - * usage:
|
| - * rules:
|
| - * - selector: "*"
|
| - * allow_unregistered_calls: true
|
| - *
|
| - * Example of a method that wants to allow unregistered calls.
|
| - *
|
| - * usage:
|
| - * rules:
|
| - * - selector: "google.example.library.v1.LibraryService.CreateBook"
|
| - * allow_unregistered_calls: true
|
| - */
|
| +/// Usage configuration rules for the service.
|
| +///
|
| +/// NOTE: Under development.
|
| +///
|
| +///
|
| +/// Use this rule to configure unregistered calls for the service. Unregistered
|
| +/// calls are calls that do not contain consumer project identity.
|
| +/// (Example: calls that do not contain an API key).
|
| +/// By default, API methods do not allow unregistered calls, and each method
|
| +/// call
|
| +/// must be identified by a consumer project identity. Use this rule to
|
| +/// allow/disallow unregistered calls.
|
| +///
|
| +/// Example of an API that wants to allow unregistered calls for entire
|
| +/// service.
|
| +///
|
| +/// usage:
|
| +/// rules:
|
| +/// - selector: "*"
|
| +/// allow_unregistered_calls: true
|
| +///
|
| +/// Example of a method that wants to allow unregistered calls.
|
| +///
|
| +/// usage:
|
| +/// rules:
|
| +/// - selector: "google.example.library.v1.LibraryService.CreateBook"
|
| +/// allow_unregistered_calls: true
|
| class UsageRule {
|
| - /** True, if the method allows unregistered calls; false otherwise. */
|
| + /// True, if the method allows unregistered calls; false otherwise.
|
| core.bool allowUnregisteredCalls;
|
| - /**
|
| - * Selects the methods to which this rule applies. Use '*' to indicate all
|
| - * methods in all APIs.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects the methods to which this rule applies. Use '*' to indicate all
|
| + /// methods in all APIs.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
| - /**
|
| - * True, if the method should skip service control. If so, no control plane
|
| - * feature (like quota and billing) will be enabled.
|
| - */
|
| +
|
| + /// True, if the method should skip service control. If so, no control plane
|
| + /// feature (like quota and billing) will be enabled.
|
| core.bool skipServiceControl;
|
|
|
| UsageRule();
|
| @@ -4703,7 +4681,8 @@ class UsageRule {
|
| }
|
|
|
| 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 (allowUnregisteredCalls != null) {
|
| _json["allowUnregisteredCalls"] = allowUnregisteredCalls;
|
| }
|
| @@ -4717,48 +4696,47 @@ class UsageRule {
|
| }
|
| }
|
|
|
| -/**
|
| - * `Visibility` defines restrictions for the visibility of service
|
| - * elements. Restrictions are specified using visibility labels
|
| - * (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
|
| - *
|
| - * Users and projects can have access to more than one visibility label. The
|
| - * effective visibility for multiple labels is the union of each label's
|
| - * elements, plus any unrestricted elements.
|
| - *
|
| - * If an element and its parents have no restrictions, visibility is
|
| - * unconditionally granted.
|
| - *
|
| - * Example:
|
| - *
|
| - * visibility:
|
| - * rules:
|
| - * - selector: google.calendar.Calendar.EnhancedSearch
|
| - * restriction: TRUSTED_TESTER
|
| - * - selector: google.calendar.Calendar.Delegate
|
| - * restriction: GOOGLE_INTERNAL
|
| - *
|
| - * Here, all methods are publicly visible except for the restricted methods
|
| - * EnhancedSearch and Delegate.
|
| - */
|
| +/// `Visibility` defines restrictions for the visibility of service
|
| +/// elements. Restrictions are specified using visibility labels
|
| +/// (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.
|
| +///
|
| +/// Users and projects can have access to more than one visibility label. The
|
| +/// effective visibility for multiple labels is the union of each label's
|
| +/// elements, plus any unrestricted elements.
|
| +///
|
| +/// If an element and its parents have no restrictions, visibility is
|
| +/// unconditionally granted.
|
| +///
|
| +/// Example:
|
| +///
|
| +/// visibility:
|
| +/// rules:
|
| +/// - selector: google.calendar.Calendar.EnhancedSearch
|
| +/// restriction: TRUSTED_TESTER
|
| +/// - selector: google.calendar.Calendar.Delegate
|
| +/// restriction: GOOGLE_INTERNAL
|
| +///
|
| +/// Here, all methods are publicly visible except for the restricted methods
|
| +/// EnhancedSearch and Delegate.
|
| class Visibility {
|
| - /**
|
| - * A list of visibility rules that apply to individual API elements.
|
| - *
|
| - * **NOTE:** All service configuration rules follow "last one wins" order.
|
| - */
|
| + /// A list of visibility rules that apply to individual API elements.
|
| + ///
|
| + /// **NOTE:** All service configuration rules follow "last one wins" order.
|
| core.List<VisibilityRule> rules;
|
|
|
| Visibility();
|
|
|
| Visibility.fromJson(core.Map _json) {
|
| if (_json.containsKey("rules")) {
|
| - rules = _json["rules"].map((value) => new VisibilityRule.fromJson(value)).toList();
|
| + rules = _json["rules"]
|
| + .map((value) => new VisibilityRule.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 (rules != null) {
|
| _json["rules"] = rules.map((value) => (value).toJson()).toList();
|
| }
|
| @@ -4766,34 +4744,30 @@ class Visibility {
|
| }
|
| }
|
|
|
| -/**
|
| - * A visibility rule provides visibility configuration for an individual API
|
| - * element.
|
| - */
|
| +/// A visibility rule provides visibility configuration for an individual API
|
| +/// element.
|
| class VisibilityRule {
|
| - /**
|
| - * A comma-separated list of visibility labels that apply to the `selector`.
|
| - * Any of the listed labels can be used to grant the visibility.
|
| - *
|
| - * If a rule has multiple labels, removing one of the labels but not all of
|
| - * them can break clients.
|
| - *
|
| - * Example:
|
| - *
|
| - * visibility:
|
| - * rules:
|
| - * - selector: google.calendar.Calendar.EnhancedSearch
|
| - * restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
|
| - *
|
| - * Removing GOOGLE_INTERNAL from this restriction will break clients that
|
| - * rely on this method and only had access to it through GOOGLE_INTERNAL.
|
| - */
|
| + /// A comma-separated list of visibility labels that apply to the `selector`.
|
| + /// Any of the listed labels can be used to grant the visibility.
|
| + ///
|
| + /// If a rule has multiple labels, removing one of the labels but not all of
|
| + /// them can break clients.
|
| + ///
|
| + /// Example:
|
| + ///
|
| + /// visibility:
|
| + /// rules:
|
| + /// - selector: google.calendar.Calendar.EnhancedSearch
|
| + /// restriction: GOOGLE_INTERNAL, TRUSTED_TESTER
|
| + ///
|
| + /// Removing GOOGLE_INTERNAL from this restriction will break clients that
|
| + /// rely on this method and only had access to it through GOOGLE_INTERNAL.
|
| core.String restriction;
|
| - /**
|
| - * Selects methods, messages, fields, enums, etc. to which this rule applies.
|
| - *
|
| - * Refer to selector for syntax details.
|
| - */
|
| +
|
| + /// Selects methods, messages, fields, enums, etc. to which this rule
|
| + /// applies.
|
| + ///
|
| + /// Refer to selector for syntax details.
|
| core.String selector;
|
|
|
| VisibilityRule();
|
| @@ -4808,7 +4782,8 @@ class VisibilityRule {
|
| }
|
|
|
| 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 (restriction != null) {
|
| _json["restriction"] = restriction;
|
| }
|
|
|
Chromium Code Reviews
Issue 3006323002:
Api-Roll 54: 2017-09-11 (Closed)
