Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: generated/googleapis/lib/servicemanagement/v1.dart

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « generated/googleapis/lib/servicecontrol/v1.dart ('k') | generated/googleapis/lib/serviceuser/v1.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: generated/googleapis/lib/servicemanagement/v1.dart
diff --git a/generated/googleapis/lib/servicemanagement/v1.dart b/generated/googleapis/lib/servicemanagement/v1.dart
index e4cc9a8fd0b6c8951cea9c67eff54baabeda163e..e916e082f9a5ee7fabb44eafb9ddf755a7a9aff5 100644
--- a/generated/googleapis/lib/servicemanagement/v1.dart
+++ b/generated/googleapis/lib/servicemanagement/v1.dart
@@ -9,64 +9,65 @@ 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 servicemanagement/v1';
-/**
- * Google Service Management allows service producers to publish their services
- * on Google Cloud Platform so that they can be discovered and used by service
- * consumers.
- */
+/// Google Service Management allows service producers to publish their
+/// services on Google Cloud Platform so that they can be discovered and used
+/// by service consumers.
class ServicemanagementApi {
- /** 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";
+ /// 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 Google API service configuration */
- static const ServiceManagementReadonlyScope = "https://www.googleapis.com/auth/service.management.readonly";
+ /// Manage your Google API service configuration
+ static const ServiceManagementScope =
+ "https://www.googleapis.com/auth/service.management";
+ /// View your Google API service configuration
+ static const ServiceManagementReadonlyScope =
+ "https://www.googleapis.com/auth/service.management.readonly";
final commons.ApiRequester _requester;
OperationsResourceApi get operations => new OperationsResourceApi(_requester);
ServicesResourceApi get services => new ServicesResourceApi(_requester);
- ServicemanagementApi(http_1.Client client, {core.String rootUrl: "https://servicemanagement.googleapis.com/", core.String servicePath: ""}) :
- _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
+ ServicemanagementApi(http_1.Client client,
+ {core.String rootUrl: "https://servicemanagement.googleapis.com/",
+ core.String servicePath: ""})
+ : _requester =
+ new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}
-
class OperationsResourceApi {
final commons.ApiRequester _requester;
- OperationsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Gets the latest state of a long-running operation. Clients can use this
- * method to poll the operation result at intervals as recommended by the API
- * service.
- *
- * Request parameters:
- *
- * [name] - The name of the operation resource.
- * Value must have pattern "^operations/.+$".
- *
- * 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.
- */
+ OperationsResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Gets the latest state of a long-running operation. Clients can use this
+ /// method to poll the operation result at intervals as recommended by the
+ /// API
+ /// service.
+ ///
+ /// Request parameters:
+ ///
+ /// [name] - The name of the operation resource.
+ /// Value must have pattern "^operations/.+$".
+ ///
+ /// 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> get(core.String name) {
var _url = null;
var _queryParams = new core.Map();
@@ -81,60 +82,61 @@ class OperationsResourceApi {
_url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name');
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
- /**
- * Lists service operations that match the specified filter in the request.
- *
- * Request parameters:
- *
- * [pageSize] - The maximum number of operations to return. If unspecified,
- * defaults to
- * 50. The maximum value is 100.
- *
- * [filter] - A string for filtering Operations.
- * The following filter fields are supported&#58;
- *
- * * serviceName&#58; Required. Only `=` operator is allowed.
- * * startTime&#58; The time this job was started, in ISO 8601 format.
- * Allowed operators are `>=`, `>`, `<=`, and `<`.
- * * status&#58; Can be `done`, `in_progress`, or `failed`. Allowed
- * operators are `=`, and `!=`.
- *
- * Filter expression supports conjunction (AND) and disjunction (OR)
- * logical operators. However, the serviceName restriction must be at the
- * top-level and can only be combined with other restrictions via the AND
- * logical operator.
- *
- * Examples&#58;
- *
- * * `serviceName={some-service}.googleapis.com`
- * * `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"`
- * * `serviceName={some-service}.googleapis.com AND status=done`
- * * `serviceName={some-service}.googleapis.com AND (status=done OR
- * startTime>="2017-02-01")`
- *
- * [pageToken] - The standard list page token.
- *
- * [name] - Not used.
- *
- * Completes with a [ListOperationsResponse].
- *
- * 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<ListOperationsResponse> list({core.int pageSize, core.String filter, core.String pageToken, core.String name}) {
+ /// Lists service operations that match the specified filter in the request.
+ ///
+ /// Request parameters:
+ ///
+ /// [pageToken] - The standard list page token.
+ ///
+ /// [name] - Not used.
+ ///
+ /// [pageSize] - The maximum number of operations to return. If unspecified,
+ /// defaults to
+ /// 50. The maximum value is 100.
+ ///
+ /// [filter] - A string for filtering Operations.
+ /// The following filter fields are supported&#58;
+ ///
+ /// * serviceName&#58; Required. Only `=` operator is allowed.
+ /// * startTime&#58; The time this job was started, in ISO 8601 format.
+ /// Allowed operators are `>=`, `>`, `<=`, and `<`.
+ /// * status&#58; Can be `done`, `in_progress`, or `failed`. Allowed
+ /// operators are `=`, and `!=`.
+ ///
+ /// Filter expression supports conjunction (AND) and disjunction (OR)
+ /// logical operators. However, the serviceName restriction must be at the
+ /// top-level and can only be combined with other restrictions via the AND
+ /// logical operator.
+ ///
+ /// Examples&#58;
+ ///
+ /// * `serviceName={some-service}.googleapis.com`
+ /// * `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"`
+ /// * `serviceName={some-service}.googleapis.com AND status=done`
+ /// * `serviceName={some-service}.googleapis.com AND (status=done OR
+ /// startTime>="2017-02-01")`
+ ///
+ /// Completes with a [ListOperationsResponse].
+ ///
+ /// 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<ListOperationsResponse> list(
+ {core.String pageToken,
+ core.String name,
+ core.int pageSize,
+ core.String filter}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -142,62 +144,59 @@ class OperationsResourceApi {
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
- if (pageSize != null) {
- _queryParams["pageSize"] = ["${pageSize}"];
- }
- if (filter != null) {
- _queryParams["filter"] = [filter];
- }
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (name != null) {
_queryParams["name"] = [name];
}
+ if (pageSize != null) {
+ _queryParams["pageSize"] = ["${pageSize}"];
+ }
+ if (filter != null) {
+ _queryParams["filter"] = [filter];
+ }
_url = 'v1/operations';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new ListOperationsResponse.fromJson(data));
}
-
}
-
class ServicesResourceApi {
final commons.ApiRequester _requester;
- ServicesConfigsResourceApi get configs => new ServicesConfigsResourceApi(_requester);
- ServicesConsumersResourceApi get consumers => new ServicesConsumersResourceApi(_requester);
- ServicesRolloutsResourceApi get rollouts => new ServicesRolloutsResourceApi(_requester);
-
- ServicesResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Creates a new managed service.
- * Please note one producer project can own no more than 20 services.
- *
- * Operation<response: ManagedService>
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * 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.
- */
+ ServicesConfigsResourceApi get configs =>
+ new ServicesConfigsResourceApi(_requester);
+ ServicesConsumersResourceApi get consumers =>
+ new ServicesConsumersResourceApi(_requester);
+ ServicesRolloutsResourceApi get rollouts =>
+ new ServicesRolloutsResourceApi(_requester);
+
+ ServicesResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Creates a new managed service.
+ /// Please note one producer project can own no more than 20 services.
+ ///
+ /// Operation<response: ManagedService>
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// 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> create(ManagedService request) {
var _url = null;
var _queryParams = new core.Map();
@@ -212,38 +211,36 @@ class ServicesResourceApi {
_url = 'v1/services';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
- /**
- * Deletes a managed service. This method will change the service to the
- * `Soft-Delete` state for 30 days. Within this period, service producers may
- * call UndeleteService to restore the service.
- * After 30 days, the service will be permanently deleted.
- *
- * Operation<response: google.protobuf.Empty>
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * 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.
- */
+ /// Deletes a managed service. This method will change the service to the
+ /// `Soft-Delete` state for 30 days. Within this period, service producers
+ /// may
+ /// call UndeleteService to restore the service.
+ /// After 30 days, the service will be permanently deleted.
+ ///
+ /// Operation<response: google.protobuf.Empty>
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// 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> delete(core.String serviceName) {
var _url = null;
var _queryParams = new core.Map();
@@ -258,40 +255,38 @@ class ServicesResourceApi {
_url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName');
- var _response = _requester.request(_url,
- "DELETE",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "DELETE",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Operation.fromJson(data));
}
- /**
- * Disables a service for a project, so it can no longer be
- * be used for the project. It prevents accidental usage that may cause
- * unexpected billing charges or security leaks.
- *
- * Operation<response: DisableServiceResponse>
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [serviceName] - Name of the service to disable. Specifying an unknown
- * service name
- * will cause the request to fail.
- *
- * 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 serviceName) {
+ /// Disables a service for a project, so it can no longer be
+ /// be used for the project. It prevents accidental usage that may cause
+ /// unexpected billing charges or security leaks.
+ ///
+ /// Operation<response: DisableServiceResponse>
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - Name of the service to disable. Specifying an unknown
+ /// service name
+ /// will cause the request to fail.
+ ///
+ /// 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 serviceName) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -306,43 +301,43 @@ class ServicesResourceApi {
throw new core.ArgumentError("Parameter serviceName is required.");
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + ':disable';
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ ':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));
}
- /**
- * Enables a service for a project, so it can be used
- * for the project. See
- * [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
- * more information.
- *
- * Operation<response: EnableServiceResponse>
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [serviceName] - Name of the service to enable. Specifying an unknown
- * service name will
- * cause the request to fail.
- *
- * 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 serviceName) {
+ /// Enables a service for a project, so it can be used
+ /// for the project. See
+ /// [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
+ /// more information.
+ ///
+ /// Operation<response: EnableServiceResponse>
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - Name of the service to enable. Specifying an unknown
+ /// service name will
+ /// cause the request to fail.
+ ///
+ /// 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 serviceName) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -357,44 +352,45 @@ class ServicesResourceApi {
throw new core.ArgumentError("Parameter serviceName is required.");
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + ':enable';
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ ':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));
}
- /**
- * Generates and returns a report (errors, warnings and changes from
- * existing configurations) associated with
- * GenerateConfigReportRequest.new_value
- *
- * If GenerateConfigReportRequest.old_value is specified,
- * GenerateConfigReportRequest will contain a single ChangeReport based on the
- * comparison between GenerateConfigReportRequest.new_value and
- * GenerateConfigReportRequest.old_value.
- * If GenerateConfigReportRequest.old_value is not specified, this method
- * will compare GenerateConfigReportRequest.new_value with the last pushed
- * service configuration.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * Completes with a [GenerateConfigReportResponse].
- *
- * 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<GenerateConfigReportResponse> generateConfigReport(GenerateConfigReportRequest request) {
+ /// Generates and returns a report (errors, warnings and changes from
+ /// existing configurations) associated with
+ /// GenerateConfigReportRequest.new_value
+ ///
+ /// If GenerateConfigReportRequest.old_value is specified,
+ /// GenerateConfigReportRequest will contain a single ChangeReport based on
+ /// the
+ /// comparison between GenerateConfigReportRequest.new_value and
+ /// GenerateConfigReportRequest.old_value.
+ /// If GenerateConfigReportRequest.old_value is not specified, this method
+ /// will compare GenerateConfigReportRequest.new_value with the last pushed
+ /// service configuration.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// Completes with a [GenerateConfigReportResponse].
+ ///
+ /// 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<GenerateConfigReportResponse> generateConfigReport(
+ GenerateConfigReportRequest request) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -408,34 +404,32 @@ class ServicesResourceApi {
_url = 'v1/services:generateConfigReport';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new GenerateConfigReportResponse.fromJson(data));
- }
-
- /**
- * Gets a managed service. Authentication is required unless the service is
- * public.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the `ServiceManager` overview
- * for naming
- * requirements. For example: `example.googleapis.com`.
- *
- * Completes with a [ManagedService].
- *
- * 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.
- */
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new GenerateConfigReportResponse.fromJson(data));
+ }
+
+ /// Gets a managed service. Authentication is required unless the service is
+ /// public.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the `ServiceManager`
+ /// overview for naming
+ /// requirements. For example: `example.googleapis.com`.
+ ///
+ /// Completes with a [ManagedService].
+ ///
+ /// 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<ManagedService> get(core.String serviceName) {
var _url = null;
var _queryParams = new core.Map();
@@ -450,43 +444,41 @@ class ServicesResourceApi {
_url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName');
- 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 ManagedService.fromJson(data));
}
- /**
- * Gets a service configuration (version) for a managed service.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * [configId] - The id of the service configuration resource.
- *
- * [view] - Specifies which parts of the Service Config should be returned in
- * the
- * response.
- * Possible string values are:
- * - "BASIC" : A BASIC.
- * - "FULL" : A FULL.
- *
- * Completes with a [Service].
- *
- * 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<Service> getConfig(core.String serviceName, {core.String configId, core.String view}) {
+ /// Gets a service configuration (version) for a managed service.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// [view] - Specifies which parts of the Service Config should be returned
+ /// in the
+ /// response.
+ /// Possible string values are:
+ /// - "BASIC" : A BASIC.
+ /// - "FULL" : A FULL.
+ ///
+ /// [configId] - The id of the service configuration resource.
+ ///
+ /// Completes with a [Service].
+ ///
+ /// 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<Service> getConfig(core.String serviceName,
+ {core.String view, core.String configId}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -497,48 +489,48 @@ class ServicesResourceApi {
if (serviceName == null) {
throw new core.ArgumentError("Parameter serviceName is required.");
}
- if (configId != null) {
- _queryParams["configId"] = [configId];
- }
if (view != null) {
_queryParams["view"] = [view];
}
+ if (configId != null) {
+ _queryParams["configId"] = [configId];
+ }
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + '/config';
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ '/config';
- 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 Service.fromJson(data));
}
- /**
- * Gets the access control policy for a resource.
- * Returns an empty policy if the resource exists and does not have a policy
- * set.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy is being
- * requested.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^services/[^/]+$".
- *
- * Completes with a [Policy].
- *
- * 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<Policy> getIamPolicy(GetIamPolicyRequest request, core.String resource) {
+ /// Gets the access control policy for a resource.
+ /// Returns an empty policy if the resource exists and does not have a policy
+ /// set.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy is being
+ /// requested.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^services/[^/]+$".
+ ///
+ /// Completes with a [Policy].
+ ///
+ /// 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<Policy> getIamPolicy(
+ GetIamPolicyRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -553,54 +545,57 @@ class ServicesResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':getIamPolicy';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':getIamPolicy';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Policy.fromJson(data));
}
- /**
- * Lists managed services.
- *
- * Returns all public services. For authenticated users, also returns all
- * services the calling user has "servicemanagement.services.get" permission
- * for.
- *
- * **BETA:** If the caller specifies the `consumer_id`, it returns only the
- * services enabled on the consumer. The `consumer_id` must have the format
- * of "project:{PROJECT-ID}".
- *
- * Request parameters:
- *
- * [pageSize] - Requested size of the next page of data.
- *
- * [producerProjectId] - Include services produced by the specified project.
- *
- * [consumerId] - Include services consumed by the specified consumer.
- *
- * The Google Service Management implementation accepts the following
- * forms:
- * - project:<project_id>
- *
- * [pageToken] - Token identifying which result to start with; returned by a
- * previous list
- * call.
- *
- * Completes with a [ListServicesResponse].
- *
- * 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<ListServicesResponse> list({core.int pageSize, core.String producerProjectId, core.String consumerId, core.String pageToken}) {
+ /// Lists managed services.
+ ///
+ /// Returns all public services. For authenticated users, also returns all
+ /// services the calling user has "servicemanagement.services.get" permission
+ /// for.
+ ///
+ /// **BETA:** If the caller specifies the `consumer_id`, it returns only the
+ /// services enabled on the consumer. The `consumer_id` must have the format
+ /// of "project:{PROJECT-ID}".
+ ///
+ /// Request parameters:
+ ///
+ /// [producerProjectId] - Include services produced by the specified project.
+ ///
+ /// [consumerId] - Include services consumed by the specified consumer.
+ ///
+ /// The Google Service Management implementation accepts the following
+ /// forms:
+ /// - project:<project_id>
+ ///
+ /// [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 [ListServicesResponse].
+ ///
+ /// 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<ListServicesResponse> list(
+ {core.String producerProjectId,
+ core.String consumerId,
+ core.String pageToken,
+ core.int pageSize}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -608,9 +603,6 @@ class ServicesResourceApi {
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
- if (pageSize != null) {
- _queryParams["pageSize"] = ["${pageSize}"];
- }
if (producerProjectId != null) {
_queryParams["producerProjectId"] = [producerProjectId];
}
@@ -620,41 +612,42 @@ class ServicesResourceApi {
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
+ if (pageSize != null) {
+ _queryParams["pageSize"] = ["${pageSize}"];
+ }
_url = 'v1/services';
- 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 ListServicesResponse.fromJson(data));
}
- /**
- * Sets the access control policy on the specified resource. Replaces any
- * existing policy.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy is being
- * specified.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^services/[^/]+$".
- *
- * Completes with a [Policy].
- *
- * 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<Policy> setIamPolicy(SetIamPolicyRequest request, core.String resource) {
+ /// Sets the access control policy on the specified resource. Replaces any
+ /// existing policy.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy is being
+ /// specified.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^services/[^/]+$".
+ ///
+ /// Completes with a [Policy].
+ ///
+ /// 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<Policy> setIamPolicy(
+ SetIamPolicyRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -669,45 +662,46 @@ class ServicesResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':setIamPolicy';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':setIamPolicy';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Policy.fromJson(data));
}
- /**
- * Returns permissions that a caller has on the specified resource.
- * If the resource does not exist, this will return an empty set of
- * permissions, not a NOT_FOUND error.
- *
- * Note: This operation is designed to be used for building permission-aware
- * UIs and command-line tools, not for authorization checking. This operation
- * may "fail open" without warning.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy detail is being
- * requested.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^services/[^/]+$".
- *
- * Completes with a [TestIamPermissionsResponse].
- *
- * 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<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request, core.String resource) {
+ /// Returns permissions that a caller has on the specified resource.
+ /// If the resource does not exist, this will return an empty set of
+ /// permissions, not a NOT_FOUND error.
+ ///
+ /// Note: This operation is designed to be used for building permission-aware
+ /// UIs and command-line tools, not for authorization checking. This
+ /// operation
+ /// may "fail open" without warning.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy detail is being
+ /// requested.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^services/[^/]+$".
+ ///
+ /// Completes with a [TestIamPermissionsResponse].
+ ///
+ /// 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<TestIamPermissionsResponse> testIamPermissions(
+ TestIamPermissionsRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -722,40 +716,40 @@ class ServicesResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':testIamPermissions';
-
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new TestIamPermissionsResponse.fromJson(data));
- }
-
- /**
- * Revives a previously deleted managed service. The method restores the
- * service using the configuration at the time the service was deleted.
- * The target service must exist and must have been deleted within the
- * last 30 days.
- *
- * Operation<response: UndeleteServiceResponse>
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * 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.
- */
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':testIamPermissions';
+
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new TestIamPermissionsResponse.fromJson(data));
+ }
+
+ /// Revives a previously deleted managed service. The method restores the
+ /// service using the configuration at the time the service was deleted.
+ /// The target service must exist and must have been deleted within the
+ /// last 30 days.
+ ///
+ /// Operation<response: UndeleteServiceResponse>
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// 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> undelete(core.String serviceName) {
var _url = null;
var _queryParams = new core.Map();
@@ -768,49 +762,46 @@ class ServicesResourceApi {
throw new core.ArgumentError("Parameter serviceName is required.");
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + ':undelete';
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ ':undelete';
- 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));
}
-
}
-
class ServicesConfigsResourceApi {
final commons.ApiRequester _requester;
- ServicesConfigsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Creates a new service configuration (version) for a managed service.
- * This method only stores the service configuration. To roll out the service
- * configuration to backend systems please call
- * CreateServiceRollout.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * Completes with a [Service].
- *
- * 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.
- */
+ ServicesConfigsResourceApi(commons.ApiRequester client) : _requester = client;
+
+ /// Creates a new service configuration (version) for a managed service.
+ /// This method only stores the service configuration. To roll out the
+ /// service
+ /// configuration to backend systems please call
+ /// CreateServiceRollout.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// Completes with a [Service].
+ ///
+ /// 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<Service> create(Service request, core.String serviceName) {
var _url = null;
var _queryParams = new core.Map();
@@ -826,45 +817,45 @@ class ServicesConfigsResourceApi {
throw new core.ArgumentError("Parameter serviceName is required.");
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + '/configs';
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ '/configs';
- 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 Service.fromJson(data));
}
- /**
- * Gets a service configuration (version) for a managed service.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * [configId] - The id of the service configuration resource.
- *
- * [view] - Specifies which parts of the Service Config should be returned in
- * the
- * response.
- * Possible string values are:
- * - "BASIC" : A BASIC.
- * - "FULL" : A FULL.
- *
- * Completes with a [Service].
- *
- * 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<Service> get(core.String serviceName, core.String configId, {core.String view}) {
+ /// Gets a service configuration (version) for a managed service.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// [configId] - The id of the service configuration resource.
+ ///
+ /// [view] - Specifies which parts of the Service Config should be returned
+ /// in the
+ /// response.
+ /// Possible string values are:
+ /// - "BASIC" : A BASIC.
+ /// - "FULL" : A FULL.
+ ///
+ /// Completes with a [Service].
+ ///
+ /// 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<Service> get(core.String serviceName, core.String configId,
+ {core.String view}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -882,41 +873,42 @@ class ServicesConfigsResourceApi {
_queryParams["view"] = [view];
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + '/configs/' + commons.Escaper.ecapeVariable('$configId');
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ '/configs/' +
+ commons.Escaper.ecapeVariable('$configId');
- 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 Service.fromJson(data));
}
- /**
- * Lists the history of the service configuration for a managed service,
- * from the newest to the oldest.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * [pageToken] - The token of the page to retrieve.
- *
- * [pageSize] - The max number of items to include in the response list.
- *
- * Completes with a [ListServiceConfigsResponse].
- *
- * 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<ListServiceConfigsResponse> list(core.String serviceName, {core.String pageToken, core.int pageSize}) {
+ /// Lists the history of the service configuration for a managed service,
+ /// from the newest to the oldest.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// [pageToken] - The token of the page to retrieve.
+ ///
+ /// [pageSize] - The max number of items to include in the response list.
+ ///
+ /// Completes with a [ListServiceConfigsResponse].
+ ///
+ /// 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<ListServiceConfigsResponse> list(core.String serviceName,
+ {core.String pageToken, core.int pageSize}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -934,46 +926,48 @@ class ServicesConfigsResourceApi {
_queryParams["pageSize"] = ["${pageSize}"];
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + '/configs';
-
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new ListServiceConfigsResponse.fromJson(data));
- }
-
- /**
- * Creates a new service configuration (version) for a managed service based
- * on
- * user-supplied configuration source files (for example: OpenAPI
- * Specification). This method stores the source configurations as well as the
- * generated service configuration. To rollout the service configuration to
- * other services,
- * please call CreateServiceRollout.
- *
- * Operation<response: SubmitConfigSourceResponse>
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * 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> submit(SubmitConfigSourceRequest request, core.String serviceName) {
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ '/configs';
+
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new ListServiceConfigsResponse.fromJson(data));
+ }
+
+ /// Creates a new service configuration (version) for a managed service based
+ /// on
+ /// user-supplied configuration source files (for example: OpenAPI
+ /// Specification). This method stores the source configurations as well as
+ /// the
+ /// generated service configuration. To rollout the service configuration to
+ /// other services,
+ /// please call CreateServiceRollout.
+ ///
+ /// Operation<response: SubmitConfigSourceResponse>
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// 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> submit(
+ SubmitConfigSourceRequest request, core.String serviceName) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -988,50 +982,48 @@ class ServicesConfigsResourceApi {
throw new core.ArgumentError("Parameter serviceName is required.");
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + '/configs:submit';
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ '/configs:submit';
- 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));
}
-
}
-
class ServicesConsumersResourceApi {
final commons.ApiRequester _requester;
- ServicesConsumersResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Gets the access control policy for a resource.
- * Returns an empty policy if the resource exists and does not have a policy
- * set.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy is being
- * requested.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^services/[^/]+/consumers/[^/]+$".
- *
- * Completes with a [Policy].
- *
- * 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<Policy> getIamPolicy(GetIamPolicyRequest request, core.String resource) {
+ ServicesConsumersResourceApi(commons.ApiRequester client)
+ : _requester = client;
+
+ /// Gets the access control policy for a resource.
+ /// Returns an empty policy if the resource exists and does not have a policy
+ /// set.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy is being
+ /// requested.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^services/[^/]+/consumers/[^/]+$".
+ ///
+ /// Completes with a [Policy].
+ ///
+ /// 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<Policy> getIamPolicy(
+ GetIamPolicyRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -1046,40 +1038,40 @@ class ServicesConsumersResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':getIamPolicy';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':getIamPolicy';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Policy.fromJson(data));
}
- /**
- * Sets the access control policy on the specified resource. Replaces any
- * existing policy.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy is being
- * specified.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^services/[^/]+/consumers/[^/]+$".
- *
- * Completes with a [Policy].
- *
- * 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<Policy> setIamPolicy(SetIamPolicyRequest request, core.String resource) {
+ /// Sets the access control policy on the specified resource. Replaces any
+ /// existing policy.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy is being
+ /// specified.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^services/[^/]+/consumers/[^/]+$".
+ ///
+ /// Completes with a [Policy].
+ ///
+ /// 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<Policy> setIamPolicy(
+ SetIamPolicyRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -1094,45 +1086,46 @@ class ServicesConsumersResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':setIamPolicy';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':setIamPolicy';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
return _response.then((data) => new Policy.fromJson(data));
}
- /**
- * Returns permissions that a caller has on the specified resource.
- * If the resource does not exist, this will return an empty set of
- * permissions, not a NOT_FOUND error.
- *
- * Note: This operation is designed to be used for building permission-aware
- * UIs and command-line tools, not for authorization checking. This operation
- * may "fail open" without warning.
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [resource] - REQUIRED: The resource for which the policy detail is being
- * requested.
- * See the operation documentation for the appropriate value for this field.
- * Value must have pattern "^services/[^/]+/consumers/[^/]+$".
- *
- * Completes with a [TestIamPermissionsResponse].
- *
- * 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<TestIamPermissionsResponse> testIamPermissions(TestIamPermissionsRequest request, core.String resource) {
+ /// Returns permissions that a caller has on the specified resource.
+ /// If the resource does not exist, this will return an empty set of
+ /// permissions, not a NOT_FOUND error.
+ ///
+ /// Note: This operation is designed to be used for building permission-aware
+ /// UIs and command-line tools, not for authorization checking. This
+ /// operation
+ /// may "fail open" without warning.
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [resource] - REQUIRED: The resource for which the policy detail is being
+ /// requested.
+ /// See the operation documentation for the appropriate value for this field.
+ /// Value must have pattern "^services/[^/]+/consumers/[^/]+$".
+ ///
+ /// Completes with a [TestIamPermissionsResponse].
+ ///
+ /// 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<TestIamPermissionsResponse> testIamPermissions(
+ TestIamPermissionsRequest request, core.String resource) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -1147,55 +1140,55 @@ class ServicesConsumersResourceApi {
throw new core.ArgumentError("Parameter resource is required.");
}
- _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$resource') + ':testIamPermissions';
+ _url = 'v1/' +
+ commons.Escaper.ecapeVariableReserved('$resource') +
+ ':testIamPermissions';
- var _response = _requester.request(_url,
- "POST",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new TestIamPermissionsResponse.fromJson(data));
+ var _response = _requester.request(_url, "POST",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new TestIamPermissionsResponse.fromJson(data));
}
-
}
-
class ServicesRolloutsResourceApi {
final commons.ApiRequester _requester;
- ServicesRolloutsResourceApi(commons.ApiRequester client) :
- _requester = client;
-
- /**
- * Creates a new service configuration rollout. Based on rollout, the
- * Google Service Management will roll out the service configurations to
- * different backend services. For example, the logging configuration will be
- * pushed to Google Cloud Logging.
- *
- * Please note that any previous pending and running Rollouts and associated
- * Operations will be automatically cancelled so that the latest Rollout will
- * not be blocked by previous Rollouts.
- *
- * Operation<response: Rollout>
- *
- * [request] - The metadata request object.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * 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.
- */
+ ServicesRolloutsResourceApi(commons.ApiRequester client)
+ : _requester = client;
+
+ /// Creates a new service configuration rollout. Based on rollout, the
+ /// Google Service Management will roll out the service configurations to
+ /// different backend services. For example, the logging configuration will
+ /// be
+ /// pushed to Google Cloud Logging.
+ ///
+ /// Please note that any previous pending and running Rollouts and associated
+ /// Operations will be automatically cancelled so that the latest Rollout
+ /// will
+ /// not be blocked by previous Rollouts.
+ ///
+ /// Operation<response: Rollout>
+ ///
+ /// [request] - The metadata request object.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// 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> create(Rollout request, core.String serviceName) {
var _url = null;
var _queryParams = new core.Map();
@@ -1211,37 +1204,36 @@ class ServicesRolloutsResourceApi {
throw new core.ArgumentError("Parameter serviceName is required.");
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + '/rollouts';
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ '/rollouts';
- 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));
}
- /**
- * Gets a service configuration rollout.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * [rolloutId] - The id of the rollout resource.
- *
- * Completes with a [Rollout].
- *
- * 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.
- */
+ /// Gets a service configuration rollout.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// [rolloutId] - The id of the rollout resource.
+ ///
+ /// Completes with a [Rollout].
+ ///
+ /// 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<Rollout> get(core.String serviceName, core.String rolloutId) {
var _url = null;
var _queryParams = new core.Map();
@@ -1257,50 +1249,51 @@ class ServicesRolloutsResourceApi {
throw new core.ArgumentError("Parameter rolloutId is required.");
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + '/rollouts/' + commons.Escaper.ecapeVariable('$rolloutId');
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ '/rollouts/' +
+ commons.Escaper.ecapeVariable('$rolloutId');
- 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 Rollout.fromJson(data));
}
- /**
- * Lists the history of the service configuration rollouts for a managed
- * service, from the newest to the oldest.
- *
- * Request parameters:
- *
- * [serviceName] - The name of the service. See the
- * [overview](/service-management/overview)
- * for naming requirements. For example: `example.googleapis.com`.
- *
- * [filter] - Use `filter` to return subset of rollouts.
- * The following filters are supported:
- * -- To limit the results to only those in
- * [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
- * use filter='status=SUCCESS'
- * -- To limit the results to those in
- * [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
- * or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
- *
- * [pageToken] - The token of the page to retrieve.
- *
- * [pageSize] - The max number of items to include in the response list.
- *
- * Completes with a [ListServiceRolloutsResponse].
- *
- * 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<ListServiceRolloutsResponse> list(core.String serviceName, {core.String filter, core.String pageToken, core.int pageSize}) {
+ /// Lists the history of the service configuration rollouts for a managed
+ /// service, from the newest to the oldest.
+ ///
+ /// Request parameters:
+ ///
+ /// [serviceName] - The name of the service. See the
+ /// [overview](/service-management/overview)
+ /// for naming requirements. For example: `example.googleapis.com`.
+ ///
+ /// [filter] - Use `filter` to return subset of rollouts.
+ /// The following filters are supported:
+ /// -- To limit the results to only those in
+ /// [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
+ /// use filter='status=SUCCESS'
+ /// -- To limit the results to those in
+ /// [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
+ /// or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
+ ///
+ /// [pageToken] - The token of the page to retrieve.
+ ///
+ /// [pageSize] - The max number of items to include in the response list.
+ ///
+ /// Completes with a [ListServiceRolloutsResponse].
+ ///
+ /// 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<ListServiceRolloutsResponse> list(core.String serviceName,
+ {core.String filter, core.String pageToken, core.int pageSize}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
@@ -1321,31 +1314,27 @@ class ServicesRolloutsResourceApi {
_queryParams["pageSize"] = ["${pageSize}"];
}
- _url = 'v1/services/' + commons.Escaper.ecapeVariable('$serviceName') + '/rollouts';
+ _url = 'v1/services/' +
+ commons.Escaper.ecapeVariable('$serviceName') +
+ '/rollouts';
- var _response = _requester.request(_url,
- "GET",
- body: _body,
- queryParams: _queryParams,
- uploadOptions: _uploadOptions,
- uploadMedia: _uploadMedia,
- downloadOptions: _downloadOptions);
- return _response.then((data) => new ListServiceRolloutsResponse.fromJson(data));
+ var _response = _requester.request(_url, "GET",
+ body: _body,
+ queryParams: _queryParams,
+ uploadOptions: _uploadOptions,
+ uploadMedia: _uploadMedia,
+ downloadOptions: _downloadOptions);
+ return _response
+ .then((data) => new ListServiceRolloutsResponse.fromJson(data));
}
-
}
-
-
-/**
- * Generated advice about this change, used for providing more
- * information about how a change will affect the existing service.
- */
+/// Generated advice about this change, used for providing more
+/// information about how a change will affect the existing service.
class Advice {
- /**
- * Useful description for why this advice was applied and what actions should
- * be taken to mitigate any implied risks.
- */
+ /// Useful description for why this advice was applied and what actions
+ /// should
+ /// be taken to mitigate any implied risks.
core.String description;
Advice();
@@ -1357,7 +1346,8 @@ class Advice {
}
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;
}
@@ -1365,78 +1355,81 @@ class Advice {
}
}
-/**
- * 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"]);
@@ -1450,7 +1443,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();
}
@@ -1476,78 +1470,75 @@ class Api {
}
}
-/**
- * Specifies the audit configuration for a service.
- * The configuration determines which permission types are logged, and what
- * identities, if any, are exempted from logging.
- * An AuditConfig must have one or more AuditLogConfigs.
- *
- * If there are AuditConfigs for both `allServices` and a specific service,
- * the union of the two AuditConfigs is used for that service: the log_types
- * specified in each AuditConfig are enabled, and the exempted_members in each
- * AuditConfig are exempted.
- *
- * Example Policy with multiple AuditConfigs:
- *
- * {
- * "audit_configs": [
- * {
- * "service": "allServices"
- * "audit_log_configs": [
- * {
- * "log_type": "DATA_READ",
- * "exempted_members": [
- * "user:foo@gmail.com"
- * ]
- * },
- * {
- * "log_type": "DATA_WRITE",
- * },
- * {
- * "log_type": "ADMIN_READ",
- * }
- * ]
- * },
- * {
- * "service": "fooservice.googleapis.com"
- * "audit_log_configs": [
- * {
- * "log_type": "DATA_READ",
- * },
- * {
- * "log_type": "DATA_WRITE",
- * "exempted_members": [
- * "user:bar@gmail.com"
- * ]
- * }
- * ]
- * }
- * ]
- * }
- *
- * For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- * logging. It also exempts foo@gmail.com from DATA_READ logging, and
- * bar@gmail.com from DATA_WRITE logging.
- */
+/// Specifies the audit configuration for a service.
+/// The configuration determines which permission types are logged, and what
+/// identities, if any, are exempted from logging.
+/// An AuditConfig must have one or more AuditLogConfigs.
+///
+/// If there are AuditConfigs for both `allServices` and a specific service,
+/// the union of the two AuditConfigs is used for that service: the log_types
+/// specified in each AuditConfig are enabled, and the exempted_members in each
+/// AuditConfig are exempted.
+///
+/// Example Policy with multiple AuditConfigs:
+///
+/// {
+/// "audit_configs": [
+/// {
+/// "service": "allServices"
+/// "audit_log_configs": [
+/// {
+/// "log_type": "DATA_READ",
+/// "exempted_members": [
+/// "user:foo@gmail.com"
+/// ]
+/// },
+/// {
+/// "log_type": "DATA_WRITE",
+/// },
+/// {
+/// "log_type": "ADMIN_READ",
+/// }
+/// ]
+/// },
+/// {
+/// "service": "fooservice.googleapis.com"
+/// "audit_log_configs": [
+/// {
+/// "log_type": "DATA_READ",
+/// },
+/// {
+/// "log_type": "DATA_WRITE",
+/// "exempted_members": [
+/// "user:bar@gmail.com"
+/// ]
+/// }
+/// ]
+/// }
+/// ]
+/// }
+///
+/// For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+/// logging. It also exempts foo@gmail.com from DATA_READ logging, and
+/// bar@gmail.com from DATA_WRITE logging.
class AuditConfig {
- /**
- * The configuration for logging of each type of permission.
- * Next ID: 4
- */
+ /// The configuration for logging of each type of permission.
+ /// Next ID: 4
core.List<AuditLogConfig> auditLogConfigs;
core.List<core.String> exemptedMembers;
- /**
- * Specifies a service that will be enabled for audit logging.
- * For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- * `allServices` is a special value that covers all services.
- */
+
+ /// Specifies a service that will be enabled for audit logging.
+ /// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ /// `allServices` is a special value that covers all services.
core.String service;
AuditConfig();
AuditConfig.fromJson(core.Map _json) {
if (_json.containsKey("auditLogConfigs")) {
- auditLogConfigs = _json["auditLogConfigs"].map((value) => new AuditLogConfig.fromJson(value)).toList();
+ auditLogConfigs = _json["auditLogConfigs"]
+ .map((value) => new AuditLogConfig.fromJson(value))
+ .toList();
}
if (_json.containsKey("exemptedMembers")) {
exemptedMembers = _json["exemptedMembers"];
@@ -1558,9 +1549,11 @@ class AuditConfig {
}
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 (auditLogConfigs != null) {
- _json["auditLogConfigs"] = auditLogConfigs.map((value) => (value).toJson()).toList();
+ _json["auditLogConfigs"] =
+ auditLogConfigs.map((value) => (value).toJson()).toList();
}
if (exemptedMembers != null) {
_json["exemptedMembers"] = exemptedMembers;
@@ -1572,42 +1565,37 @@ class AuditConfig {
}
}
-/**
- * Provides the configuration for logging a type of permissions.
- * Example:
- *
- * {
- * "audit_log_configs": [
- * {
- * "log_type": "DATA_READ",
- * "exempted_members": [
- * "user:foo@gmail.com"
- * ]
- * },
- * {
- * "log_type": "DATA_WRITE",
- * }
- * ]
- * }
- *
- * This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- * foo@gmail.com from DATA_READ logging.
- */
+/// Provides the configuration for logging a type of permissions.
+/// Example:
+///
+/// {
+/// "audit_log_configs": [
+/// {
+/// "log_type": "DATA_READ",
+/// "exempted_members": [
+/// "user:foo@gmail.com"
+/// ]
+/// },
+/// {
+/// "log_type": "DATA_WRITE",
+/// }
+/// ]
+/// }
+///
+/// This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+/// foo@gmail.com from DATA_READ logging.
class AuditLogConfig {
- /**
- * Specifies the identities that do not cause logging for this type of
- * permission.
- * Follows the same format of Binding.members.
- */
+ /// Specifies the identities that do not cause logging for this type of
+ /// permission.
+ /// Follows the same format of Binding.members.
core.List<core.String> exemptedMembers;
- /**
- * The log type that this config enables.
- * Possible string values are:
- * - "LOG_TYPE_UNSPECIFIED" : Default case. Should never be this.
- * - "ADMIN_READ" : Admin reads. Example: CloudIAM getIamPolicy
- * - "DATA_WRITE" : Data writes. Example: CloudSQL Users create
- * - "DATA_READ" : Data reads. Example: CloudSQL Users list
- */
+
+ /// The log type that this config enables.
+ /// Possible string values are:
+ /// - "LOG_TYPE_UNSPECIFIED" : Default case. Should never be this.
+ /// - "ADMIN_READ" : Admin reads. Example: CloudIAM getIamPolicy
+ /// - "DATA_WRITE" : Data writes. Example: CloudSQL Users create
+ /// - "DATA_READ" : Data reads. Example: CloudSQL Users list
core.String logType;
AuditLogConfig();
@@ -1622,7 +1610,8 @@ class AuditLogConfig {
}
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 (exemptedMembers != null) {
_json["exemptedMembers"] = exemptedMembers;
}
@@ -1633,63 +1622,56 @@ class AuditLogConfig {
}
}
-/**
- * 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();
@@ -1713,7 +1695,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;
}
@@ -1733,38 +1716,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();
@@ -1779,7 +1757,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;
}
@@ -1790,45 +1769,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();
}
@@ -1839,39 +1820,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();
@@ -1887,7 +1867,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"];
@@ -1895,7 +1877,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;
}
@@ -1906,7 +1889,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;
@@ -1915,23 +1899,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();
@@ -1943,7 +1923,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;
}
@@ -1951,25 +1932,26 @@ class AuthorizationConfig {
}
}
-/** `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();
}
@@ -1977,25 +1959,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();
@@ -2016,7 +1996,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;
}
@@ -2033,46 +2014,42 @@ class BackendRule {
}
}
-/** Associates `members` with a `role`. */
+/// Associates `members` with a `role`.
class Binding {
- /**
- * The condition that is associated with this binding.
- * NOTE: an unsatisfied condition will not allow user access via current
- * binding. Different bindings, including their conditions, are examined
- * independently.
- * This field is GOOGLE_INTERNAL.
- */
+ /// The condition that is associated with this binding.
+ /// NOTE: an unsatisfied condition will not allow user access via current
+ /// binding. Different bindings, including their conditions, are examined
+ /// independently.
+ /// This field is GOOGLE_INTERNAL.
Expr condition;
- /**
- * Specifies the identities requesting access for a Cloud Platform resource.
- * `members` can have the following values:
- *
- * * `allUsers`: A special identifier that represents anyone who is
- * on the internet; with or without a Google account.
- *
- * * `allAuthenticatedUsers`: A special identifier that represents anyone
- * who is authenticated with a Google account or a service account.
- *
- * * `user:{emailid}`: An email address that represents a specific Google
- * account. For example, `alice@gmail.com` or `joe@example.com`.
- *
- *
- * * `serviceAccount:{emailid}`: An email address that represents a service
- * account. For example, `my-other-app@appspot.gserviceaccount.com`.
- *
- * * `group:{emailid}`: An email address that represents a Google group.
- * For example, `admins@example.com`.
- *
- *
- * * `domain:{domain}`: A Google Apps domain name that represents all the
- * users of that domain. For example, `google.com` or `example.com`.
- */
+
+ /// Specifies the identities requesting access for a Cloud Platform resource.
+ /// `members` can have the following values:
+ ///
+ /// * `allUsers`: A special identifier that represents anyone who is
+ /// on the internet; with or without a Google account.
+ ///
+ /// * `allAuthenticatedUsers`: A special identifier that represents anyone
+ /// who is authenticated with a Google account or a service account.
+ ///
+ /// * `user:{emailid}`: An email address that represents a specific Google
+ /// account. For example, `alice@gmail.com` or `joe@example.com`.
+ ///
+ ///
+ /// * `serviceAccount:{emailid}`: An email address that represents a service
+ /// account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ ///
+ /// * `group:{emailid}`: An email address that represents a Google group.
+ /// For example, `admins@example.com`.
+ ///
+ ///
+ /// * `domain:{domain}`: A Google Apps domain name that represents all the
+ /// users of that domain. For example, `google.com` or `example.com`.
core.List<core.String> members;
- /**
- * Role that is assigned to `members`.
- * For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- * Required
- */
+
+ /// Role that is assigned to `members`.
+ /// For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ /// Required
core.String role;
Binding();
@@ -2090,7 +2067,8 @@ class Binding {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (condition != null) {
_json["condition"] = (condition).toJson();
}
@@ -2104,234 +2082,92 @@ class Binding {
}
}
-/**
- * Change report associated with a particular service configuration.
- *
- * It contains a list of ConfigChanges based on the comparison between
- * two service configurations.
- */
+/// Change report associated with a particular service configuration.
+///
+/// It contains a list of ConfigChanges based on the comparison between
+/// two service configurations.
class ChangeReport {
- /**
- * List of changes between two service configurations.
- * The changes will be alphabetically sorted based on the identifier
- * of each change.
- * A ConfigChange identifier is a dot separated path to the configuration.
- * Example: visibility.rules[selector='LibraryService.CreateBook'].restriction
- */
+ /// List of changes between two service configurations.
+ /// The changes will be alphabetically sorted based on the identifier
+ /// of each change.
+ /// A ConfigChange identifier is a dot separated path to the configuration.
+ /// Example:
+ /// visibility.rules[selector='LibraryService.CreateBook'].restriction
core.List<ConfigChange> configChanges;
ChangeReport();
ChangeReport.fromJson(core.Map _json) {
if (_json.containsKey("configChanges")) {
- configChanges = _json["configChanges"].map((value) => new ConfigChange.fromJson(value)).toList();
+ configChanges = _json["configChanges"]
+ .map((value) => new ConfigChange.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 (configChanges != null) {
- _json["configChanges"] = configChanges.map((value) => (value).toJson()).toList();
+ _json["configChanges"] =
+ configChanges.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** Write a Cloud Audit log */
-class CloudAuditOptions {
- /**
- * The log_name to populate in the Cloud Audit Record.
- * Possible string values are:
- * - "UNSPECIFIED_LOG_NAME" : Default. Should not be used.
- * - "ADMIN_ACTIVITY" : Corresponds to "cloudaudit.googleapis.com/activity"
- * - "DATA_ACCESS" : Corresponds to "cloudaudit.googleapis.com/data_access"
- */
- core.String logName;
-
- CloudAuditOptions();
-
- CloudAuditOptions.fromJson(core.Map _json) {
- if (_json.containsKey("logName")) {
- logName = _json["logName"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (logName != null) {
- _json["logName"] = logName;
- }
- return _json;
- }
-}
-
-/** A condition to be met. */
-class Condition {
- /**
- * Trusted attributes supplied by the IAM system.
- * Possible string values are:
- * - "NO_ATTR" : Default non-attribute.
- * - "AUTHORITY" : Either principal or (if present) authority selector.
- * - "ATTRIBUTION" : The principal (even if an authority selector is present),
- * which
- * must only be used for attribution, not authorization.
- * - "APPROVER" : An approver (distinct from the requester) that has
- * authorized this
- * request.
- * When used with IN, the condition indicates that one of the approvers
- * associated with the request matches the specified principal, or is a
- * member of the specified group. Approvers can only grant additional
- * access, and are thus only used in a strictly positive context
- * (e.g. ALLOW/IN or DENY/NOT_IN).
- * - "JUSTIFICATION_TYPE" : What types of justifications have been supplied
- * with this request.
- * String values should match enum names from tech.iam.JustificationType,
- * e.g. "MANUAL_STRING". It is not permitted to grant access based on
- * the *absence* of a justification, so justification conditions can only
- * be used in a "positive" context (e.g., ALLOW/IN or DENY/NOT_IN).
- *
- * Multiple justifications, e.g., a Buganizer ID and a manually-entered
- * reason, are normal and supported.
- */
- core.String iam;
- /**
- * An operator to apply the subject with.
- * Possible string values are:
- * - "NO_OP" : Default no-op.
- * - "EQUALS" : DEPRECATED. Use IN instead.
- * - "NOT_EQUALS" : DEPRECATED. Use NOT_IN instead.
- * - "IN" : The condition is true if the subject (or any element of it if it
- * is
- * a set) matches any of the supplied values.
- * - "NOT_IN" : The condition is true if the subject (or every element of it
- * if it is
- * a set) matches none of the supplied values.
- * - "DISCHARGED" : Subject is discharged
- */
- core.String op;
- /** Trusted attributes discharged by the service. */
- core.String svc;
- /**
- * Trusted attributes supplied by any service that owns resources and uses
- * the IAM system for access control.
- * Possible string values are:
- * - "NO_ATTR" : Default non-attribute type
- * - "REGION" : Region of the resource
- * - "SERVICE" : Service name
- * - "NAME" : Resource name
- * - "IP" : IP address of the caller
- */
- core.String sys;
- /** DEPRECATED. Use 'values' instead. */
- core.String value;
- /** The objects of the condition. This is mutually exclusive with 'value'. */
- core.List<core.String> values;
-
- Condition();
-
- Condition.fromJson(core.Map _json) {
- if (_json.containsKey("iam")) {
- iam = _json["iam"];
- }
- if (_json.containsKey("op")) {
- op = _json["op"];
- }
- if (_json.containsKey("svc")) {
- svc = _json["svc"];
- }
- if (_json.containsKey("sys")) {
- sys = _json["sys"];
- }
- if (_json.containsKey("value")) {
- value = _json["value"];
- }
- if (_json.containsKey("values")) {
- values = _json["values"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (iam != null) {
- _json["iam"] = iam;
- }
- if (op != null) {
- _json["op"] = op;
- }
- if (svc != null) {
- _json["svc"] = svc;
- }
- if (sys != null) {
- _json["sys"] = sys;
- }
- if (value != null) {
- _json["value"] = value;
- }
- if (values != null) {
- _json["values"] = values;
- }
- return _json;
- }
-}
-
-/**
- * Output generated from semantically comparing two versions of a service
- * configuration.
- *
- * Includes detailed information about a field that have changed with
- * applicable advice about potential consequences for the change, such as
- * backwards-incompatibility.
- */
+/// Output generated from semantically comparing two versions of a service
+/// configuration.
+///
+/// Includes detailed information about a field that have changed with
+/// applicable advice about potential consequences for the change, such as
+/// backwards-incompatibility.
class ConfigChange {
- /**
- * Collection of advice provided for this change, useful for determining the
- * possible impact of this change.
- */
+ /// Collection of advice provided for this change, useful for determining the
+ /// possible impact of this change.
core.List<Advice> advices;
- /**
- * The type for this change, either ADDED, REMOVED, or MODIFIED.
- * Possible string values are:
- * - "CHANGE_TYPE_UNSPECIFIED" : No value was provided.
- * - "ADDED" : The changed object exists in the 'new' service configuration,
- * but not
- * in the 'old' service configuration.
- * - "REMOVED" : The changed object exists in the 'old' service configuration,
- * but not
- * in the 'new' service configuration.
- * - "MODIFIED" : The changed object exists in both service configurations,
- * but its value
- * is different.
- */
+
+ /// The type for this change, either ADDED, REMOVED, or MODIFIED.
+ /// Possible string values are:
+ /// - "CHANGE_TYPE_UNSPECIFIED" : No value was provided.
+ /// - "ADDED" : The changed object exists in the 'new' service configuration,
+ /// but not
+ /// in the 'old' service configuration.
+ /// - "REMOVED" : The changed object exists in the 'old' service
+ /// configuration, but not
+ /// in the 'new' service configuration.
+ /// - "MODIFIED" : The changed object exists in both service configurations,
+ /// but its value
+ /// is different.
core.String changeType;
- /**
- * Object hierarchy path to the change, with levels separated by a '.'
- * character. For repeated fields, an applicable unique identifier field is
- * used for the index (usually selector, name, or id). For maps, the term
- * 'key' is used. If the field has no unique identifier, the numeric index
- * is used.
- * Examples:
- * -
- * visibility.rules[selector=="google.LibraryService.CreateBook"].restriction
- * - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
- * - logging.producer_destinations[0]
- */
+
+ /// Object hierarchy path to the change, with levels separated by a '.'
+ /// character. For repeated fields, an applicable unique identifier field is
+ /// used for the index (usually selector, name, or id). For maps, the term
+ /// 'key' is used. If the field has no unique identifier, the numeric index
+ /// is used.
+ /// Examples:
+ /// -
+ /// visibility.rules[selector=="google.LibraryService.CreateBook"].restriction
+ /// - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
+ /// - logging.producer_destinations[0]
core.String element;
- /**
- * Value of the changed object in the new Service configuration,
- * in JSON format. This field will not be populated if ChangeType == REMOVED.
- */
+
+ /// Value of the changed object in the new Service configuration,
+ /// in JSON format. This field will not be populated if ChangeType ==
+ /// REMOVED.
core.String newValue;
- /**
- * Value of the changed object in the old Service configuration,
- * in JSON format. This field will not be populated if ChangeType == ADDED.
- */
+
+ /// Value of the changed object in the old Service configuration,
+ /// in JSON format. This field will not be populated if ChangeType == ADDED.
core.String oldValue;
ConfigChange();
ConfigChange.fromJson(core.Map _json) {
if (_json.containsKey("advices")) {
- advices = _json["advices"].map((value) => new Advice.fromJson(value)).toList();
+ advices =
+ _json["advices"].map((value) => new Advice.fromJson(value)).toList();
}
if (_json.containsKey("changeType")) {
changeType = _json["changeType"];
@@ -2348,7 +2184,8 @@ class ConfigChange {
}
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 (advices != null) {
_json["advices"] = advices.map((value) => (value).toJson()).toList();
}
@@ -2368,34 +2205,35 @@ class ConfigChange {
}
}
-/** Generic specification of a source configuration file */
+/// Generic specification of a source configuration file
class ConfigFile {
- /** The bytes that constitute the file. */
+ /// The bytes that constitute the file.
core.String fileContents;
core.List<core.int> get fileContentsAsBytes {
return convert.BASE64.decode(fileContents);
}
void set fileContentsAsBytes(core.List<core.int> _bytes) {
- fileContents = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
+ fileContents =
+ convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
- /** The file name of the configuration file (full or relative path). */
+
+ /// The file name of the configuration file (full or relative path).
core.String filePath;
- /**
- * The type of configuration file this represents.
- * Possible string values are:
- * - "FILE_TYPE_UNSPECIFIED" : Unknown file type.
- * - "SERVICE_CONFIG_YAML" : YAML-specification of service.
- * - "OPEN_API_JSON" : OpenAPI specification, serialized in JSON.
- * - "OPEN_API_YAML" : OpenAPI specification, serialized in YAML.
- * - "FILE_DESCRIPTOR_SET_PROTO" : FileDescriptorSet, generated by protoc.
- *
- * To generate, use protoc with imports and source info included.
- * For an example test.proto file, the following command would put the value
- * in a new file named out.pb.
- *
- * $protoc --include_imports --include_source_info test.proto -o out.pb
- */
+
+ /// The type of configuration file this represents.
+ /// Possible string values are:
+ /// - "FILE_TYPE_UNSPECIFIED" : Unknown file type.
+ /// - "SERVICE_CONFIG_YAML" : YAML-specification of service.
+ /// - "OPEN_API_JSON" : OpenAPI specification, serialized in JSON.
+ /// - "OPEN_API_YAML" : OpenAPI specification, serialized in YAML.
+ /// - "FILE_DESCRIPTOR_SET_PROTO" : FileDescriptorSet, generated by protoc.
+ ///
+ /// To generate, use protoc with imports and source info included.
+ /// For an example test.proto file, the following command would put the value
+ /// in a new file named out.pb.
+ ///
+ /// $protoc --include_imports --include_source_info test.proto -o out.pb
core.String fileType;
ConfigFile();
@@ -2413,7 +2251,8 @@ class ConfigFile {
}
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 (fileContents != null) {
_json["fileContents"] = fileContents;
}
@@ -2427,12 +2266,10 @@ class ConfigFile {
}
}
-/** Represents a service configuration with its name and id. */
+/// Represents a service configuration with its name and id.
class ConfigRef {
- /**
- * Resource name of a service config. It must have the following
- * format: "services/{service name}/configs/{config id}".
- */
+ /// Resource name of a service config. It must have the following
+ /// format: "services/{service name}/configs/{config id}".
core.String name;
ConfigRef();
@@ -2444,7 +2281,8 @@ class ConfigRef {
}
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;
}
@@ -2452,28 +2290,26 @@ class ConfigRef {
}
}
-/**
- * Represents a source file which is used to generate the service configuration
- * defined by `google.api.Service`.
- */
+/// Represents a source file which is used to generate the service
+/// configuration
+/// defined by `google.api.Service`.
class ConfigSource {
- /**
- * Set of source configuration files that are used to generate a service
- * configuration (`google.api.Service`).
- */
+ /// Set of source configuration files that are used to generate a service
+ /// configuration (`google.api.Service`).
core.List<ConfigFile> files;
- /**
- * 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;
ConfigSource();
ConfigSource.fromJson(core.Map _json) {
if (_json.containsKey("files")) {
- files = _json["files"].map((value) => new ConfigFile.fromJson(value)).toList();
+ files = _json["files"]
+ .map((value) => new ConfigFile.fromJson(value))
+ .toList();
}
if (_json.containsKey("id")) {
id = _json["id"];
@@ -2481,7 +2317,8 @@ class ConfigSource {
}
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 (files != null) {
_json["files"] = files.map((value) => (value).toJson()).toList();
}
@@ -2492,43 +2329,42 @@ class ConfigSource {
}
}
-/**
- * `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();
}
@@ -2536,20 +2372,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();
@@ -2567,7 +2401,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;
}
@@ -2581,16 +2416,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();
@@ -2602,7 +2433,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;
}
@@ -2610,66 +2442,11 @@ class Control {
}
}
-/**
- * Increment a streamz counter with the specified metric and field names.
- *
- * Metric names should start with a '/', generally be lowercase-only,
- * and end in "_count". Field names should not contain an initial slash.
- * The actual exported metric names will have "/iam/policy" prepended.
- *
- * Field names correspond to IAM request parameters and field values are
- * their respective values.
- *
- * At present the only supported field names are
- * - "iam_principal", corresponding to IAMContext.principal;
- * - "" (empty string), resulting in one aggretated counter with no field.
- *
- * Examples:
- * counter { metric: "/debug_access_count" field: "iam_principal" }
- * ==> increment counter /iam/policy/backend_debug_access_count
- * {iam_principal=[value of IAMContext.principal]}
- *
- * At this time we do not support:
- * * multiple field names (though this may be supported in the future)
- * * decrementing the counter
- * * incrementing it by anything other than 1
- */
-class CounterOptions {
- /** The field value to attribute. */
- core.String field;
- /** The metric to update. */
- core.String metric;
-
- CounterOptions();
-
- CounterOptions.fromJson(core.Map _json) {
- if (_json.containsKey("field")) {
- field = _json["field"];
- }
- if (_json.containsKey("metric")) {
- metric = _json["metric"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (field != null) {
- _json["field"] = field;
- }
- if (metric != null) {
- _json["metric"] = metric;
- }
- return _json;
- }
-}
-
-/** 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();
@@ -2681,7 +2458,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;
}
@@ -2689,35 +2467,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"];
@@ -2725,7 +2500,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();
}
@@ -2736,18 +2512,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();
@@ -2762,7 +2535,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;
}
@@ -2773,11 +2547,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();
@@ -2792,7 +2567,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;
}
@@ -2803,76 +2579,32 @@ class CustomHttpPattern {
}
}
-/** Write a Data Access (Gin) log */
-class DataAccessOptions {
- /**
- * Whether Gin logging should happen in a fail-closed manner at the caller.
- * This is relevant only in the LocalIAM implementation, for now.
- * Possible string values are:
- * - "LOG_MODE_UNSPECIFIED" : Client is not required to write a partial Gin
- * log immediately after
- * the authorization check. If client chooses to write one and it fails,
- * client may either fail open (allow the operation to continue) or
- * fail closed (handle as a DENY outcome).
- * - "LOG_FAIL_CLOSED" : The application's operation in the context of which
- * this authorization
- * check is being made may only be performed if it is successfully logged
- * to Gin. For instance, the authorization library may satisfy this
- * obligation by emitting a partial log entry at authorization check time
- * and only returning ALLOW to the application if it succeeds.
- *
- * If a matching Rule has this directive, but the client has not indicated
- * that it will honor such requirements, then the IAM check will result in
- * authorization failure by setting CheckPolicyResponse.success=false.
- */
- core.String logMode;
-
- DataAccessOptions();
-
- DataAccessOptions.fromJson(core.Map _json) {
- if (_json.containsKey("logMode")) {
- logMode = _json["logMode"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (logMode != null) {
- _json["logMode"] = logMode;
- }
- return _json;
- }
-}
-
-/**
- * Strategy used to delete a service. This strategy is a placeholder only
- * used by the system generated rollout to delete a service.
- */
+/// Strategy used to delete a service. This strategy is a placeholder only
+/// used by the system generated rollout to delete a service.
class DeleteServiceStrategy {
-
DeleteServiceStrategy();
- DeleteServiceStrategy.fromJson(core.Map _json) {
- }
+ DeleteServiceStrategy.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;
}
}
-/** Represents a diagnostic message (error or warning) */
+/// Represents a diagnostic message (error or warning)
class Diagnostic {
- /**
- * The kind of diagnostic information provided.
- * Possible string values are:
- * - "WARNING" : Warnings and errors
- * - "ERROR" : Only errors
- */
+ /// The kind of diagnostic information provided.
+ /// Possible string values are:
+ /// - "WARNING" : Warnings and errors
+ /// - "ERROR" : Only errors
core.String kind;
- /** File name and line number of the error or warning. */
+
+ /// File name and line number of the error or warning.
core.String location;
- /** Message describing the error or warning. */
+
+ /// Message describing the error or warning.
core.String message;
Diagnostic();
@@ -2890,7 +2622,8 @@ class Diagnostic {
}
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;
}
@@ -2904,19 +2637,17 @@ class Diagnostic {
}
}
-/** Request message for DisableService method. */
+/// Request message for DisableService method.
class DisableServiceRequest {
- /**
- * The identity of consumer resource which service disablement will be
- * applied to.
- *
- * The Google Service Management implementation accepts the following
- * forms:
- * - "project:<project_id>"
- *
- * Note: this is made compatible with
- * google.api.servicecontrol.v1.Operation.consumer_id.
- */
+ /// The identity of consumer resource which service disablement will be
+ /// applied to.
+ ///
+ /// The Google Service Management implementation accepts the following
+ /// forms:
+ /// - "project:<project_id>"
+ ///
+ /// Note: this is made compatible with
+ /// google.api.servicecontrol.v1.Operation.consumer_id.
core.String consumerId;
DisableServiceRequest();
@@ -2928,7 +2659,8 @@ class DisableServiceRequest {
}
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 (consumerId != null) {
_json["consumerId"] = consumerId;
}
@@ -2936,96 +2668,92 @@ class DisableServiceRequest {
}
}
-/**
- * `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: &#40;== include google/foo/overview.md ==&#41;
- * - name: Tutorial
- * content: &#40;== include google/foo/tutorial.md ==&#41;
- * subpages;
- * - name: Java
- * content: &#40;== include google/foo/tutorial_java.md ==&#41;
- * 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>&#91;fully.qualified.proto.name]&#91;]</code></pre>
- * To override the display text used for the link, this can be used:
- * <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
- * Text can be excluded from doc using the following notation:
- * <pre><code>&#40;-- internal comment --&#41;</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>&#40;--BETA: comment for BETA users --&#41;</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>&#40;== include path/to/file ==&#41;</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>&#40;== resource_for v1.shelves.books ==&#41;</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: &#40;== include google/foo/overview.md ==&#41;
+/// - name: Tutorial
+/// content: &#40;== include google/foo/tutorial.md ==&#41;
+/// subpages;
+/// - name: Java
+/// content: &#40;== include google/foo/tutorial_java.md ==&#41;
+/// 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>&#91;fully.qualified.proto.name]&#91;]</code></pre>
+/// To override the display text used for the link, this can be used:
+/// <pre><code>&#91;display text]&#91;fully.qualified.proto.name]</code></pre>
+/// Text can be excluded from doc using the following notation:
+/// <pre><code>&#40;-- internal comment --&#41;</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>&#40;--BETA: comment for BETA users --&#41;</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>&#40;== include path/to/file ==&#41;</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>&#40;== resource_for v1.shelves.books ==&#41;</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: &#40;== include overview.md ==&#41;
- * </code></pre>
- * This is a shortcut for the following declaration (using pages style):
- * <pre><code>documentation:
- * summary: ...
- * pages:
- * - name: Overview
- * content: &#40;== include overview.md ==&#41;
- * </code></pre>
- * Note: you cannot specify both `overview` field and `pages` field.
- */
+
+ /// Declares a single overview page. For example:
+ /// <pre><code>documentation:
+ /// summary: ...
+ /// overview: &#40;== include overview.md ==&#41;
+ /// </code></pre>
+ /// This is a shortcut for the following declaration (using pages style):
+ /// <pre><code>documentation:
+ /// summary: ...
+ /// pages:
+ /// - name: Overview
+ /// content: &#40;== include overview.md ==&#41;
+ /// </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();
@@ -3041,7 +2769,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"];
@@ -3049,7 +2779,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;
}
@@ -3069,24 +2800,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();
@@ -3104,7 +2834,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;
}
@@ -3118,19 +2849,17 @@ class DocumentationRule {
}
}
-/** Request message for EnableService method. */
+/// Request message for EnableService method.
class EnableServiceRequest {
- /**
- * The identity of consumer resource which service enablement will be
- * applied to.
- *
- * The Google Service Management implementation accepts the following
- * forms:
- * - "project:<project_id>"
- *
- * Note: this is made compatible with
- * google.api.servicecontrol.v1.Operation.consumer_id.
- */
+ /// The identity of consumer resource which service enablement will be
+ /// applied to.
+ ///
+ /// The Google Service Management implementation accepts the following
+ /// forms:
+ /// - "project:<project_id>"
+ ///
+ /// Note: this is made compatible with
+ /// google.api.servicecontrol.v1.Operation.consumer_id.
core.String consumerId;
EnableServiceRequest();
@@ -3142,7 +2871,8 @@ class EnableServiceRequest {
}
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 (consumerId != null) {
_json["consumerId"] = consumerId;
}
@@ -3150,60 +2880,59 @@ class EnableServiceRequest {
}
}
-/**
- * `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();
@@ -3230,7 +2959,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;
}
@@ -3253,35 +2983,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"]);
@@ -3292,7 +3027,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();
}
@@ -3312,13 +3048,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();
@@ -3331,12 +3069,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;
}
@@ -3350,12 +3090,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();
@@ -3367,7 +3105,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();
}
@@ -3375,37 +3114,30 @@ class Experimental {
}
}
-/**
- * Represents an expression text. Example:
- *
- * title: "User account presence"
- * description: "Determines whether the request has a user account"
- * expression: "size(request.user) > 0"
- */
+/// Represents an expression text. Example:
+///
+/// title: "User account presence"
+/// description: "Determines whether the request has a user account"
+/// expression: "size(request.user) > 0"
class Expr {
- /**
- * An optional description of the expression. This is a longer text which
- * describes the expression, e.g. when hovered over it in a UI.
- */
+ /// An optional description of the expression. This is a longer text which
+ /// describes the expression, e.g. when hovered over it in a UI.
core.String description;
- /**
- * Textual representation of an expression in
- * Common Expression Language syntax.
- *
- * The application context of the containing message determines which
- * well-known feature set of CEL is supported.
- */
+
+ /// Textual representation of an expression in
+ /// Common Expression Language syntax.
+ ///
+ /// The application context of the containing message determines which
+ /// well-known feature set of CEL is supported.
core.String expression;
- /**
- * An optional string indicating the location of the expression for error
- * reporting, e.g. a file name and a position in the file.
- */
+
+ /// An optional string indicating the location of the expression for error
+ /// reporting, e.g. a file name and a position in the file.
core.String location;
- /**
- * An optional title for the expression, i.e. a short string describing
- * its purpose. This can be used e.g. in UIs which allow to enter the
- * expression.
- */
+
+ /// An optional title for the expression, i.e. a short string describing
+ /// its purpose. This can be used e.g. in UIs which allow to enter the
+ /// expression.
core.String title;
Expr();
@@ -3426,7 +3158,8 @@ class Expr {
}
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;
}
@@ -3443,64 +3176,64 @@ class Expr {
}
}
-/** 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();
@@ -3528,7 +3261,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"];
@@ -3539,7 +3273,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;
}
@@ -3574,42 +3309,40 @@ class Field {
}
}
-/** The metadata associated with a long running operation resource. */
+/// The metadata associated with a long running operation resource.
class FlowOperationMetadata {
- /**
- * The state of the operation with respect to cancellation.
- * Possible string values are:
- * - "RUNNING" : Default state, cancellable but not cancelled.
- * - "UNCANCELLABLE" : The operation has proceeded past the point of no return
- * and cannot
- * be cancelled.
- * - "CANCELLED" : The operation has been cancelled, work should cease
- * and any needed rollback steps executed.
- */
+ /// The state of the operation with respect to cancellation.
+ /// Possible string values are:
+ /// - "RUNNING" : Default state, cancellable but not cancelled.
+ /// - "UNCANCELLABLE" : The operation has proceeded past the point of no
+ /// return and cannot
+ /// be cancelled.
+ /// - "CANCELLED" : The operation has been cancelled, work should cease
+ /// and any needed rollback steps executed.
core.String cancelState;
- /**
- * Deadline for the flow to complete, to prevent orphaned Operations.
- *
- * If the flow has not completed by this time, it may be terminated by
- * the engine, or force-failed by Operation lookup.
- *
- * Note that this is not a hard deadline after which the Flow will
- * definitely be failed, rather it is a deadline after which it is reasonable
- * to suspect a problem and other parts of the system may kill operation
- * to ensure we don't have orphans.
- * see also: go/prevent-orphaned-operations
- */
+
+ /// Deadline for the flow to complete, to prevent orphaned Operations.
+ ///
+ /// If the flow has not completed by this time, it may be terminated by
+ /// the engine, or force-failed by Operation lookup.
+ ///
+ /// Note that this is not a hard deadline after which the Flow will
+ /// definitely be failed, rather it is a deadline after which it is
+ /// reasonable
+ /// to suspect a problem and other parts of the system may kill operation
+ /// to ensure we don't have orphans.
+ /// see also: go/prevent-orphaned-operations
core.String deadline;
- /**
- * The name of the top-level flow corresponding to this operation.
- * Must be equal to the "name" field for a FlowName enum.
- */
+
+ /// The name of the top-level flow corresponding to this operation.
+ /// Must be equal to the "name" field for a FlowName enum.
core.String flowName;
- /**
- * The full name of the resources that this flow is directly associated with.
- */
+
+ /// The full name of the resources that this flow is directly associated
+ /// with.
core.List<core.String> resourceNames;
- /** The start time of the operation. */
+
+ /// The start time of the operation.
core.String startTime;
FlowOperationMetadata();
@@ -3633,7 +3366,8 @@ class FlowOperationMetadata {
}
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 (cancelState != null) {
_json["cancelState"] = cancelState;
}
@@ -3653,29 +3387,26 @@ class FlowOperationMetadata {
}
}
-/** Request message for GenerateConfigReport method. */
+/// Request message for GenerateConfigReport method.
class GenerateConfigReportRequest {
- /**
- * Service configuration for which we want to generate the report.
- * For this version of API, the supported types are
- * google.api.servicemanagement.v1.ConfigRef,
- * google.api.servicemanagement.v1.ConfigSource,
- * and google.api.Service
- *
- * 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 configuration for which we want to generate the report.
+ /// For this version of API, the supported types are
+ /// google.api.servicemanagement.v1.ConfigRef,
+ /// google.api.servicemanagement.v1.ConfigSource,
+ /// and google.api.Service
+ ///
+ /// 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> newConfig;
- /**
- * Service configuration against which the comparison will be done.
- * For this version of API, the supported types are
- * google.api.servicemanagement.v1.ConfigRef,
- * google.api.servicemanagement.v1.ConfigSource,
- * and google.api.Service
- *
- * 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 configuration against which the comparison will be done.
+ /// For this version of API, the supported types are
+ /// google.api.servicemanagement.v1.ConfigRef,
+ /// google.api.servicemanagement.v1.ConfigSource,
+ /// and google.api.Service
+ ///
+ /// 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> oldConfig;
GenerateConfigReportRequest();
@@ -3690,7 +3421,8 @@ class GenerateConfigReportRequest {
}
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 (newConfig != null) {
_json["newConfig"] = newConfig;
}
@@ -3701,32 +3433,35 @@ class GenerateConfigReportRequest {
}
}
-/** Response message for GenerateConfigReport method. */
+/// Response message for GenerateConfigReport method.
class GenerateConfigReportResponse {
- /**
- * list of ChangeReport, each corresponding to comparison between two
- * service configurations.
- */
+ /// list of ChangeReport, each corresponding to comparison between two
+ /// service configurations.
core.List<ChangeReport> changeReports;
- /**
- * Errors / Linter warnings associated with the service definition this
- * report
- * belongs to.
- */
+
+ /// Errors / Linter warnings associated with the service definition this
+ /// report
+ /// belongs to.
core.List<Diagnostic> diagnostics;
- /** ID of the service configuration this report belongs to. */
+
+ /// ID of the service configuration this report belongs to.
core.String id;
- /** Name of the service this report belongs to. */
+
+ /// Name of the service this report belongs to.
core.String serviceName;
GenerateConfigReportResponse();
GenerateConfigReportResponse.fromJson(core.Map _json) {
if (_json.containsKey("changeReports")) {
- changeReports = _json["changeReports"].map((value) => new ChangeReport.fromJson(value)).toList();
+ changeReports = _json["changeReports"]
+ .map((value) => new ChangeReport.fromJson(value))
+ .toList();
}
if (_json.containsKey("diagnostics")) {
- diagnostics = _json["diagnostics"].map((value) => new Diagnostic.fromJson(value)).toList();
+ diagnostics = _json["diagnostics"]
+ .map((value) => new Diagnostic.fromJson(value))
+ .toList();
}
if (_json.containsKey("id")) {
id = _json["id"];
@@ -3737,12 +3472,15 @@ class GenerateConfigReportResponse {
}
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 (changeReports != null) {
- _json["changeReports"] = changeReports.map((value) => (value).toJson()).toList();
+ _json["changeReports"] =
+ changeReports.map((value) => (value).toJson()).toList();
}
if (diagnostics != null) {
- _json["diagnostics"] = diagnostics.map((value) => (value).toJson()).toList();
+ _json["diagnostics"] =
+ diagnostics.map((value) => (value).toJson()).toList();
}
if (id != null) {
_json["id"] = id;
@@ -3754,40 +3492,36 @@ class GenerateConfigReportResponse {
}
}
-/** Request message for `GetIamPolicy` method. */
+/// Request message for `GetIamPolicy` method.
class GetIamPolicyRequest {
-
GetIamPolicyRequest();
- GetIamPolicyRequest.fromJson(core.Map _json) {
- }
+ GetIamPolicyRequest.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
return _json;
}
}
-/**
- * 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();
@@ -3797,12 +3531,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;
}
@@ -3813,295 +3549,297 @@ 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&param=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&param=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;
- /**
- * 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;
- /**
- * 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("body")) {
body = _json["body"];
@@ -4139,9 +3877,11 @@ 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 (body != null) {
_json["body"] = body;
@@ -4180,19 +3920,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();
@@ -4210,7 +3950,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;
}
@@ -4224,11 +3965,12 @@ class LabelDescriptor {
}
}
-/** The response message for Operations.ListOperations. */
+/// The response message for Operations.ListOperations.
class ListOperationsResponse {
- /** The standard List next-page token. */
+ /// The standard List next-page token.
core.String nextPageToken;
- /** A list of operations that matches the specified filter in the request. */
+
+ /// A list of operations that matches the specified filter in the request.
core.List<Operation> operations;
ListOperationsResponse();
@@ -4238,27 +3980,32 @@ class ListOperationsResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("operations")) {
- operations = _json["operations"].map((value) => new Operation.fromJson(value)).toList();
+ operations = _json["operations"]
+ .map((value) => new Operation.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
if (operations != null) {
- _json["operations"] = operations.map((value) => (value).toJson()).toList();
+ _json["operations"] =
+ operations.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** Response message for ListServiceConfigs method. */
+/// Response message for ListServiceConfigs method.
class ListServiceConfigsResponse {
- /** The token of the next page of results. */
+ /// The token of the next page of results.
core.String nextPageToken;
- /** The list of service configuration resources. */
+
+ /// The list of service configuration resources.
core.List<Service> serviceConfigs;
ListServiceConfigsResponse();
@@ -4268,27 +4015,32 @@ class ListServiceConfigsResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("serviceConfigs")) {
- serviceConfigs = _json["serviceConfigs"].map((value) => new Service.fromJson(value)).toList();
+ serviceConfigs = _json["serviceConfigs"]
+ .map((value) => new Service.fromJson(value))
+ .toList();
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
if (serviceConfigs != null) {
- _json["serviceConfigs"] = serviceConfigs.map((value) => (value).toJson()).toList();
+ _json["serviceConfigs"] =
+ serviceConfigs.map((value) => (value).toJson()).toList();
}
return _json;
}
}
-/** Response message for ListServiceRollouts method. */
+/// Response message for ListServiceRollouts method.
class ListServiceRolloutsResponse {
- /** The token of the next page of results. */
+ /// The token of the next page of results.
core.String nextPageToken;
- /** The list of rollout resources. */
+
+ /// The list of rollout resources.
core.List<Rollout> rollouts;
ListServiceRolloutsResponse();
@@ -4298,12 +4050,15 @@ class ListServiceRolloutsResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("rollouts")) {
- rollouts = _json["rollouts"].map((value) => new Rollout.fromJson(value)).toList();
+ rollouts = _json["rollouts"]
+ .map((value) => new Rollout.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;
}
@@ -4314,13 +4069,12 @@ class ListServiceRolloutsResponse {
}
}
-/** Response message for `ListServices` method. */
+/// Response message for `ListServices` method.
class ListServicesResponse {
- /**
- * Token that can be passed to `ListServices` to resume a paginated query.
- */
+ /// Token that can be passed to `ListServices` to resume a paginated query.
core.String nextPageToken;
- /** The returned services will only have the name field set. */
+
+ /// The returned services will only have the name field set.
core.List<ManagedService> services;
ListServicesResponse();
@@ -4330,12 +4084,15 @@ class ListServicesResponse {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("services")) {
- services = _json["services"].map((value) => new ManagedService.fromJson(value)).toList();
+ services = _json["services"]
+ .map((value) => new ManagedService.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;
}
@@ -4346,77 +4103,32 @@ class ListServicesResponse {
}
}
-/** Specifies what kind of log the caller must write */
-class LogConfig {
- /** Cloud audit options. */
- CloudAuditOptions cloudAudit;
- /** Counter options. */
- CounterOptions counter;
- /** Data access options. */
- DataAccessOptions dataAccess;
-
- LogConfig();
-
- LogConfig.fromJson(core.Map _json) {
- if (_json.containsKey("cloudAudit")) {
- cloudAudit = new CloudAuditOptions.fromJson(_json["cloudAudit"]);
- }
- if (_json.containsKey("counter")) {
- counter = new CounterOptions.fromJson(_json["counter"]);
- }
- if (_json.containsKey("dataAccess")) {
- dataAccess = new DataAccessOptions.fromJson(_json["dataAccess"]);
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (cloudAudit != null) {
- _json["cloudAudit"] = (cloudAudit).toJson();
- }
- if (counter != null) {
- _json["counter"] = (counter).toJson();
- }
- if (dataAccess != null) {
- _json["dataAccess"] = (dataAccess).toJson();
- }
- return _json;
- }
-}
-
-/**
- * A 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();
@@ -4429,7 +4141,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"];
@@ -4437,7 +4151,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;
}
@@ -4454,92 +4169,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();
@@ -4554,7 +4266,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;
}
@@ -4565,17 +4278,14 @@ class LoggingDestination {
}
}
-/**
- * The full representation of a Service that is managed by
- * Google Service Management.
- */
+/// The full representation of a Service that is managed by
+/// Google Service Management.
class ManagedService {
- /** ID of the project that produces and owns this service. */
+ /// ID of the project that produces and owns this service.
core.String producerProjectId;
- /**
- * The name of the service. See the [overview](/service-management/overview)
- * for naming requirements.
- */
+
+ /// The name of the service. See the [overview](/service-management/overview)
+ /// for naming requirements.
core.String serviceName;
ManagedService();
@@ -4590,7 +4300,8 @@ class ManagedService {
}
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 (producerProjectId != null) {
_json["producerProjectId"] = producerProjectId;
}
@@ -4601,37 +4312,32 @@ class ManagedService {
}
}
-/**
- * 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();
@@ -4658,7 +4364,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;
}
@@ -4681,44 +4388,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();
@@ -4751,7 +4455,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;
}
@@ -4780,26 +4485,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();
@@ -4809,7 +4518,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"];
@@ -4829,7 +4539,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;
}
@@ -4855,146 +4566,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();
@@ -5007,7 +4709,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"];
@@ -5027,7 +4731,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;
}
@@ -5056,25 +4761,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();
@@ -5089,7 +4790,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;
}
@@ -5100,93 +4802,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();
@@ -5201,7 +4900,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;
}
@@ -5212,50 +4912,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();
@@ -5268,7 +4963,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"];
@@ -5279,7 +4976,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;
}
@@ -5299,98 +4997,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();
@@ -5405,7 +5100,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;
}
@@ -5416,36 +5112,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();
@@ -5457,7 +5151,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;
}
@@ -5465,48 +5160,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();
@@ -5530,7 +5221,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;
}
@@ -5550,18 +5242,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();
@@ -5582,7 +5275,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;
}
@@ -5599,27 +5293,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();
@@ -5634,7 +5323,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;
}
@@ -5645,38 +5335,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>&#40;== include {path}
- * ==&#41;</code>
- * to include content from a Markdown file.
- */
+ /// The Markdown content of the page. You can use <code>&#40;== include
+ /// {path} ==&#41;</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: &#40;== include tutorial.md ==&#41;
- * subpages:
- * - name: Java
- * content: &#40;== include tutorial_java.md ==&#41;
- * </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: &#40;== include tutorial.md ==&#41;
+ /// subpages:
+ /// - name: Java
+ /// content: &#40;== include tutorial_java.md ==&#41;
+ /// </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();
@@ -5689,12 +5373,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;
}
@@ -5708,91 +5394,85 @@ class Page {
}
}
-/**
- * Defines an Identity and Access Management (IAM) policy. It is used to
- * specify access control policies for Cloud Platform resources.
- *
- *
- * A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
- * `members` to a `role`, where the members can be user accounts, Google groups,
- * Google domains, and service accounts. A `role` is a named list of permissions
- * defined by IAM.
- *
- * **Example**
- *
- * {
- * "bindings": [
- * {
- * "role": "roles/owner",
- * "members": [
- * "user:mike@example.com",
- * "group:admins@example.com",
- * "domain:google.com",
- * "serviceAccount:my-other-app@appspot.gserviceaccount.com",
- * ]
- * },
- * {
- * "role": "roles/viewer",
- * "members": ["user:sean@example.com"]
- * }
- * ]
- * }
- *
- * For a description of IAM and its features, see the
- * [IAM developer's guide](https://cloud.google.com/iam).
- */
+/// Defines an Identity and Access Management (IAM) policy. It is used to
+/// specify access control policies for Cloud Platform resources.
+///
+///
+/// A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+/// `members` to a `role`, where the members can be user accounts, Google
+/// groups,
+/// Google domains, and service accounts. A `role` is a named list of
+/// permissions
+/// defined by IAM.
+///
+/// **Example**
+///
+/// {
+/// "bindings": [
+/// {
+/// "role": "roles/owner",
+/// "members": [
+/// "user:mike@example.com",
+/// "group:admins@example.com",
+/// "domain:google.com",
+/// "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+/// ]
+/// },
+/// {
+/// "role": "roles/viewer",
+/// "members": ["user:sean@example.com"]
+/// }
+/// ]
+/// }
+///
+/// For a description of IAM and its features, see the
+/// [IAM developer's guide](https://cloud.google.com/iam).
class Policy {
- /** Specifies cloud audit logging configuration for this policy. */
+ /// Specifies cloud audit logging configuration for this policy.
core.List<AuditConfig> auditConfigs;
- /**
- * Associates a list of `members` to a `role`.
- * `bindings` with no members will result in an error.
- */
+
+ /// Associates a list of `members` to a `role`.
+ /// `bindings` with no members will result in an error.
core.List<Binding> bindings;
- /**
- * `etag` is used for optimistic concurrency control as a way to help
- * prevent simultaneous updates of a policy from overwriting each other.
- * It is strongly suggested that systems make use of the `etag` in the
- * read-modify-write cycle to perform policy updates in order to avoid race
- * conditions: An `etag` is returned in the response to `getIamPolicy`, and
- * systems are expected to put that etag in the request to `setIamPolicy` to
- * ensure that their change will be applied to the same version of the policy.
- *
- * If no `etag` is provided in the call to `setIamPolicy`, then the existing
- * policy is overwritten blindly.
- */
+
+ /// `etag` is used for optimistic concurrency control as a way to help
+ /// prevent simultaneous updates of a policy from overwriting each other.
+ /// It is strongly suggested that systems make use of the `etag` in the
+ /// read-modify-write cycle to perform policy updates in order to avoid race
+ /// conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ /// systems are expected to put that etag in the request to `setIamPolicy` to
+ /// ensure that their change will be applied to the same version of the
+ /// policy.
+ ///
+ /// If no `etag` is provided in the call to `setIamPolicy`, then the existing
+ /// policy is overwritten blindly.
core.String etag;
core.List<core.int> get etagAsBytes {
return convert.BASE64.decode(etag);
}
void set etagAsBytes(core.List<core.int> _bytes) {
- etag = convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
+ etag =
+ convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
+
core.bool iamOwned;
- /**
- * If more than one rule is specified, the rules are applied in the following
- * manner:
- * - All matching LOG rules are always applied.
- * - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
- * Logging will be applied if one or more matching rule requires logging.
- * - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
- * granted.
- * Logging will be applied if one or more matching rule requires logging.
- * - Otherwise, if no rule applies, permission is denied.
- */
- core.List<Rule> rules;
- /** Version of the `Policy`. The default version is 0. */
+
+ /// Version of the `Policy`. The default version is 0.
core.int version;
Policy();
Policy.fromJson(core.Map _json) {
if (_json.containsKey("auditConfigs")) {
- auditConfigs = _json["auditConfigs"].map((value) => new AuditConfig.fromJson(value)).toList();
+ auditConfigs = _json["auditConfigs"]
+ .map((value) => new AuditConfig.fromJson(value))
+ .toList();
}
if (_json.containsKey("bindings")) {
- bindings = _json["bindings"].map((value) => new Binding.fromJson(value)).toList();
+ bindings = _json["bindings"]
+ .map((value) => new Binding.fromJson(value))
+ .toList();
}
if (_json.containsKey("etag")) {
etag = _json["etag"];
@@ -5800,18 +5480,17 @@ class Policy {
if (_json.containsKey("iamOwned")) {
iamOwned = _json["iamOwned"];
}
- if (_json.containsKey("rules")) {
- rules = _json["rules"].map((value) => new Rule.fromJson(value)).toList();
- }
if (_json.containsKey("version")) {
version = _json["version"];
}
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (auditConfigs != null) {
- _json["auditConfigs"] = auditConfigs.map((value) => (value).toJson()).toList();
+ _json["auditConfigs"] =
+ auditConfigs.map((value) => (value).toJson()).toList();
}
if (bindings != null) {
_json["bindings"] = bindings.map((value) => (value).toJson()).toList();
@@ -5822,9 +5501,6 @@ class Policy {
if (iamOwned != null) {
_json["iamOwned"] = iamOwned;
}
- if (rules != null) {
- _json["rules"] = rules.map((value) => (value).toJson()).toList();
- }
if (version != null) {
_json["version"] = version;
}
@@ -5832,201 +5508,196 @@ class Policy {
}
}
-/**
- * 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();
@@ -6065,7 +5736,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;
}
@@ -6100,57 +5772,57 @@ class QuotaLimit {
}
}
-/**
- * A rollout resource that defines how service configuration versions are pushed
- * to control plane systems. Typically, you create a new version of the
- * service config, and then create a Rollout to push the service config.
- */
+/// A rollout resource that defines how service configuration versions are
+/// pushed
+/// to control plane systems. Typically, you create a new version of the
+/// service config, and then create a Rollout to push the service config.
class Rollout {
- /** Creation time of the rollout. Readonly. */
+ /// Creation time of the rollout. Readonly.
core.String createTime;
- /** The user who created the Rollout. Readonly. */
+
+ /// The user who created the Rollout. Readonly.
core.String createdBy;
- /**
- * The strategy associated with a rollout to delete a `ManagedService`.
- * Readonly.
- */
+
+ /// The strategy associated with a rollout to delete a `ManagedService`.
+ /// Readonly.
DeleteServiceStrategy deleteServiceStrategy;
- /**
- * Optional unique identifier of this Rollout. Only lower case letters, digits
- * and '-' are allowed.
- *
- * If not specified by client, the server will generate one. The generated id
- * will have the form of <date><revision number>, where "date" is the create
- * date in ISO 8601 format. "revision number" is a monotonically increasing
- * positive number that is reset every day for each service.
- * An example of the generated rollout_id is '2016-02-16r1'
- */
+
+ /// Optional unique identifier of this Rollout. Only lower case letters,
+ /// digits
+ /// and '-' are allowed.
+ ///
+ /// If not specified by client, the server will generate one. The generated
+ /// id
+ /// will have the form of <date><revision number>, where "date" is the create
+ /// date in ISO 8601 format. "revision number" is a monotonically increasing
+ /// positive number that is reset every day for each service.
+ /// An example of the generated rollout_id is '2016-02-16r1'
core.String rolloutId;
- /** The name of the service associated with this Rollout. */
+
+ /// The name of the service associated with this Rollout.
core.String serviceName;
- /**
- * The status of this rollout. Readonly. In case of a failed rollout,
- * the system will automatically rollback to the current Rollout
- * version. Readonly.
- * Possible string values are:
- * - "ROLLOUT_STATUS_UNSPECIFIED" : No status specified.
- * - "IN_PROGRESS" : The Rollout is in progress.
- * - "SUCCESS" : The Rollout has completed successfully.
- * - "CANCELLED" : The Rollout has been cancelled. This can happen if you have
- * overlapping
- * Rollout pushes, and the previous ones will be cancelled.
- * - "FAILED" : The Rollout has failed and the rollback attempt has failed
- * too.
- * - "PENDING" : The Rollout has not started yet and is pending for execution.
- * - "FAILED_ROLLED_BACK" : The Rollout has failed and rolled back to the
- * previous successful
- * Rollout.
- */
+
+ /// The status of this rollout. Readonly. In case of a failed rollout,
+ /// the system will automatically rollback to the current Rollout
+ /// version. Readonly.
+ /// Possible string values are:
+ /// - "ROLLOUT_STATUS_UNSPECIFIED" : No status specified.
+ /// - "IN_PROGRESS" : The Rollout is in progress.
+ /// - "SUCCESS" : The Rollout has completed successfully.
+ /// - "CANCELLED" : The Rollout has been cancelled. This can happen if you
+ /// have overlapping
+ /// Rollout pushes, and the previous ones will be cancelled.
+ /// - "FAILED" : The Rollout has failed and the rollback attempt has failed
+ /// too.
+ /// - "PENDING" : The Rollout has not started yet and is pending for
+ /// execution.
+ /// - "FAILED_ROLLED_BACK" : The Rollout has failed and rolled back to the
+ /// previous successful
+ /// Rollout.
core.String status;
- /**
- * Google Service Control selects service configurations based on
- * traffic percentage.
- */
+
+ /// Google Service Control selects service configurations based on
+ /// traffic percentage.
TrafficPercentStrategy trafficPercentStrategy;
Rollout();
@@ -6163,7 +5835,8 @@ class Rollout {
createdBy = _json["createdBy"];
}
if (_json.containsKey("deleteServiceStrategy")) {
- deleteServiceStrategy = new DeleteServiceStrategy.fromJson(_json["deleteServiceStrategy"]);
+ deleteServiceStrategy =
+ new DeleteServiceStrategy.fromJson(_json["deleteServiceStrategy"]);
}
if (_json.containsKey("rolloutId")) {
rolloutId = _json["rolloutId"];
@@ -6175,12 +5848,14 @@ class Rollout {
status = _json["status"];
}
if (_json.containsKey("trafficPercentStrategy")) {
- trafficPercentStrategy = new TrafficPercentStrategy.fromJson(_json["trafficPercentStrategy"]);
+ trafficPercentStrategy =
+ new TrafficPercentStrategy.fromJson(_json["trafficPercentStrategy"]);
}
}
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 (createTime != null) {
_json["createTime"] = createTime;
}
@@ -6206,235 +5881,144 @@ class Rollout {
}
}
-/** A rule to be applied in a Policy. */
-class Rule {
- /**
- * Required
- * Possible string values are:
- * - "NO_ACTION" : Default no action.
- * - "ALLOW" : Matching 'Entries' grant access.
- * - "ALLOW_WITH_LOG" : Matching 'Entries' grant access and the caller
- * promises to log
- * the request per the returned log_configs.
- * - "DENY" : Matching 'Entries' deny access.
- * - "DENY_WITH_LOG" : Matching 'Entries' deny access and the caller promises
- * to log
- * the request per the returned log_configs.
- * - "LOG" : Matching 'Entries' tell IAM.Check callers to generate logs.
- */
- core.String action;
- /** Additional restrictions that must be met */
- core.List<Condition> conditions;
- /** Human-readable description of the rule. */
- core.String description;
- /**
- * If one or more 'in' clauses are specified, the rule matches if
- * the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
- */
- core.List<core.String> in_;
- /**
- * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
- * that match the LOG action.
- */
- core.List<LogConfig> logConfig;
- /**
- * If one or more 'not_in' clauses are specified, the rule matches
- * if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
- * The format for in and not_in entries is the same as for members in a
- * Binding (see google/iam/v1/policy.proto).
- */
- core.List<core.String> notIn;
- /**
- * A permission is a string of form '<service>.<resource type>.<verb>'
- * (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
- * and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
- */
- core.List<core.String> permissions;
-
- Rule();
-
- Rule.fromJson(core.Map _json) {
- if (_json.containsKey("action")) {
- action = _json["action"];
- }
- if (_json.containsKey("conditions")) {
- conditions = _json["conditions"].map((value) => new Condition.fromJson(value)).toList();
- }
- if (_json.containsKey("description")) {
- description = _json["description"];
- }
- if (_json.containsKey("in")) {
- in_ = _json["in"];
- }
- if (_json.containsKey("logConfig")) {
- logConfig = _json["logConfig"].map((value) => new LogConfig.fromJson(value)).toList();
- }
- if (_json.containsKey("notIn")) {
- notIn = _json["notIn"];
- }
- if (_json.containsKey("permissions")) {
- permissions = _json["permissions"];
- }
- }
-
- core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
- if (action != null) {
- _json["action"] = action;
- }
- if (conditions != null) {
- _json["conditions"] = conditions.map((value) => (value).toJson()).toList();
- }
- if (description != null) {
- _json["description"] = description;
- }
- if (in_ != null) {
- _json["in"] = in_;
- }
- if (logConfig != null) {
- _json["logConfig"] = logConfig.map((value) => (value).toJson()).toList();
- }
- if (notIn != null) {
- _json["notIn"] = notIn;
- }
- if (permissions != null) {
- _json["permissions"] = permissions;
- }
- return _json;
- }
-}
-
-/**
- * `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();
@@ -6465,7 +6049,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();
@@ -6483,13 +6069,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"]);
@@ -6507,10 +6099,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"];
@@ -6527,7 +6122,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();
}
@@ -6577,7 +6173,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();
@@ -6598,7 +6195,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;
@@ -6616,22 +6214,21 @@ class Service {
}
}
-/** Request message for `SetIamPolicy` method. */
+/// Request message for `SetIamPolicy` method.
class SetIamPolicyRequest {
- /**
- * REQUIRED: The complete policy to be applied to the `resource`. The size of
- * the policy is limited to a few 10s of KB. An empty policy is a
- * valid policy but certain Cloud Platform services (such as Projects)
- * might reject them.
- */
+ /// REQUIRED: The complete policy to be applied to the `resource`. The size
+ /// of
+ /// the policy is limited to a few 10s of KB. An empty policy is a
+ /// valid policy but certain Cloud Platform services (such as Projects)
+ /// might reject them.
Policy policy;
- /**
- * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
- * the fields in the mask will be modified. If no mask is provided, the
- * following default mask is used:
- * paths: "bindings, etag"
- * This field is only used by Cloud IAM.
- */
+
+ /// OPTIONAL: A FieldMask specifying which fields of the policy to modify.
+ /// Only
+ /// the fields in the mask will be modified. If no mask is provided, the
+ /// following default mask is used:
+ /// paths: "bindings, etag"
+ /// This field is only used by Cloud IAM.
core.String updateMask;
SetIamPolicyRequest();
@@ -6646,7 +6243,8 @@ class SetIamPolicyRequest {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (policy != null) {
_json["policy"] = (policy).toJson();
}
@@ -6657,15 +6255,11 @@ class SetIamPolicyRequest {
}
}
-/**
- * `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();
@@ -6677,7 +6271,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;
}
@@ -6685,14 +6280,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();
@@ -6704,7 +6297,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;
}
@@ -6712,78 +6306,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();
@@ -6801,7 +6398,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;
}
@@ -6815,22 +6413,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();
@@ -6845,7 +6442,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;
}
@@ -6856,15 +6454,14 @@ class Step {
}
}
-/** Request message for SubmitConfigSource method. */
+/// Request message for SubmitConfigSource method.
class SubmitConfigSourceRequest {
- /** The source configuration for the service. */
+ /// The source configuration for the service.
ConfigSource configSource;
- /**
- * Optional. If set, this will result in the generation of a
- * `google.api.Service` configuration based on the `ConfigSource` provided,
- * but the generated config and the sources will NOT be persisted.
- */
+
+ /// Optional. If set, this will result in the generation of a
+ /// `google.api.Service` configuration based on the `ConfigSource` provided,
+ /// but the generated config and the sources will NOT be persisted.
core.bool validateOnly;
SubmitConfigSourceRequest();
@@ -6879,7 +6476,8 @@ class SubmitConfigSourceRequest {
}
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 (configSource != null) {
_json["configSource"] = (configSource).toJson();
}
@@ -6890,9 +6488,9 @@ class SubmitConfigSourceRequest {
}
}
-/** Response message for SubmitConfigSource method. */
+/// Response message for SubmitConfigSource method.
class SubmitConfigSourceResponse {
- /** The generated service configuration. */
+ /// The generated service configuration.
Service serviceConfig;
SubmitConfigSourceResponse();
@@ -6904,7 +6502,8 @@ class SubmitConfigSourceResponse {
}
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 (serviceConfig != null) {
_json["serviceConfig"] = (serviceConfig).toJson();
}
@@ -6912,25 +6511,22 @@ class SubmitConfigSourceResponse {
}
}
-/**
- * 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();
@@ -6948,7 +6544,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;
}
@@ -6962,32 +6559,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"];
@@ -6995,9 +6589,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;
@@ -7006,58 +6602,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();
}
@@ -7065,14 +6660,12 @@ class SystemParameters {
}
}
-/** Request message for `TestIamPermissions` method. */
+/// Request message for `TestIamPermissions` method.
class TestIamPermissionsRequest {
- /**
- * The set of permissions to check for the `resource`. Permissions with
- * wildcards (such as '*' or 'storage.*') are not allowed. For more
- * information see
- * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
- */
+ /// The set of permissions to check for the `resource`. Permissions with
+ /// wildcards (such as '*' or 'storage.*') are not allowed. For more
+ /// information see
+ /// [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
core.List<core.String> permissions;
TestIamPermissionsRequest();
@@ -7084,7 +6677,8 @@ class TestIamPermissionsRequest {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (permissions != null) {
_json["permissions"] = permissions;
}
@@ -7092,12 +6686,10 @@ class TestIamPermissionsRequest {
}
}
-/** Response message for `TestIamPermissions` method. */
+/// Response message for `TestIamPermissions` method.
class TestIamPermissionsResponse {
- /**
- * A subset of `TestPermissionsRequest.permissions` that the caller is
- * allowed.
- */
+ /// A subset of `TestPermissionsRequest.permissions` that the caller is
+ /// allowed.
core.List<core.String> permissions;
TestIamPermissionsResponse();
@@ -7109,7 +6701,8 @@ class TestIamPermissionsResponse {
}
core.Map<core.String, core.Object> toJson() {
- final core.Map<core.String, core.Object> _json = new core.Map<core.String, core.Object>();
+ final core.Map<core.String, core.Object> _json =
+ new core.Map<core.String, core.Object>();
if (permissions != null) {
_json["permissions"] = permissions;
}
@@ -7117,44 +6710,40 @@ class TestIamPermissionsResponse {
}
}
-/**
- * Strategy that specifies how clients of Google Service Controller want to
- * send traffic to use different config versions. This is generally
- * used by API proxy to split traffic based on your configured precentage for
- * each config version.
- *
- * One example of how to gradually rollout a new service configuration using
- * this
- * strategy:
- * Day 1
- *
- * Rollout {
- * id: "example.googleapis.com/rollout_20160206"
- * traffic_percent_strategy {
- * percentages: {
- * "example.googleapis.com/20160201": 70.00
- * "example.googleapis.com/20160206": 30.00
- * }
- * }
- * }
- *
- * Day 2
- *
- * Rollout {
- * id: "example.googleapis.com/rollout_20160207"
- * traffic_percent_strategy: {
- * percentages: {
- * "example.googleapis.com/20160206": 100.00
- * }
- * }
- * }
- */
+/// Strategy that specifies how clients of Google Service Controller want to
+/// send traffic to use different config versions. This is generally
+/// used by API proxy to split traffic based on your configured precentage for
+/// each config version.
+///
+/// One example of how to gradually rollout a new service configuration using
+/// this
+/// strategy:
+/// Day 1
+///
+/// Rollout {
+/// id: "example.googleapis.com/rollout_20160206"
+/// traffic_percent_strategy {
+/// percentages: {
+/// "example.googleapis.com/20160201": 70.00
+/// "example.googleapis.com/20160206": 30.00
+/// }
+/// }
+/// }
+///
+/// Day 2
+///
+/// Rollout {
+/// id: "example.googleapis.com/rollout_20160207"
+/// traffic_percent_strategy: {
+/// percentages: {
+/// "example.googleapis.com/20160206": 100.00
+/// }
+/// }
+/// }
class TrafficPercentStrategy {
- /**
- * Maps service configuration IDs to their corresponding traffic percentage.
- * Key is the service configuration ID, Value is the traffic percentage
- * which must be greater than 0.0 and the sum must equal to 100.0.
- */
+ /// Maps service configuration IDs to their corresponding traffic percentage.
+ /// Key is the service configuration ID, Value is the traffic percentage
+ /// which must be greater than 0.0 and the sum must equal to 100.0.
core.Map<core.String, core.double> percentages;
TrafficPercentStrategy();
@@ -7166,7 +6755,8 @@ class TrafficPercentStrategy {
}
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 (percentages != null) {
_json["percentages"] = percentages;
}
@@ -7174,31 +6764,35 @@ class TrafficPercentStrategy {
}
}
-/** 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"];
@@ -7207,7 +6801,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"]);
@@ -7218,7 +6813,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();
}
@@ -7241,9 +6837,9 @@ class Type {
}
}
-/** Response message for UndeleteService method. */
+/// Response message for UndeleteService method.
class UndeleteServiceResponse {
- /** Revived service resource. */
+ /// Revived service resource.
ManagedService service;
UndeleteServiceResponse();
@@ -7255,7 +6851,8 @@ class UndeleteServiceResponse {
}
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 (service != null) {
_json["service"] = (service).toJson();
}
@@ -7263,30 +6860,27 @@ class UndeleteServiceResponse {
}
}
-/** 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();
@@ -7299,12 +6893,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;
}
@@ -7318,47 +6914,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();
@@ -7376,7 +6970,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;
}
@@ -7390,48 +6985,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();
}
@@ -7439,34 +7033,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();
@@ -7481,7 +7071,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;
}
« no previous file with comments | « generated/googleapis/lib/servicecontrol/v1.dart ('k') | generated/googleapis/lib/serviceuser/v1.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698