| // This is a generated file (see the discoveryapis_generator project). |
| |
| // ignore_for_file: camel_case_types |
| // ignore_for_file: comment_references |
| // ignore_for_file: file_names |
| // ignore_for_file: library_names |
| // ignore_for_file: lines_longer_than_80_chars |
| // ignore_for_file: non_constant_identifier_names |
| // ignore_for_file: prefer_expression_function_bodies |
| // ignore_for_file: prefer_final_locals |
| // ignore_for_file: prefer_interpolation_to_compose_strings |
| // ignore_for_file: unnecessary_brace_in_string_interps |
| // ignore_for_file: unnecessary_cast |
| // ignore_for_file: unnecessary_lambdas |
| // ignore_for_file: unnecessary_parenthesis |
| // ignore_for_file: unnecessary_string_interpolations |
| |
| /// Service Usage API - v1 |
| /// |
| /// Enables services that service consumers want to use on Google Cloud |
| /// Platform, lists the available or enabled services, or disables services that |
| /// service consumers no longer use. |
| /// |
| /// For more information, see <https://cloud.google.com/service-usage/> |
| /// |
| /// Create an instance of [ServiceUsageApi] to access these resources: |
| /// |
| /// - [OperationsResource] |
| /// - [ServicesResource] |
| library serviceusage.v1; |
| |
| import 'dart:async' as async; |
| import 'dart:convert' as convert; |
| import 'dart:core' as core; |
| |
| import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
| import 'package:http/http.dart' as http_1; |
| |
| import '../src/user_agent.dart'; |
| |
| export 'package:_discoveryapis_commons/_discoveryapis_commons.dart' |
| show ApiRequestError, DetailedApiRequestError; |
| |
| /// Enables services that service consumers want to use on Google Cloud |
| /// Platform, lists the available or enabled services, or disables services that |
| /// service consumers no longer use. |
| class ServiceUsageApi { |
| /// View and manage your data across Google Cloud Platform services |
| static const cloudPlatformScope = |
| 'https://www.googleapis.com/auth/cloud-platform'; |
| |
| /// View your data across Google Cloud Platform services |
| static const cloudPlatformReadOnlyScope = |
| 'https://www.googleapis.com/auth/cloud-platform.read-only'; |
| |
| /// Manage your Google API service configuration |
| static const serviceManagementScope = |
| 'https://www.googleapis.com/auth/service.management'; |
| |
| final commons.ApiRequester _requester; |
| |
| OperationsResource get operations => OperationsResource(_requester); |
| ServicesResource get services => ServicesResource(_requester); |
| |
| ServiceUsageApi(http_1.Client client, |
| {core.String rootUrl = 'https://serviceusage.googleapis.com/', |
| core.String servicePath = ''}) |
| : _requester = |
| commons.ApiRequester(client, rootUrl, servicePath, userAgent); |
| } |
| |
| class OperationsResource { |
| final commons.ApiRequester _requester; |
| |
| OperationsResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Starts asynchronous cancellation on a long-running operation. |
| /// |
| /// The server makes a best effort to cancel the operation, but success is not |
| /// guaranteed. If the server doesn't support this method, it returns |
| /// `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation |
| /// or other methods to check whether the cancellation succeeded or whether |
| /// the operation completed despite cancellation. On successful cancellation, |
| /// the operation is not deleted; instead, it becomes an operation with an |
| /// Operation.error value with a google.rpc.Status.code of 1, corresponding to |
| /// `Code.CANCELLED`. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The name of the operation resource to be cancelled. |
| /// Value must have pattern `^operations/.*$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Empty> cancel( |
| CancelOperationRequest request, |
| core.String name, { |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':cancel'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return Empty.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes a long-running operation. |
| /// |
| /// This method indicates that the client is no longer interested in the |
| /// operation result. It does not cancel the operation. If the server doesn't |
| /// support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The name of the operation resource to be deleted. |
| /// Value must have pattern `^operations/.*$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Empty]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Empty> delete( |
| core.String name, { |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = await _requester.request( |
| _url, |
| 'DELETE', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return Empty.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// 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/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// 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, { |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Lists operations that match the specified filter in the request. |
| /// |
| /// If the server doesn't support this method, it returns `UNIMPLEMENTED`. |
| /// NOTE: the `name` binding allows API services to override the binding to |
| /// use different resource name schemes, such as `users / * /operations`. To |
| /// override the binding, API services can add a binding such as |
| /// `"/v1/{name=users / * }/operations"` to their service configuration. For |
| /// backwards compatibility, the default name includes the operations |
| /// collection id, however overriding users must ensure the name binding is |
| /// the parent resource, without the operations collection id. |
| /// |
| /// Request parameters: |
| /// |
| /// [filter] - The standard list filter. |
| /// |
| /// [name] - The name of the operation's parent resource. |
| /// |
| /// [pageSize] - The standard list page size. |
| /// |
| /// [pageToken] - The standard list page token. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListOperationsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_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 filter, |
| core.String name, |
| core.int pageSize, |
| core.String pageToken, |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (filter != null) { |
| _queryParams['filter'] = [filter]; |
| } |
| if (name != null) { |
| _queryParams['name'] = [name]; |
| } |
| if (pageSize != null) { |
| _queryParams['pageSize'] = ['${pageSize}']; |
| } |
| if (pageToken != null) { |
| _queryParams['pageToken'] = [pageToken]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/operations'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return ListOperationsResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| class ServicesResource { |
| final commons.ApiRequester _requester; |
| |
| ServicesResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Enable multiple services on a project. |
| /// |
| /// The operation is atomic: if enabling any service fails, then the entire |
| /// batch fails, and no state changes occur. To enable a single service, use |
| /// the `EnableService` method instead. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Parent to enable services on. An example name would be: |
| /// `projects/123` where `123` is the project number. The |
| /// `BatchEnableServices` method currently only supports projects. |
| /// Value must have pattern `^\[^/\]+/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// 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> batchEnable( |
| BatchEnableServicesRequest request, |
| core.String parent, { |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/services:batchEnable'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Returns the service configurations and enabled states for a given list of |
| /// services. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Parent to retrieve services from. If this is set, the parent of |
| /// all of the services specified in `names` must match this field. An example |
| /// name would be: `projects/123` where `123` is the project number. The |
| /// `BatchGetServices` method currently only supports projects. |
| /// Value must have pattern `^\[^/\]+/\[^/\]+$`. |
| /// |
| /// [names] - Names of the services to retrieve. An example name would be: |
| /// `projects/123/services/serviceusage.googleapis.com` where `123` is the |
| /// project number. A single request can get a maximum of 30 services at a |
| /// time. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [BatchGetServicesResponse]. |
| /// |
| /// 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<BatchGetServicesResponse> batchGet( |
| core.String parent, { |
| core.List<core.String> names, |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (names != null) { |
| _queryParams['names'] = names; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + |
| commons.Escaper.ecapeVariableReserved('$parent') + |
| '/services:batchGet'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return BatchGetServicesResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Disable a service so that it can no longer be used with a project. |
| /// |
| /// This prevents unintended usage that may cause unexpected billing charges |
| /// or security leaks. It is not valid to call the disable method on a service |
| /// that is not currently enabled. Callers will receive a |
| /// `FAILED_PRECONDITION` status if the target service is not currently |
| /// enabled. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Name of the consumer and service to disable the service on. The |
| /// enable and disable methods currently only support projects. An example |
| /// name would be: `projects/123/services/serviceusage.googleapis.com` where |
| /// `123` is the project number. |
| /// Value must have pattern `^\[^/\]+/\[^/\]+/services/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Operation> disable( |
| DisableServiceRequest request, |
| core.String name, { |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':disable'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Enable a service so that it can be used with a project. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Name of the consumer and service to enable the service on. The |
| /// `EnableService` and `DisableService` methods currently only support |
| /// projects. Enabling a service requires that the service is public or is |
| /// shared with the user enabling the service. An example name would be: |
| /// `projects/123/services/serviceusage.googleapis.com` where `123` is the |
| /// project number. |
| /// Value must have pattern `^\[^/\]+/\[^/\]+/services/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Operation]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Operation> enable( |
| EnableServiceRequest request, |
| core.String name, { |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (request != null) { |
| _body = convert.json.encode(request.toJson()); |
| } |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name') + ':enable'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Returns the service configuration and enabled state for a given service. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - Name of the consumer and service to get the `ConsumerState` for. |
| /// An example name would be: |
| /// `projects/123/services/serviceusage.googleapis.com` where `123` is the |
| /// project number. |
| /// Value must have pattern `^\[^/\]+/\[^/\]+/services/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GoogleApiServiceusageV1Service]. |
| /// |
| /// 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<GoogleApiServiceusageV1Service> get( |
| core.String name, { |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (name == null) { |
| throw core.ArgumentError('Parameter name is required.'); |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return GoogleApiServiceusageV1Service.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// List all services available to the specified project, and the current |
| /// state of those services with respect to the project. |
| /// |
| /// The list includes all public services, all services for which the calling |
| /// user has the `servicemanagement.services.bind` permission, and all |
| /// services that have already been enabled on the project. The list can be |
| /// filtered to only include services in a specific state, for example to only |
| /// include services enabled on the project. WARNING: If you need to query |
| /// enabled services frequently or across an organization, you should use |
| /// [Cloud Asset Inventory API](https://cloud.google.com/asset-inventory/docs/apis), |
| /// which provides higher throughput and richer filtering capability. |
| /// |
| /// Request parameters: |
| /// |
| /// [parent] - Parent to search for services on. An example name would be: |
| /// `projects/123` where `123` is the project number. |
| /// Value must have pattern `^\[^/\]+/\[^/\]+$`. |
| /// |
| /// [filter] - Only list services that conform to the given filter. The |
| /// allowed filter strings are `state:ENABLED` and `state:DISABLED`. |
| /// |
| /// [pageSize] - Requested size of the next page of data. Requested page size |
| /// cannot exceed 200. If not set, the default page size is 50. |
| /// |
| /// [pageToken] - Token identifying which result to start with, which is |
| /// returned by a previous list call. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// 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 parent, { |
| core.String filter, |
| core.int pageSize, |
| core.String pageToken, |
| core.String $fields, |
| }) async { |
| core.String _url; |
| final _queryParams = <core.String, core.List<core.String>>{}; |
| commons.Media _uploadMedia; |
| commons.UploadOptions _uploadOptions; |
| var _downloadOptions = commons.DownloadOptions.Metadata; |
| core.String _body; |
| |
| if (parent == null) { |
| throw core.ArgumentError('Parameter parent is required.'); |
| } |
| if (filter != null) { |
| _queryParams['filter'] = [filter]; |
| } |
| if (pageSize != null) { |
| _queryParams['pageSize'] = ['${pageSize}']; |
| } |
| if (pageToken != null) { |
| _queryParams['pageToken'] = [pageToken]; |
| } |
| if ($fields != null) { |
| _queryParams['fields'] = [$fields]; |
| } |
| |
| _url = |
| 'v1/' + commons.Escaper.ecapeVariableReserved('$parent') + '/services'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| body: _body, |
| queryParams: _queryParams, |
| uploadOptions: _uploadOptions, |
| uploadMedia: _uploadMedia, |
| downloadOptions: _downloadOptions, |
| ); |
| return ListServicesResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| /// Quota policy created by quota administrator. |
| class AdminQuotaPolicy { |
| /// The cloud resource container at which the quota policy is created. |
| /// |
| /// The format is {container_type}/{container_number} |
| core.String container; |
| |
| /// If this map is nonempty, then this policy applies only to specific values |
| /// for dimensions defined in the limit unit. |
| /// |
| /// For example, an policy on a limit with the unit 1/{project}/{region} could |
| /// contain an entry with the key "region" and the value "us-east-1"; the |
| /// policy is only applied to quota consumed in that region. This map has the |
| /// following restrictions: * If "region" appears as a key, its value must be |
| /// a valid Cloud region. * If "zone" appears as a key, its value must be a |
| /// valid Cloud zone. * Keys other than "region" or "zone" are not valid. |
| core.Map<core.String, core.String> dimensions; |
| |
| /// The name of the metric to which this policy applies. |
| /// |
| /// An example name would be: `compute.googleapis.com/cpus` |
| core.String metric; |
| |
| /// The resource name of the policy. |
| /// |
| /// This name is generated by the server when the policy is created. Example |
| /// names would be: |
| /// `organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` |
| core.String name; |
| |
| /// The quota policy value. |
| /// |
| /// Can be any nonnegative integer, or -1 (unlimited quota). |
| core.String policyValue; |
| |
| /// The limit unit of the limit to which this policy applies. |
| /// |
| /// An example unit would be: `1/{project}/{region}` Note that `{project}` and |
| /// `{region}` are not placeholders in this example; the literal characters |
| /// `{` and `}` occur in the string. |
| core.String unit; |
| |
| AdminQuotaPolicy(); |
| |
| AdminQuotaPolicy.fromJson(core.Map _json) { |
| if (_json.containsKey('container')) { |
| container = _json['container'] as core.String; |
| } |
| if (_json.containsKey('dimensions')) { |
| dimensions = (_json['dimensions'] as core.Map) |
| .cast<core.String, core.String>() |
| .map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.String, |
| ), |
| ); |
| } |
| if (_json.containsKey('metric')) { |
| metric = _json['metric'] as core.String; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('policyValue')) { |
| policyValue = _json['policyValue'] as core.String; |
| } |
| if (_json.containsKey('unit')) { |
| unit = _json['unit'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (container != null) { |
| _json['container'] = container; |
| } |
| if (dimensions != null) { |
| _json['dimensions'] = dimensions; |
| } |
| if (metric != null) { |
| _json['metric'] = metric; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (policyValue != null) { |
| _json['policyValue'] = policyValue; |
| } |
| if (unit != null) { |
| _json['unit'] = unit; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.List<Method> methods; |
| |
| /// 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. |
| core.String name; |
| |
| /// Any metadata attached to the interface. |
| core.List<Option> options; |
| |
| /// 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`. |
| 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`, 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'] as core.List) |
| .map<Method>((value) => |
| Method.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('mixins')) { |
| mixins = (_json['mixins'] as core.List) |
| .map<Mixin>((value) => |
| Mixin.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('options')) { |
| options = (_json['options'] as core.List) |
| .map<Option>((value) => |
| Option.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('sourceContext')) { |
| sourceContext = SourceContext.fromJson( |
| _json['sourceContext'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('syntax')) { |
| syntax = _json['syntax'] as core.String; |
| } |
| if (_json.containsKey('version')) { |
| version = _json['version'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (methods != null) { |
| _json['methods'] = methods.map((value) => value.toJson()).toList(); |
| } |
| if (mixins != null) { |
| _json['mixins'] = mixins.map((value) => value.toJson()).toList(); |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (options != null) { |
| _json['options'] = options.map((value) => value.toJson()).toList(); |
| } |
| if (sourceContext != null) { |
| _json['sourceContext'] = sourceContext.toJson(); |
| } |
| if (syntax != null) { |
| _json['syntax'] = syntax; |
| } |
| if (version != null) { |
| _json['version'] = version; |
| } |
| return _json; |
| } |
| } |
| |
| /// Configuration for an authentication 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, JWTs with audiences: - |
| /// "https://\[service.name\]/\[google.protobuf.Api.name\]" - |
| /// "https://\[service.name\]/" will be accepted. For example, if no audiences |
| /// are in the setting, LibraryService API will accept JWTs with the following |
| /// audiences: - |
| /// https://library-example.googleapis.com/google.example.library.v1.LibraryService |
| /// - https://library-example.googleapis.com/ Example: audiences: |
| /// bookstore_android.apps.googleusercontent.com, |
| /// bookstore_web.apps.googleusercontent.com |
| core.String audiences; |
| |
| /// Redirect URL if JWT token is required but not 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". |
| 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 |
| 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 |
| core.String jwksUri; |
| |
| /// Defines the locations to extract the JWT. |
| /// |
| /// JWT locations can be either from HTTP headers or URL query parameters. The |
| /// rule is that the first match wins. The checking order is: checking all |
| /// headers first, then URL query parameters. If not specified, default to use |
| /// following 3 locations: 1) Authorization: Bearer 2) |
| /// x-goog-iap-jwt-assertion 3) access_token query parameter Default locations |
| /// can be specified as followings: jwt_locations: - header: Authorization |
| /// value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: |
| /// access_token |
| core.List<JwtLocation> jwtLocations; |
| |
| AuthProvider(); |
| |
| AuthProvider.fromJson(core.Map _json) { |
| if (_json.containsKey('audiences')) { |
| audiences = _json['audiences'] as core.String; |
| } |
| if (_json.containsKey('authorizationUrl')) { |
| authorizationUrl = _json['authorizationUrl'] as core.String; |
| } |
| if (_json.containsKey('id')) { |
| id = _json['id'] as core.String; |
| } |
| if (_json.containsKey('issuer')) { |
| issuer = _json['issuer'] as core.String; |
| } |
| if (_json.containsKey('jwksUri')) { |
| jwksUri = _json['jwksUri'] as core.String; |
| } |
| if (_json.containsKey('jwtLocations')) { |
| jwtLocations = (_json['jwtLocations'] as core.List) |
| .map<JwtLocation>((value) => JwtLocation.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (audiences != null) { |
| _json['audiences'] = audiences; |
| } |
| if (authorizationUrl != null) { |
| _json['authorizationUrl'] = authorizationUrl; |
| } |
| if (id != null) { |
| _json['id'] = id; |
| } |
| if (issuer != null) { |
| _json['issuer'] = issuer; |
| } |
| if (jwksUri != null) { |
| _json['jwksUri'] = jwksUri; |
| } |
| if (jwtLocations != null) { |
| _json['jwtLocations'] = |
| jwtLocations.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// 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 |
| core.String audiences; |
| |
| /// id from authentication provider. |
| /// |
| /// Example: provider_id: bookstore_auth |
| core.String providerId; |
| |
| AuthRequirement(); |
| |
| AuthRequirement.fromJson(core.Map _json) { |
| if (_json.containsKey('audiences')) { |
| audiences = _json['audiences'] as core.String; |
| } |
| if (_json.containsKey('providerId')) { |
| providerId = _json['providerId'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (audiences != null) { |
| _json['audiences'] = audiences; |
| } |
| if (providerId != null) { |
| _json['providerId'] = providerId; |
| } |
| return _json; |
| } |
| } |
| |
| /// `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. |
| 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. |
| core.List<AuthenticationRule> rules; |
| |
| Authentication(); |
| |
| Authentication.fromJson(core.Map _json) { |
| if (_json.containsKey('providers')) { |
| providers = (_json['providers'] as core.List) |
| .map<AuthProvider>((value) => AuthProvider.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('rules')) { |
| rules = (_json['rules'] as core.List) |
| .map<AuthenticationRule>((value) => AuthenticationRule.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (providers != null) { |
| _json['providers'] = providers.map((value) => value.toJson()).toList(); |
| } |
| if (rules != null) { |
| _json['rules'] = rules.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// 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 { |
| /// If true, the service accepts API keys without any other credential. |
| /// |
| /// This flag only applies to HTTP and gRPC requests. |
| core.bool allowWithoutCredential; |
| |
| /// The requirements for OAuth credentials. |
| OAuthRequirements oauth; |
| |
| /// Requirements for additional authentication providers. |
| core.List<AuthRequirement> requirements; |
| |
| /// Selects the methods to which this rule applies. |
| /// |
| /// Refer to selector for syntax details. |
| core.String selector; |
| |
| AuthenticationRule(); |
| |
| AuthenticationRule.fromJson(core.Map _json) { |
| if (_json.containsKey('allowWithoutCredential')) { |
| allowWithoutCredential = _json['allowWithoutCredential'] as core.bool; |
| } |
| if (_json.containsKey('oauth')) { |
| oauth = OAuthRequirements.fromJson( |
| _json['oauth'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('requirements')) { |
| requirements = (_json['requirements'] as core.List) |
| .map<AuthRequirement>((value) => AuthRequirement.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (allowWithoutCredential != null) { |
| _json['allowWithoutCredential'] = allowWithoutCredential; |
| } |
| if (oauth != null) { |
| _json['oauth'] = oauth.toJson(); |
| } |
| if (requirements != null) { |
| _json['requirements'] = |
| requirements.map((value) => value.toJson()).toList(); |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| return _json; |
| } |
| } |
| |
| /// `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. |
| core.List<BackendRule> rules; |
| |
| Backend(); |
| |
| Backend.fromJson(core.Map _json) { |
| if (_json.containsKey('rules')) { |
| rules = (_json['rules'] as core.List) |
| .map<BackendRule>((value) => BackendRule.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (rules != null) { |
| _json['rules'] = rules.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// A backend rule provides configuration for an individual API element. |
| class BackendRule { |
| /// The address of the API backend. |
| /// |
| /// The scheme is used to determine the backend protocol and security. The |
| /// following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None |
| /// https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to |
| /// explicitly include a scheme. Leaving out the scheme may cause constrasting |
| /// behaviors across platforms. If the port is unspecified, the default is: - |
| /// 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, |
| /// use protocol to specify the protocol version. |
| core.String address; |
| |
| /// The number of seconds to wait for a response from a request. |
| /// |
| /// The default varies based on the request protocol and deployment |
| /// environment. |
| core.double deadline; |
| |
| /// When disable_auth is true, a JWT ID token won't be generated and the |
| /// original "Authorization" HTTP header will be preserved. |
| /// |
| /// If the header is used to carry the original token and is expected by the |
| /// backend, this field must be set to true to preserve the header. |
| core.bool disableAuth; |
| |
| /// The JWT audience is used when generating a JWT ID token for the backend. |
| /// |
| /// This ID token will be added in the HTTP "authorization" header, and sent |
| /// to the backend. |
| core.String jwtAudience; |
| |
| /// Minimum deadline in seconds needed for this method. |
| /// |
| /// Calls having deadline value lower than this will be rejected. |
| core.double minDeadline; |
| |
| /// The number of seconds to wait for the completion of a long running |
| /// operation. |
| /// |
| /// The default is no deadline. |
| core.double operationDeadline; |
| |
| /// |
| /// Possible string values are: |
| /// - "PATH_TRANSLATION_UNSPECIFIED" |
| /// - "CONSTANT_ADDRESS" : Use the backend address as-is, with no modification |
| /// to the path. If the URL pattern contains variables, the variable names and |
| /// values will be appended to the query string. If a query string parameter |
| /// and a URL pattern variable have the same name, this may result in |
| /// duplicate keys in the query string. # Examples Given the following |
| /// operation config: Method path: /api/company/{cid}/user/{uid} Backend |
| /// address: https://example.cloudfunctions.net/getUser Requests to the |
| /// following request paths will call the backend at the translated path: |
| /// Request path: /api/company/widgetworks/user/johndoe Translated: |
| /// https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe |
| /// Request path: /api/company/widgetworks/user/johndoe?timezone=EST |
| /// Translated: |
| /// https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
| /// - "APPEND_PATH_TO_ADDRESS" : The request path will be appended to the |
| /// backend address. # Examples Given the following operation config: Method |
| /// path: /api/company/{cid}/user/{uid} Backend address: |
| /// https://example.appspot.com Requests to the following request paths will |
| /// call the backend at the translated path: Request path: |
| /// /api/company/widgetworks/user/johndoe Translated: |
| /// https://example.appspot.com/api/company/widgetworks/user/johndoe Request |
| /// path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: |
| /// https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| core.String pathTranslation; |
| |
| /// The protocol used for sending a request to the backend. |
| /// |
| /// The supported values are "http/1.1" and "h2". The default value is |
| /// inferred from the scheme in the address field: SCHEME PROTOCOL http:// |
| /// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends |
| /// (https://) that support HTTP/2, set this field to "h2" for improved |
| /// performance. Configuring this field to non-default values is only |
| /// supported for secure HTTP backends. This field will be ignored for all |
| /// other backends. See |
| /// https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids |
| /// for more details on the supported values. |
| core.String protocol; |
| |
| /// Selects the methods to which this rule applies. |
| /// |
| /// Refer to selector for syntax details. |
| core.String selector; |
| |
| BackendRule(); |
| |
| BackendRule.fromJson(core.Map _json) { |
| if (_json.containsKey('address')) { |
| address = _json['address'] as core.String; |
| } |
| if (_json.containsKey('deadline')) { |
| deadline = (_json['deadline'] as core.num).toDouble(); |
| } |
| if (_json.containsKey('disableAuth')) { |
| disableAuth = _json['disableAuth'] as core.bool; |
| } |
| if (_json.containsKey('jwtAudience')) { |
| jwtAudience = _json['jwtAudience'] as core.String; |
| } |
| if (_json.containsKey('minDeadline')) { |
| minDeadline = (_json['minDeadline'] as core.num).toDouble(); |
| } |
| if (_json.containsKey('operationDeadline')) { |
| operationDeadline = (_json['operationDeadline'] as core.num).toDouble(); |
| } |
| if (_json.containsKey('pathTranslation')) { |
| pathTranslation = _json['pathTranslation'] as core.String; |
| } |
| if (_json.containsKey('protocol')) { |
| protocol = _json['protocol'] as core.String; |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (address != null) { |
| _json['address'] = address; |
| } |
| if (deadline != null) { |
| _json['deadline'] = deadline; |
| } |
| if (disableAuth != null) { |
| _json['disableAuth'] = disableAuth; |
| } |
| if (jwtAudience != null) { |
| _json['jwtAudience'] = jwtAudience; |
| } |
| if (minDeadline != null) { |
| _json['minDeadline'] = minDeadline; |
| } |
| if (operationDeadline != null) { |
| _json['operationDeadline'] = operationDeadline; |
| } |
| if (pathTranslation != null) { |
| _json['pathTranslation'] = pathTranslation; |
| } |
| if (protocol != null) { |
| _json['protocol'] = protocol; |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for BatchCreateAdminOverrides |
| class BatchCreateAdminOverridesResponse { |
| /// The overrides that were created. |
| core.List<QuotaOverride> overrides; |
| |
| BatchCreateAdminOverridesResponse(); |
| |
| BatchCreateAdminOverridesResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('overrides')) { |
| overrides = (_json['overrides'] as core.List) |
| .map<QuotaOverride>((value) => QuotaOverride.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (overrides != null) { |
| _json['overrides'] = overrides.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for BatchCreateConsumerOverrides |
| class BatchCreateConsumerOverridesResponse { |
| /// The overrides that were created. |
| core.List<QuotaOverride> overrides; |
| |
| BatchCreateConsumerOverridesResponse(); |
| |
| BatchCreateConsumerOverridesResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('overrides')) { |
| overrides = (_json['overrides'] as core.List) |
| .map<QuotaOverride>((value) => QuotaOverride.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (overrides != null) { |
| _json['overrides'] = overrides.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Request message for the `BatchEnableServices` method. |
| class BatchEnableServicesRequest { |
| /// The identifiers of the services to enable on the project. |
| /// |
| /// A valid identifier would be: serviceusage.googleapis.com Enabling services |
| /// requires that each service is public or is shared with the user enabling |
| /// the service. A single request can enable a maximum of 20 services at a |
| /// time. If more than 20 services are specified, the request will fail, and |
| /// no state changes will occur. |
| core.List<core.String> serviceIds; |
| |
| BatchEnableServicesRequest(); |
| |
| BatchEnableServicesRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('serviceIds')) { |
| serviceIds = (_json['serviceIds'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (serviceIds != null) { |
| _json['serviceIds'] = serviceIds; |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for the `BatchEnableServices` method. |
| /// |
| /// This response message is assigned to the `response` field of the returned |
| /// Operation when that operation is done. |
| class BatchEnableServicesResponse { |
| /// If allow_partial_success is true, and one or more services could not be |
| /// enabled, this field contains the details about each failure. |
| core.List<EnableFailure> failures; |
| |
| /// The new state of the services after enabling. |
| core.List<GoogleApiServiceusageV1Service> services; |
| |
| BatchEnableServicesResponse(); |
| |
| BatchEnableServicesResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('failures')) { |
| failures = (_json['failures'] as core.List) |
| .map<EnableFailure>((value) => EnableFailure.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('services')) { |
| services = (_json['services'] as core.List) |
| .map<GoogleApiServiceusageV1Service>((value) => |
| GoogleApiServiceusageV1Service.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (failures != null) { |
| _json['failures'] = failures.map((value) => value.toJson()).toList(); |
| } |
| if (services != null) { |
| _json['services'] = services.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for the `BatchGetServices` method. |
| class BatchGetServicesResponse { |
| /// The requested Service states. |
| core.List<GoogleApiServiceusageV1Service> services; |
| |
| BatchGetServicesResponse(); |
| |
| BatchGetServicesResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('services')) { |
| services = (_json['services'] as core.List) |
| .map<GoogleApiServiceusageV1Service>((value) => |
| GoogleApiServiceusageV1Service.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (services != null) { |
| _json['services'] = services.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Billing related configuration of the service. |
| /// |
| /// The following example shows how to configure monitored resources and metrics |
| /// for billing, `consumer_destinations` is the only supported destination and |
| /// the monitored resources need at least one label key |
| /// `cloud.googleapis.com/location` to indicate the location of the billing |
| /// usage, using different monitored resources between monitoring and billing is |
| /// recommended so they can be evolved independently: monitored_resources: - |
| /// type: library.googleapis.com/billing_branch labels: - key: |
| /// cloud.googleapis.com/location description: | Predefined label to support |
| /// billing location restriction. - key: city description: | Custom label to |
| /// define the city where the library branch is located in. - key: name |
| /// description: Custom label to define the name of the library branch. metrics: |
| /// - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA |
| /// value_type: INT64 unit: "1" billing: consumer_destinations: - |
| /// monitored_resource: library.googleapis.com/billing_branch metrics: - |
| /// library.googleapis.com/book/borrowed_count |
| class Billing { |
| /// Billing configurations for sending metrics to the consumer project. |
| /// |
| /// There can be multiple consumer destinations per service, each one must |
| /// have a different monitored resource type. A metric can be used in at most |
| /// one consumer destination. |
| core.List<BillingDestination> consumerDestinations; |
| |
| Billing(); |
| |
| Billing.fromJson(core.Map _json) { |
| if (_json.containsKey('consumerDestinations')) { |
| consumerDestinations = (_json['consumerDestinations'] as core.List) |
| .map<BillingDestination>((value) => BillingDestination.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (consumerDestinations != null) { |
| _json['consumerDestinations'] = |
| consumerDestinations.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Configuration of a specific billing destination (Currently only support bill |
| /// against consumer project). |
| class BillingDestination { |
| /// Names of the metrics to report to this billing 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. |
| core.String monitoredResource; |
| |
| BillingDestination(); |
| |
| BillingDestination.fromJson(core.Map _json) { |
| if (_json.containsKey('metrics')) { |
| metrics = (_json['metrics'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('monitoredResource')) { |
| monitoredResource = _json['monitoredResource'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (metrics != null) { |
| _json['metrics'] = metrics; |
| } |
| if (monitoredResource != null) { |
| _json['monitoredResource'] = monitoredResource; |
| } |
| return _json; |
| } |
| } |
| |
| /// The request message for Operations.CancelOperation. |
| class CancelOperationRequest { |
| CancelOperationRequest(); |
| |
| CancelOperationRequest.fromJson( |
| // ignore: avoid_unused_constructor_parameters |
| core.Map _json); |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| return _json; |
| } |
| } |
| |
| /// `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`. This |
| /// also provides mechanism to allowlist any protobuf message extension that can |
| /// be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” |
| /// format. For example, list any service specific protobuf types that can |
| /// appear in grpc metadata as follows in your yaml file: Example: context: |
| /// rules: - selector: "google.example.library.v1.LibraryService.CreateBook" |
| /// allowed_request_extensions: - google.foo.v1.NewExtension |
| /// allowed_response_extensions: - google.foo.v1.NewExtension You can also |
| /// specify extension ID instead of fully qualified extension name here. |
| class Context { |
| /// 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'] as core.List) |
| .map<ContextRule>((value) => ContextRule.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (rules != null) { |
| _json['rules'] = rules.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// A context rule provides information about the context for an individual API |
| /// element. |
| class ContextRule { |
| /// A list of full type names or extension IDs of extensions allowed in grpc |
| /// side channel from client to backend. |
| core.List<core.String> allowedRequestExtensions; |
| |
| /// A list of full type names or extension IDs of extensions allowed in grpc |
| /// side channel from backend to client. |
| core.List<core.String> allowedResponseExtensions; |
| |
| /// A list of full type names of provided contexts. |
| core.List<core.String> provided; |
| |
| /// 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. |
| core.String selector; |
| |
| ContextRule(); |
| |
| ContextRule.fromJson(core.Map _json) { |
| if (_json.containsKey('allowedRequestExtensions')) { |
| allowedRequestExtensions = |
| (_json['allowedRequestExtensions'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('allowedResponseExtensions')) { |
| allowedResponseExtensions = |
| (_json['allowedResponseExtensions'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('provided')) { |
| provided = (_json['provided'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('requested')) { |
| requested = (_json['requested'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (allowedRequestExtensions != null) { |
| _json['allowedRequestExtensions'] = allowedRequestExtensions; |
| } |
| if (allowedResponseExtensions != null) { |
| _json['allowedResponseExtensions'] = allowedResponseExtensions; |
| } |
| if (provided != null) { |
| _json['provided'] = provided; |
| } |
| if (requested != null) { |
| _json['requested'] = requested; |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.String environment; |
| |
| Control(); |
| |
| Control.fromJson(core.Map _json) { |
| if (_json.containsKey('environment')) { |
| environment = _json['environment'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (environment != null) { |
| _json['environment'] = environment; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.List<CustomErrorRule> rules; |
| |
| /// 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'] as core.List) |
| .map<CustomErrorRule>((value) => CustomErrorRule.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('types')) { |
| types = (_json['types'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (rules != null) { |
| _json['rules'] = rules.map((value) => value.toJson()).toList(); |
| } |
| if (types != null) { |
| _json['types'] = types; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.bool isErrorType; |
| |
| /// Selects messages to which this rule applies. |
| /// |
| /// Refer to selector for syntax details. |
| core.String selector; |
| |
| CustomErrorRule(); |
| |
| CustomErrorRule.fromJson(core.Map _json) { |
| if (_json.containsKey('isErrorType')) { |
| isErrorType = _json['isErrorType'] as core.bool; |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (isErrorType != null) { |
| _json['isErrorType'] = isErrorType; |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| return _json; |
| } |
| } |
| |
| /// A custom pattern is used for defining custom HTTP verb. |
| class CustomHttpPattern { |
| /// The name of this custom HTTP verb. |
| core.String kind; |
| |
| /// The path matched by this custom verb. |
| core.String path; |
| |
| CustomHttpPattern(); |
| |
| CustomHttpPattern.fromJson(core.Map _json) { |
| if (_json.containsKey('kind')) { |
| kind = _json['kind'] as core.String; |
| } |
| if (_json.containsKey('path')) { |
| path = _json['path'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (kind != null) { |
| _json['kind'] = kind; |
| } |
| if (path != null) { |
| _json['path'] = path; |
| } |
| return _json; |
| } |
| } |
| |
| /// Request message for the `DisableService` method. |
| class DisableServiceRequest { |
| /// Defines the behavior for checking service usage when disabling a service. |
| /// Possible string values are: |
| /// - "CHECK_IF_SERVICE_HAS_USAGE_UNSPECIFIED" : When unset, the default |
| /// behavior is used, which is SKIP. |
| /// - "SKIP" : If set, skip checking service usage when disabling a service. |
| /// - "CHECK" : If set, service usage is checked when disabling the service. |
| /// If a service, or its dependents, has usage in the last 30 days, the |
| /// request returns a FAILED_PRECONDITION error. |
| core.String checkIfServiceHasUsage; |
| |
| /// Indicates if services that are enabled and which depend on this service |
| /// should also be disabled. |
| /// |
| /// If not set, an error will be generated if any enabled services depend on |
| /// the service to be disabled. When set, the service, and any enabled |
| /// services that depend on it, will be disabled together. |
| core.bool disableDependentServices; |
| |
| DisableServiceRequest(); |
| |
| DisableServiceRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('checkIfServiceHasUsage')) { |
| checkIfServiceHasUsage = _json['checkIfServiceHasUsage'] as core.String; |
| } |
| if (_json.containsKey('disableDependentServices')) { |
| disableDependentServices = _json['disableDependentServices'] as core.bool; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (checkIfServiceHasUsage != null) { |
| _json['checkIfServiceHasUsage'] = checkIfServiceHasUsage; |
| } |
| if (disableDependentServices != null) { |
| _json['disableDependentServices'] = disableDependentServices; |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for the `DisableService` method. |
| /// |
| /// This response message is assigned to the `response` field of the returned |
| /// Operation when that operation is done. |
| class DisableServiceResponse { |
| /// The new state of the service after disabling. |
| GoogleApiServiceusageV1Service service; |
| |
| DisableServiceResponse(); |
| |
| DisableServiceResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('service')) { |
| service = GoogleApiServiceusageV1Service.fromJson( |
| _json['service'] as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (service != null) { |
| _json['service'] = service.toJson(); |
| } |
| return _json; |
| } |
| } |
| |
| /// `Documentation` provides the information for describing a service. |
| /// |
| /// Example: documentation: summary: > The Google Calendar API gives access to |
| /// most calendar features. pages: - name: Overview content: (== include |
| /// google/foo/overview.md ==) - name: Tutorial content: (== include |
| /// google/foo/tutorial.md ==) subpages; - name: Java content: (== include |
| /// google/foo/tutorial_java.md ==) rules: - selector: |
| /// google.calendar.Calendar.Get description: > ... - selector: |
| /// google.calendar.Calendar.Put description: > ... 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: \[fully.qualified.proto.name\]\[\] To override the |
| /// display text used for the link, this can be used: \[display |
| /// text\]\[fully.qualified.proto.name\] Text can be excluded from doc using the |
| /// following notation: (-- internal comment --) 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: (== include path/to/file ==) 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: (== resource_for v1.shelves.books ==) 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. |
| core.String documentationRootUrl; |
| |
| /// Declares a single overview page. |
| /// |
| /// For example: documentation: summary: ... overview: (== include overview.md |
| /// ==) This is a shortcut for the following declaration (using pages style): |
| /// documentation: summary: ... pages: - name: Overview content: (== include |
| /// overview.md ==) Note: you cannot specify both `overview` field and `pages` |
| /// field. |
| core.String overview; |
| |
| /// 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. |
| core.List<DocumentationRule> rules; |
| |
| /// Specifies the service root url if the default one (the service name from |
| /// the yaml file) is not suitable. |
| /// |
| /// This can be seen in any fully specified service urls as well as sections |
| /// that show a base that other urls are relative to. |
| core.String serviceRootUrl; |
| |
| /// A short summary of what the service does. |
| /// |
| /// Can only be provided by plain text. |
| core.String summary; |
| |
| Documentation(); |
| |
| Documentation.fromJson(core.Map _json) { |
| if (_json.containsKey('documentationRootUrl')) { |
| documentationRootUrl = _json['documentationRootUrl'] as core.String; |
| } |
| if (_json.containsKey('overview')) { |
| overview = _json['overview'] as core.String; |
| } |
| if (_json.containsKey('pages')) { |
| pages = (_json['pages'] as core.List) |
| .map<Page>((value) => |
| Page.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('rules')) { |
| rules = (_json['rules'] as core.List) |
| .map<DocumentationRule>((value) => DocumentationRule.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('serviceRootUrl')) { |
| serviceRootUrl = _json['serviceRootUrl'] as core.String; |
| } |
| if (_json.containsKey('summary')) { |
| summary = _json['summary'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (documentationRootUrl != null) { |
| _json['documentationRootUrl'] = documentationRootUrl; |
| } |
| if (overview != null) { |
| _json['overview'] = overview; |
| } |
| if (pages != null) { |
| _json['pages'] = pages.map((value) => value.toJson()).toList(); |
| } |
| if (rules != null) { |
| _json['rules'] = rules.map((value) => value.toJson()).toList(); |
| } |
| if (serviceRootUrl != null) { |
| _json['serviceRootUrl'] = serviceRootUrl; |
| } |
| if (summary != null) { |
| _json['summary'] = summary; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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`. |
| core.String deprecationDescription; |
| |
| /// 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". A wildcard will match one or more components. To |
| /// specify a default for all applicable elements, the whole pattern "*" is |
| /// used. |
| core.String selector; |
| |
| DocumentationRule(); |
| |
| DocumentationRule.fromJson(core.Map _json) { |
| if (_json.containsKey('deprecationDescription')) { |
| deprecationDescription = _json['deprecationDescription'] as core.String; |
| } |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (deprecationDescription != null) { |
| _json['deprecationDescription'] = deprecationDescription; |
| } |
| if (description != null) { |
| _json['description'] = description; |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| return _json; |
| } |
| } |
| |
| /// A generic empty message that you can re-use to avoid defining duplicated |
| /// empty messages in your APIs. |
| /// |
| /// A typical example is to use it as the request or the response type of an API |
| /// method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns |
| /// (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON |
| /// object `{}`. |
| class Empty { |
| Empty(); |
| |
| Empty.fromJson( |
| // ignore: avoid_unused_constructor_parameters |
| core.Map _json); |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| return _json; |
| } |
| } |
| |
| /// Provides error messages for the failing services. |
| class EnableFailure { |
| /// An error message describing why the service could not be enabled. |
| core.String errorMessage; |
| |
| /// The service id of a service that could not be enabled. |
| core.String serviceId; |
| |
| EnableFailure(); |
| |
| EnableFailure.fromJson(core.Map _json) { |
| if (_json.containsKey('errorMessage')) { |
| errorMessage = _json['errorMessage'] as core.String; |
| } |
| if (_json.containsKey('serviceId')) { |
| serviceId = _json['serviceId'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (errorMessage != null) { |
| _json['errorMessage'] = errorMessage; |
| } |
| if (serviceId != null) { |
| _json['serviceId'] = serviceId; |
| } |
| return _json; |
| } |
| } |
| |
| /// Request message for the `EnableService` method. |
| class EnableServiceRequest { |
| EnableServiceRequest(); |
| |
| EnableServiceRequest.fromJson( |
| // ignore: avoid_unused_constructor_parameters |
| core.Map _json); |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| return _json; |
| } |
| } |
| |
| /// Response message for the `EnableService` method. |
| /// |
| /// This response message is assigned to the `response` field of the returned |
| /// Operation when that operation is done. |
| class EnableServiceResponse { |
| /// The new state of the service after enabling. |
| GoogleApiServiceusageV1Service service; |
| |
| EnableServiceResponse(); |
| |
| EnableServiceResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('service')) { |
| service = GoogleApiServiceusageV1Service.fromJson( |
| _json['service'] as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (service != null) { |
| _json['service'] = service.toJson(); |
| } |
| return _json; |
| } |
| } |
| |
| /// `Endpoint` describes a network endpoint of a service that serves a set of |
| /// APIs. |
| /// |
| /// It is commonly known as a service endpoint. A service may expose any number |
| /// of service endpoints, and all service endpoints share the same service |
| /// definition, such as quota limits and monitoring metrics. 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 intended aliases. 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. |
| core.bool allowCors; |
| |
| /// 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". |
| core.String target; |
| |
| Endpoint(); |
| |
| Endpoint.fromJson(core.Map _json) { |
| if (_json.containsKey('aliases')) { |
| aliases = (_json['aliases'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('allowCors')) { |
| allowCors = _json['allowCors'] as core.bool; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('target')) { |
| target = _json['target'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (aliases != null) { |
| _json['aliases'] = aliases; |
| } |
| if (allowCors != null) { |
| _json['allowCors'] = allowCors; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (target != null) { |
| _json['target'] = target; |
| } |
| return _json; |
| } |
| } |
| |
| /// Enum type definition. |
| class Enum { |
| /// Enum value definitions. |
| core.List<EnumValue> enumvalue; |
| |
| /// Enum type name. |
| core.String name; |
| |
| /// Protocol buffer options. |
| core.List<Option> options; |
| |
| /// The source context. |
| SourceContext sourceContext; |
| |
| /// 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'] as core.List) |
| .map<EnumValue>((value) => |
| EnumValue.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('options')) { |
| options = (_json['options'] as core.List) |
| .map<Option>((value) => |
| Option.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('sourceContext')) { |
| sourceContext = SourceContext.fromJson( |
| _json['sourceContext'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('syntax')) { |
| syntax = _json['syntax'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (enumvalue != null) { |
| _json['enumvalue'] = enumvalue.map((value) => value.toJson()).toList(); |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (options != null) { |
| _json['options'] = options.map((value) => value.toJson()).toList(); |
| } |
| if (sourceContext != null) { |
| _json['sourceContext'] = sourceContext.toJson(); |
| } |
| if (syntax != null) { |
| _json['syntax'] = syntax; |
| } |
| return _json; |
| } |
| } |
| |
| /// Enum value definition. |
| class EnumValue { |
| /// Enum value name. |
| core.String name; |
| |
| /// Enum value number. |
| core.int number; |
| |
| /// Protocol buffer options. |
| core.List<Option> options; |
| |
| EnumValue(); |
| |
| EnumValue.fromJson(core.Map _json) { |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('number')) { |
| number = _json['number'] as core.int; |
| } |
| if (_json.containsKey('options')) { |
| options = (_json['options'] as core.List) |
| .map<Option>((value) => |
| Option.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (number != null) { |
| _json['number'] = number; |
| } |
| if (options != null) { |
| _json['options'] = options.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.String cardinality; |
| |
| /// The string value of the default value of this field. |
| /// |
| /// Proto2 syntax only. |
| core.String defaultValue; |
| |
| /// 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. |
| core.String kind; |
| |
| /// The field name. |
| core.String name; |
| |
| /// 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. |
| core.int oneofIndex; |
| |
| /// The protocol buffer options. |
| core.List<Option> options; |
| |
| /// 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"`. |
| core.String typeUrl; |
| |
| Field(); |
| |
| Field.fromJson(core.Map _json) { |
| if (_json.containsKey('cardinality')) { |
| cardinality = _json['cardinality'] as core.String; |
| } |
| if (_json.containsKey('defaultValue')) { |
| defaultValue = _json['defaultValue'] as core.String; |
| } |
| if (_json.containsKey('jsonName')) { |
| jsonName = _json['jsonName'] as core.String; |
| } |
| if (_json.containsKey('kind')) { |
| kind = _json['kind'] as core.String; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('number')) { |
| number = _json['number'] as core.int; |
| } |
| if (_json.containsKey('oneofIndex')) { |
| oneofIndex = _json['oneofIndex'] as core.int; |
| } |
| if (_json.containsKey('options')) { |
| options = (_json['options'] as core.List) |
| .map<Option>((value) => |
| Option.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('packed')) { |
| packed = _json['packed'] as core.bool; |
| } |
| if (_json.containsKey('typeUrl')) { |
| typeUrl = _json['typeUrl'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (cardinality != null) { |
| _json['cardinality'] = cardinality; |
| } |
| if (defaultValue != null) { |
| _json['defaultValue'] = defaultValue; |
| } |
| if (jsonName != null) { |
| _json['jsonName'] = jsonName; |
| } |
| if (kind != null) { |
| _json['kind'] = kind; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (number != null) { |
| _json['number'] = number; |
| } |
| if (oneofIndex != null) { |
| _json['oneofIndex'] = oneofIndex; |
| } |
| if (options != null) { |
| _json['options'] = options.map((value) => value.toJson()).toList(); |
| } |
| if (packed != null) { |
| _json['packed'] = packed; |
| } |
| if (typeUrl != null) { |
| _json['typeUrl'] = typeUrl; |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for getting service identity. |
| class GetServiceIdentityResponse { |
| /// Service identity that service producer can use to access consumer |
| /// resources. |
| /// |
| /// If exists is true, it contains email and unique_id. If exists is false, it |
| /// contains pre-constructed email and empty unique_id. |
| ServiceIdentity identity; |
| |
| /// Service identity state. |
| /// Possible string values are: |
| /// - "IDENTITY_STATE_UNSPECIFIED" : Default service identity state. This |
| /// value is used if the state is omitted. |
| /// - "ACTIVE" : Service identity has been created and can be used. |
| core.String state; |
| |
| GetServiceIdentityResponse(); |
| |
| GetServiceIdentityResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('identity')) { |
| identity = ServiceIdentity.fromJson( |
| _json['identity'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('state')) { |
| state = _json['state'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (identity != null) { |
| _json['identity'] = identity.toJson(); |
| } |
| if (state != null) { |
| _json['state'] = state; |
| } |
| 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 |
| class GoogleApiService { |
| /// 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. |
| Authentication authentication; |
| |
| /// API backend configuration. |
| Backend backend; |
| |
| /// Billing configuration. |
| Billing billing; |
| |
| /// The service config compiler always sets this field to `3`. |
| /// |
| /// Deprecated. |
| core.int configVersion; |
| |
| /// Context configuration. |
| Context context; |
| |
| /// Configuration for the service control plane. |
| Control control; |
| |
| /// Custom error configuration. |
| CustomError customError; |
| |
| /// 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. |
| 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 |
| core.List<Enum> enums; |
| |
| /// HTTP configuration. |
| Http http; |
| |
| /// A unique ID for a specific instance of this message, typically assigned by |
| /// the client for tracking purpose. |
| /// |
| /// Must be no longer than 63 characters and only lower case letters, digits, |
| /// '.', '_' and '-' are allowed. If empty, the server may choose to generate |
| /// one instead. |
| core.String id; |
| |
| /// Logging configuration. |
| Logging logging; |
| |
| /// Defines the logs used by this service. |
| core.List<LogDescriptor> logs; |
| |
| /// 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. |
| core.List<MonitoredResourceDescriptor> monitoredResources; |
| |
| /// Monitoring configuration. |
| Monitoring monitoring; |
| |
| /// The service name, which is a DNS-like logical identifier for the service, |
| /// such as `calendar.googleapis.com`. |
| /// |
| /// The service name typically goes through DNS verification to make sure the |
| /// owner of the service also owns the DNS name. |
| core.String name; |
| |
| /// The Google project that owns this service. |
| core.String producerProjectId; |
| |
| /// Quota configuration. |
| Quota quota; |
| |
| /// The source information for this configuration if available. |
| /// |
| /// Output only. |
| SourceInfo sourceInfo; |
| |
| /// 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. |
| core.List<Type> systemTypes; |
| |
| /// 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 |
| core.List<Type> types; |
| |
| /// Configuration controlling usage of this service. |
| Usage usage; |
| |
| GoogleApiService(); |
| |
| GoogleApiService.fromJson(core.Map _json) { |
| if (_json.containsKey('apis')) { |
| apis = (_json['apis'] as core.List) |
| .map<Api>((value) => |
| Api.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('authentication')) { |
| authentication = Authentication.fromJson( |
| _json['authentication'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('backend')) { |
| backend = Backend.fromJson( |
| _json['backend'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('billing')) { |
| billing = Billing.fromJson( |
| _json['billing'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('configVersion')) { |
| configVersion = _json['configVersion'] as core.int; |
| } |
| if (_json.containsKey('context')) { |
| context = Context.fromJson( |
| _json['context'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('control')) { |
| control = Control.fromJson( |
| _json['control'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('customError')) { |
| customError = CustomError.fromJson( |
| _json['customError'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('documentation')) { |
| documentation = Documentation.fromJson( |
| _json['documentation'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('endpoints')) { |
| endpoints = (_json['endpoints'] as core.List) |
| .map<Endpoint>((value) => |
| Endpoint.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('enums')) { |
| enums = (_json['enums'] as core.List) |
| .map<Enum>((value) => |
| Enum.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('http')) { |
| http = |
| Http.fromJson(_json['http'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('id')) { |
| id = _json['id'] as core.String; |
| } |
| if (_json.containsKey('logging')) { |
| logging = Logging.fromJson( |
| _json['logging'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('logs')) { |
| logs = (_json['logs'] as core.List) |
| .map<LogDescriptor>((value) => LogDescriptor.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('metrics')) { |
| metrics = (_json['metrics'] as core.List) |
| .map<MetricDescriptor>((value) => MetricDescriptor.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('monitoredResources')) { |
| monitoredResources = (_json['monitoredResources'] as core.List) |
| .map<MonitoredResourceDescriptor>((value) => |
| MonitoredResourceDescriptor.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('monitoring')) { |
| monitoring = Monitoring.fromJson( |
| _json['monitoring'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('producerProjectId')) { |
| producerProjectId = _json['producerProjectId'] as core.String; |
| } |
| if (_json.containsKey('quota')) { |
| quota = |
| Quota.fromJson(_json['quota'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('sourceInfo')) { |
| sourceInfo = SourceInfo.fromJson( |
| _json['sourceInfo'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('systemParameters')) { |
| systemParameters = SystemParameters.fromJson( |
| _json['systemParameters'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('systemTypes')) { |
| systemTypes = (_json['systemTypes'] as core.List) |
| .map<Type>((value) => |
| Type.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('title')) { |
| title = _json['title'] as core.String; |
| } |
| if (_json.containsKey('types')) { |
| types = (_json['types'] as core.List) |
| .map<Type>((value) => |
| Type.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('usage')) { |
| usage = |
| Usage.fromJson(_json['usage'] as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (apis != null) { |
| _json['apis'] = apis.map((value) => value.toJson()).toList(); |
| } |
| if (authentication != null) { |
| _json['authentication'] = authentication.toJson(); |
| } |
| if (backend != null) { |
| _json['backend'] = backend.toJson(); |
| } |
| if (billing != null) { |
| _json['billing'] = billing.toJson(); |
| } |
| if (configVersion != null) { |
| _json['configVersion'] = configVersion; |
| } |
| if (context != null) { |
| _json['context'] = context.toJson(); |
| } |
| if (control != null) { |
| _json['control'] = control.toJson(); |
| } |
| if (customError != null) { |
| _json['customError'] = customError.toJson(); |
| } |
| if (documentation != null) { |
| _json['documentation'] = documentation.toJson(); |
| } |
| if (endpoints != null) { |
| _json['endpoints'] = endpoints.map((value) => value.toJson()).toList(); |
| } |
| if (enums != null) { |
| _json['enums'] = enums.map((value) => value.toJson()).toList(); |
| } |
| if (http != null) { |
| _json['http'] = http.toJson(); |
| } |
| if (id != null) { |
| _json['id'] = id; |
| } |
| if (logging != null) { |
| _json['logging'] = logging.toJson(); |
| } |
| if (logs != null) { |
| _json['logs'] = logs.map((value) => value.toJson()).toList(); |
| } |
| if (metrics != null) { |
| _json['metrics'] = metrics.map((value) => value.toJson()).toList(); |
| } |
| if (monitoredResources != null) { |
| _json['monitoredResources'] = |
| monitoredResources.map((value) => value.toJson()).toList(); |
| } |
| if (monitoring != null) { |
| _json['monitoring'] = monitoring.toJson(); |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (producerProjectId != null) { |
| _json['producerProjectId'] = producerProjectId; |
| } |
| if (quota != null) { |
| _json['quota'] = quota.toJson(); |
| } |
| if (sourceInfo != null) { |
| _json['sourceInfo'] = sourceInfo.toJson(); |
| } |
| if (systemParameters != null) { |
| _json['systemParameters'] = systemParameters.toJson(); |
| } |
| if (systemTypes != null) { |
| _json['systemTypes'] = |
| systemTypes.map((value) => value.toJson()).toList(); |
| } |
| if (title != null) { |
| _json['title'] = title; |
| } |
| if (types != null) { |
| _json['types'] = types.map((value) => value.toJson()).toList(); |
| } |
| if (usage != null) { |
| _json['usage'] = usage.toJson(); |
| } |
| return _json; |
| } |
| } |
| |
| /// The operation metadata returned for the batchend services operation. |
| class GoogleApiServiceusageV1OperationMetadata { |
| /// The full name of the resources that this operation is directly associated |
| /// with. |
| core.List<core.String> resourceNames; |
| |
| GoogleApiServiceusageV1OperationMetadata(); |
| |
| GoogleApiServiceusageV1OperationMetadata.fromJson(core.Map _json) { |
| if (_json.containsKey('resourceNames')) { |
| resourceNames = (_json['resourceNames'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (resourceNames != null) { |
| _json['resourceNames'] = resourceNames; |
| } |
| return _json; |
| } |
| } |
| |
| /// A service that is available for use by the consumer. |
| class GoogleApiServiceusageV1Service { |
| /// The service configuration of the available service. |
| /// |
| /// Some fields may be filtered out of the configuration in responses to the |
| /// `ListServices` method. These fields are present only in responses to the |
| /// `GetService` method. |
| GoogleApiServiceusageV1ServiceConfig config; |
| |
| /// The resource name of the consumer and service. |
| /// |
| /// A valid name would be: - projects/123/services/serviceusage.googleapis.com |
| core.String name; |
| |
| /// The resource name of the consumer. |
| /// |
| /// A valid name would be: - projects/123 |
| core.String parent; |
| |
| /// Whether or not the service has been enabled for use by the consumer. |
| /// Possible string values are: |
| /// - "STATE_UNSPECIFIED" : The default value, which indicates that the |
| /// enabled state of the service is unspecified or not meaningful. Currently, |
| /// all consumers other than projects (such as folders and organizations) are |
| /// always in this state. |
| /// - "DISABLED" : The service cannot be used by this consumer. It has either |
| /// been explicitly disabled, or has never been enabled. |
| /// - "ENABLED" : The service has been explicitly enabled for use by this |
| /// consumer. |
| core.String state; |
| |
| GoogleApiServiceusageV1Service(); |
| |
| GoogleApiServiceusageV1Service.fromJson(core.Map _json) { |
| if (_json.containsKey('config')) { |
| config = GoogleApiServiceusageV1ServiceConfig.fromJson( |
| _json['config'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('parent')) { |
| parent = _json['parent'] as core.String; |
| } |
| if (_json.containsKey('state')) { |
| state = _json['state'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (config != null) { |
| _json['config'] = config.toJson(); |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (parent != null) { |
| _json['parent'] = parent; |
| } |
| if (state != null) { |
| _json['state'] = state; |
| } |
| return _json; |
| } |
| } |
| |
| /// The configuration of the service. |
| class GoogleApiServiceusageV1ServiceConfig { |
| /// A list of API interfaces exported by this service. |
| /// |
| /// Contains only the names, versions, and method names of the interfaces. |
| core.List<Api> apis; |
| |
| /// Auth configuration. |
| /// |
| /// Contains only the OAuth rules. |
| Authentication authentication; |
| |
| /// Additional API documentation. |
| /// |
| /// Contains only the summary and the documentation URL. |
| Documentation documentation; |
| |
| /// Configuration for network endpoints. |
| /// |
| /// Contains only the names and aliases of the endpoints. |
| core.List<Endpoint> endpoints; |
| |
| /// 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. |
| /// |
| /// This should not include the 'producer_destinations' field. |
| Monitoring monitoring; |
| |
| /// The DNS address at which this service is available. |
| /// |
| /// An example DNS address would be: `calendar.googleapis.com`. |
| core.String name; |
| |
| /// Quota configuration. |
| Quota quota; |
| |
| /// The product title for this service. |
| core.String title; |
| |
| /// Configuration controlling usage of this service. |
| Usage usage; |
| |
| GoogleApiServiceusageV1ServiceConfig(); |
| |
| GoogleApiServiceusageV1ServiceConfig.fromJson(core.Map _json) { |
| if (_json.containsKey('apis')) { |
| apis = (_json['apis'] as core.List) |
| .map<Api>((value) => |
| Api.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('authentication')) { |
| authentication = Authentication.fromJson( |
| _json['authentication'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('documentation')) { |
| documentation = Documentation.fromJson( |
| _json['documentation'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('endpoints')) { |
| endpoints = (_json['endpoints'] as core.List) |
| .map<Endpoint>((value) => |
| Endpoint.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('monitoredResources')) { |
| monitoredResources = (_json['monitoredResources'] as core.List) |
| .map<MonitoredResourceDescriptor>((value) => |
| MonitoredResourceDescriptor.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('monitoring')) { |
| monitoring = Monitoring.fromJson( |
| _json['monitoring'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('quota')) { |
| quota = |
| Quota.fromJson(_json['quota'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('title')) { |
| title = _json['title'] as core.String; |
| } |
| if (_json.containsKey('usage')) { |
| usage = |
| Usage.fromJson(_json['usage'] as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (apis != null) { |
| _json['apis'] = apis.map((value) => value.toJson()).toList(); |
| } |
| if (authentication != null) { |
| _json['authentication'] = authentication.toJson(); |
| } |
| if (documentation != null) { |
| _json['documentation'] = documentation.toJson(); |
| } |
| if (endpoints != null) { |
| _json['endpoints'] = endpoints.map((value) => value.toJson()).toList(); |
| } |
| if (monitoredResources != null) { |
| _json['monitoredResources'] = |
| monitoredResources.map((value) => value.toJson()).toList(); |
| } |
| if (monitoring != null) { |
| _json['monitoring'] = monitoring.toJson(); |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (quota != null) { |
| _json['quota'] = quota.toJson(); |
| } |
| if (title != null) { |
| _json['title'] = title; |
| } |
| if (usage != null) { |
| _json['usage'] = usage.toJson(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for getting service identity. |
| class GoogleApiServiceusageV1beta1GetServiceIdentityResponse { |
| /// Service identity that service producer can use to access consumer |
| /// resources. |
| /// |
| /// If exists is true, it contains email and unique_id. If exists is false, it |
| /// contains pre-constructed email and empty unique_id. |
| GoogleApiServiceusageV1beta1ServiceIdentity identity; |
| |
| /// Service identity state. |
| /// Possible string values are: |
| /// - "IDENTITY_STATE_UNSPECIFIED" : Default service identity state. This |
| /// value is used if the state is omitted. |
| /// - "ACTIVE" : Service identity has been created and can be used. |
| core.String state; |
| |
| GoogleApiServiceusageV1beta1GetServiceIdentityResponse(); |
| |
| GoogleApiServiceusageV1beta1GetServiceIdentityResponse.fromJson( |
| core.Map _json) { |
| if (_json.containsKey('identity')) { |
| identity = GoogleApiServiceusageV1beta1ServiceIdentity.fromJson( |
| _json['identity'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('state')) { |
| state = _json['state'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (identity != null) { |
| _json['identity'] = identity.toJson(); |
| } |
| if (state != null) { |
| _json['state'] = state; |
| } |
| return _json; |
| } |
| } |
| |
| /// Service identity for a service. |
| /// |
| /// This is the identity that service producer should use to access consumer |
| /// resources. |
| class GoogleApiServiceusageV1beta1ServiceIdentity { |
| /// The email address of the service account that a service producer would use |
| /// to access consumer resources. |
| core.String email; |
| |
| /// The unique and stable id of the service account. |
| /// |
| /// https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount |
| core.String uniqueId; |
| |
| GoogleApiServiceusageV1beta1ServiceIdentity(); |
| |
| GoogleApiServiceusageV1beta1ServiceIdentity.fromJson(core.Map _json) { |
| if (_json.containsKey('email')) { |
| email = _json['email'] as core.String; |
| } |
| if (_json.containsKey('uniqueId')) { |
| uniqueId = _json['uniqueId'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (email != null) { |
| _json['email'] = email; |
| } |
| if (uniqueId != null) { |
| _json['uniqueId'] = uniqueId; |
| } |
| 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. |
| class Http { |
| /// When set to true, URL path parameters 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. |
| core.List<HttpRule> rules; |
| |
| Http(); |
| |
| Http.fromJson(core.Map _json) { |
| if (_json.containsKey('fullyDecodeReservedExpansion')) { |
| fullyDecodeReservedExpansion = |
| _json['fullyDecodeReservedExpansion'] as core.bool; |
| } |
| if (_json.containsKey('rules')) { |
| rules = (_json['rules'] as core.List) |
| .map<HttpRule>((value) => |
| HttpRule.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (fullyDecodeReservedExpansion != null) { |
| _json['fullyDecodeReservedExpansion'] = fullyDecodeReservedExpansion; |
| } |
| if (rules != null) { |
| _json['rules'] = rules.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC |
| /// method and one or more HTTP REST endpoints. |
| /// |
| /// It allows developers to build a single API service that supports both gRPC |
| /// APIs and REST APIs. Many systems, including |
| /// [Google APIs](https://github.com/googleapis/googleapis), |
| /// [Cloud Endpoints](https://cloud.google.com/endpoints), |
| /// [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and |
| /// [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and |
| /// use it for large scale production services. `HttpRule` defines the schema of |
| /// the gRPC/REST mapping. The mapping specifies how different portions of the |
| /// gRPC request message are mapped to the URL path, URL query parameters, and |
| /// HTTP request body. It also controls how the gRPC response message is mapped |
| /// to the HTTP response body. `HttpRule` is typically specified as an |
| /// `google.api.http` annotation on the gRPC method. Each mapping specifies a |
| /// URL path template and an HTTP method. The path template may refer to one or |
| /// more fields in the gRPC request message, as long as each field is a |
| /// non-repeated field with a primitive (non-message) type. The path template |
| /// controls how fields of the request message are mapped to the URL path. |
| /// Example: service Messaging { rpc GetMessage(GetMessageRequest) returns |
| /// (Message) { option (google.api.http) = { get: "/v1/{name=messages / * }" }; |
| /// } } message GetMessageRequest { string name = 1; // Mapped to URL path. } |
| /// message Message { string text = 1; // The resource content. } This enables |
| /// an HTTP REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET |
| /// /v1/messages/123456` | `GetMessage(name: "messages/123456")` Any fields in |
| /// the request message which are not bound by the path template automatically |
| /// become HTTP query parameters if there is no HTTP request body. For example: |
| /// 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 URL path. int64 revision = 2; // Mapped to URL |
| /// query parameter `revision`. SubMessage sub = 3; // Mapped to URL query |
| /// parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as |
| /// below: HTTP | gRPC -----|----- `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 URL query parameters must have a primitive type or a |
| /// repeated primitive type or a non-repeated message type. In the case of a |
| /// repeated type, the parameter can be repeated in the URL as |
| /// `...?param=A¶m=B`. In the case of a message type, each field of the |
| /// message is mapped to a separate parameter, such as |
| /// `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that 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) = { patch: "/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 | gRPC -----|----- `PATCH |
| /// /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) = { |
| /// patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string |
| /// message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is |
| /// enabled: HTTP | gRPC -----|----- `PATCH /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 when 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 | gRPC |
| /// -----|----- `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 1. Leaf request fields (recursive |
| /// expansion nested messages in the request message) are classified into three |
| /// categories: - Fields referred by the path template. They are passed via the |
| /// URL path. - Fields referred by the HttpRule.body. They are passed via the |
| /// HTTP request body. - All other fields are passed via the URL query |
| /// parameters, and the parameter name is the field path in the request message. |
| /// A repeated field can be represented as multiple query parameters under the |
| /// same name. 2. If HttpRule.body is "*", there is no URL query parameter, all |
| /// fields are passed via URL path and HTTP request body. 3. If HttpRule.body is |
| /// omitted, there is no HTTP request body, all fields are passed via URL path |
| /// and URL query parameters. ### Path template syntax Template = "/" Segments |
| /// \[ Verb \] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | |
| /// LITERAL | Variable ; Variable = "{" FieldPath \[ "=" Segments \] "}" ; |
| /// FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` |
| /// matches a single URL path segment. The syntax `**` matches zero or more URL |
| /// path segments, which must be the last part of the URL path except the |
| /// `Verb`. 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=*}`. The syntax `LITERAL` matches literal |
| /// text in the URL path. If the `LITERAL` contains any reserved character, such |
| /// characters should be percent-encoded before the matching. If a variable |
| /// contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when |
| /// such a variable is expanded into a URL path on the client side, all |
| /// characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side |
| /// does the reverse decoding. Such variables show up in the |
| /// [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) |
| /// as `{var}`. If a variable contains multiple path segments, such as |
| /// `"{var=foo / * }"` or `"{var=**}"`, when such a variable is expanded into a |
| /// URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are |
| /// percent-encoded. The server side does the reverse decoding, except "%2F" and |
| /// "%2f" are left unchanged. Such variables show up in the |
| /// [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) |
| /// as `{+var}`. ## Using gRPC API Service Configuration gRPC API Service |
| /// Configuration (service config) is a configuration language for configuring a |
| /// gRPC service to become a user-facing product. The service config is simply |
| /// the YAML representation of the `google.api.Service` proto message. As an |
| /// alternative to annotating your proto file, you can configure gRPC |
| /// transcoding in your service config YAML files. You do this by specifying a |
| /// `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same |
| /// effect as the proto annotation. This can be particularly useful if you have |
| /// a proto that is reused in multiple services. Note that any transcoding |
| /// specified in the service config will override any matching transcoding |
| /// configuration in the proto. Example: http: rules: # Selects a gRPC method |
| /// and applies HttpRule to it. - selector: example.v1.Messaging.GetMessage get: |
| /// /v1/messages/{message_id}/{sub.subfield} ## Special notes When gRPC |
| /// Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON |
| /// conversion must follow the |
| /// [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). |
| /// While the single segment variable follows the semantics of |
| /// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String |
| /// Expansion, the multi segment variable **does not** follow RFC 6570 Section |
| /// 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not |
| /// expand special characters like `?` and `#`, which would lead to invalid |
| /// URLs. As the result, gRPC Transcoding uses a custom encoding for multi |
| /// segment variables. The path variables **must not** refer to any repeated or |
| /// mapped field, because client libraries are not capable of handling such |
| /// variable expansion. The path variables **must not** capture the leading "/" |
| /// character. The reason is that the most common use case "{var}" does not |
| /// capture the leading "/" character. For consistency, all path variables must |
| /// share the same behavior. Repeated message fields must not be mapped to URL |
| /// query parameters, because no client library can support such complicated |
| /// mapping. If an API needs to use a JSON array for request or response body, |
| /// it can map the request or response body to a repeated field. However, some |
| /// gRPC Transcoding implementations may not support this feature. |
| 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). |
| core.List<HttpRule> additionalBindings; |
| |
| /// The name of the request field whose value is mapped to the HTTP request |
| /// body, or `*` for mapping all request fields not captured by the path |
| /// pattern to the HTTP body, or omitted for not having any HTTP request body. |
| /// |
| /// NOTE: the referred field must be present at the top-level of the 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. |
| CustomHttpPattern custom; |
| |
| /// Maps to HTTP DELETE. |
| /// |
| /// Used for deleting a resource. |
| core.String delete; |
| |
| /// Maps to HTTP GET. |
| /// |
| /// Used for listing and getting information about resources. |
| core.String get; |
| |
| /// Maps to HTTP PATCH. |
| /// |
| /// Used for updating a resource. |
| core.String patch; |
| |
| /// Maps to HTTP POST. |
| /// |
| /// Used for creating a resource or performing an action. |
| core.String post; |
| |
| /// Maps to HTTP PUT. |
| /// |
| /// Used for replacing a resource. |
| core.String put; |
| |
| /// The name of the response field whose value is mapped to the HTTP response |
| /// body. |
| /// |
| /// When omitted, the entire response message will be used as the HTTP |
| /// response body. NOTE: The referred field must be present at the top-level |
| /// of the response message type. |
| /// |
| /// Optional. |
| core.String responseBody; |
| |
| /// Selects a method 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'] as core.List) |
| .map<HttpRule>((value) => |
| HttpRule.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('body')) { |
| body = _json['body'] as core.String; |
| } |
| if (_json.containsKey('custom')) { |
| custom = CustomHttpPattern.fromJson( |
| _json['custom'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('delete')) { |
| delete = _json['delete'] as core.String; |
| } |
| if (_json.containsKey('get')) { |
| get = _json['get'] as core.String; |
| } |
| if (_json.containsKey('patch')) { |
| patch = _json['patch'] as core.String; |
| } |
| if (_json.containsKey('post')) { |
| post = _json['post'] as core.String; |
| } |
| if (_json.containsKey('put')) { |
| put = _json['put'] as core.String; |
| } |
| if (_json.containsKey('responseBody')) { |
| responseBody = _json['responseBody'] as core.String; |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (additionalBindings != null) { |
| _json['additionalBindings'] = |
| additionalBindings.map((value) => value.toJson()).toList(); |
| } |
| if (body != null) { |
| _json['body'] = body; |
| } |
| if (custom != null) { |
| _json['custom'] = custom.toJson(); |
| } |
| if (delete != null) { |
| _json['delete'] = delete; |
| } |
| if (get != null) { |
| _json['get'] = get; |
| } |
| if (patch != null) { |
| _json['patch'] = patch; |
| } |
| if (post != null) { |
| _json['post'] = post; |
| } |
| if (put != null) { |
| _json['put'] = put; |
| } |
| if (responseBody != null) { |
| _json['responseBody'] = responseBody; |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for ImportAdminOverrides |
| class ImportAdminOverridesResponse { |
| /// The overrides that were created from the imported data. |
| core.List<QuotaOverride> overrides; |
| |
| ImportAdminOverridesResponse(); |
| |
| ImportAdminOverridesResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('overrides')) { |
| overrides = (_json['overrides'] as core.List) |
| .map<QuotaOverride>((value) => QuotaOverride.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (overrides != null) { |
| _json['overrides'] = overrides.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for ImportAdminQuotaPolicies |
| class ImportAdminQuotaPoliciesResponse { |
| /// The policies that were created from the imported data. |
| core.List<AdminQuotaPolicy> policies; |
| |
| ImportAdminQuotaPoliciesResponse(); |
| |
| ImportAdminQuotaPoliciesResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('policies')) { |
| policies = (_json['policies'] as core.List) |
| .map<AdminQuotaPolicy>((value) => AdminQuotaPolicy.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (policies != null) { |
| _json['policies'] = policies.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for ImportConsumerOverrides |
| class ImportConsumerOverridesResponse { |
| /// The overrides that were created from the imported data. |
| core.List<QuotaOverride> overrides; |
| |
| ImportConsumerOverridesResponse(); |
| |
| ImportConsumerOverridesResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('overrides')) { |
| overrides = (_json['overrides'] as core.List) |
| .map<QuotaOverride>((value) => QuotaOverride.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (overrides != null) { |
| _json['overrides'] = overrides.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Specifies a location to extract JWT from an API request. |
| class JwtLocation { |
| /// Specifies HTTP header name to extract JWT token. |
| core.String header; |
| |
| /// Specifies URL query parameter name to extract JWT token. |
| core.String query; |
| |
| /// The value prefix. |
| /// |
| /// The value format is "value_prefix{token}" Only applies to "in" header |
| /// type. Must be empty for "in" query type. If not empty, the header value |
| /// has to match (case sensitive) this prefix. If not matched, JWT will not be |
| /// extracted. If matched, JWT will be extracted after the prefix is removed. |
| /// For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " |
| /// with a space at the end. |
| core.String valuePrefix; |
| |
| JwtLocation(); |
| |
| JwtLocation.fromJson(core.Map _json) { |
| if (_json.containsKey('header')) { |
| header = _json['header'] as core.String; |
| } |
| if (_json.containsKey('query')) { |
| query = _json['query'] as core.String; |
| } |
| if (_json.containsKey('valuePrefix')) { |
| valuePrefix = _json['valuePrefix'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (header != null) { |
| _json['header'] = header; |
| } |
| if (query != null) { |
| _json['query'] = query; |
| } |
| if (valuePrefix != null) { |
| _json['valuePrefix'] = valuePrefix; |
| } |
| return _json; |
| } |
| } |
| |
| /// A description of a label. |
| class LabelDescriptor { |
| /// A human-readable description for the label. |
| core.String description; |
| |
| /// 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. |
| core.String valueType; |
| |
| LabelDescriptor(); |
| |
| LabelDescriptor.fromJson(core.Map _json) { |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| if (_json.containsKey('key')) { |
| key = _json['key'] as core.String; |
| } |
| if (_json.containsKey('valueType')) { |
| valueType = _json['valueType'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (description != null) { |
| _json['description'] = description; |
| } |
| if (key != null) { |
| _json['key'] = key; |
| } |
| if (valueType != null) { |
| _json['valueType'] = valueType; |
| } |
| return _json; |
| } |
| } |
| |
| /// The response message for Operations.ListOperations. |
| class ListOperationsResponse { |
| /// The standard List next-page token. |
| core.String nextPageToken; |
| |
| /// A list of operations that matches the specified filter in the request. |
| core.List<Operation> operations; |
| |
| ListOperationsResponse(); |
| |
| ListOperationsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| if (_json.containsKey('operations')) { |
| operations = (_json['operations'] as core.List) |
| .map<Operation>((value) => |
| Operation.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (nextPageToken != null) { |
| _json['nextPageToken'] = nextPageToken; |
| } |
| if (operations != null) { |
| _json['operations'] = operations.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Response message for the `ListServices` method. |
| class ListServicesResponse { |
| /// Token that can be passed to `ListServices` to resume a paginated query. |
| core.String nextPageToken; |
| |
| /// The available services for the requested project. |
| core.List<GoogleApiServiceusageV1Service> services; |
| |
| ListServicesResponse(); |
| |
| ListServicesResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| if (_json.containsKey('services')) { |
| services = (_json['services'] as core.List) |
| .map<GoogleApiServiceusageV1Service>((value) => |
| GoogleApiServiceusageV1Service.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (nextPageToken != null) { |
| _json['nextPageToken'] = nextPageToken; |
| } |
| if (services != null) { |
| _json['services'] = services.map((value) => value.toJson()).toList(); |
| } |
| 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 |
| class LogDescriptor { |
| /// 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. |
| 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. |
| 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 |
| /// \[/_-.\]. |
| core.String name; |
| |
| LogDescriptor(); |
| |
| LogDescriptor.fromJson(core.Map _json) { |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| if (_json.containsKey('displayName')) { |
| displayName = _json['displayName'] as core.String; |
| } |
| if (_json.containsKey('labels')) { |
| labels = (_json['labels'] as core.List) |
| .map<LabelDescriptor>((value) => LabelDescriptor.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (description != null) { |
| _json['description'] = description; |
| } |
| if (displayName != null) { |
| _json['displayName'] = displayName; |
| } |
| if (labels != null) { |
| _json['labels'] = labels.map((value) => value.toJson()).toList(); |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| 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. |
| core.List<LoggingDestination> producerDestinations; |
| |
| Logging(); |
| |
| Logging.fromJson(core.Map _json) { |
| if (_json.containsKey('consumerDestinations')) { |
| consumerDestinations = (_json['consumerDestinations'] as core.List) |
| .map<LoggingDestination>((value) => LoggingDestination.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('producerDestinations')) { |
| producerDestinations = (_json['producerDestinations'] as core.List) |
| .map<LoggingDestination>((value) => LoggingDestination.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (consumerDestinations != null) { |
| _json['consumerDestinations'] = |
| consumerDestinations.map((value) => value.toJson()).toList(); |
| } |
| if (producerDestinations != null) { |
| _json['producerDestinations'] = |
| producerDestinations.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// 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 "/". |
| core.List<core.String> logs; |
| |
| /// The monitored resource type. |
| /// |
| /// The type must be defined in the Service.monitored_resources section. |
| core.String monitoredResource; |
| |
| LoggingDestination(); |
| |
| LoggingDestination.fromJson(core.Map _json) { |
| if (_json.containsKey('logs')) { |
| logs = (_json['logs'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('monitoredResource')) { |
| monitoredResource = _json['monitoredResource'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (logs != null) { |
| _json['logs'] = logs; |
| } |
| if (monitoredResource != null) { |
| _json['monitoredResource'] = monitoredResource; |
| } |
| return _json; |
| } |
| } |
| |
| /// Method represents a method of an API interface. |
| class Method { |
| /// The simple name of this method. |
| core.String name; |
| |
| /// Any metadata attached to the method. |
| core.List<Option> options; |
| |
| /// If true, the request is streamed. |
| core.bool requestStreaming; |
| |
| /// A URL of the input message type. |
| core.String requestTypeUrl; |
| |
| /// If true, the response is streamed. |
| core.bool responseStreaming; |
| |
| /// 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`. |
| core.String syntax; |
| |
| Method(); |
| |
| Method.fromJson(core.Map _json) { |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('options')) { |
| options = (_json['options'] as core.List) |
| .map<Option>((value) => |
| Option.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('requestStreaming')) { |
| requestStreaming = _json['requestStreaming'] as core.bool; |
| } |
| if (_json.containsKey('requestTypeUrl')) { |
| requestTypeUrl = _json['requestTypeUrl'] as core.String; |
| } |
| if (_json.containsKey('responseStreaming')) { |
| responseStreaming = _json['responseStreaming'] as core.bool; |
| } |
| if (_json.containsKey('responseTypeUrl')) { |
| responseTypeUrl = _json['responseTypeUrl'] as core.String; |
| } |
| if (_json.containsKey('syntax')) { |
| syntax = _json['syntax'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (options != null) { |
| _json['options'] = options.map((value) => value.toJson()).toList(); |
| } |
| if (requestStreaming != null) { |
| _json['requestStreaming'] = requestStreaming; |
| } |
| if (requestTypeUrl != null) { |
| _json['requestTypeUrl'] = requestTypeUrl; |
| } |
| if (responseStreaming != null) { |
| _json['responseStreaming'] = responseStreaming; |
| } |
| if (responseTypeUrl != null) { |
| _json['responseTypeUrl'] = responseTypeUrl; |
| } |
| if (syntax != null) { |
| _json['syntax'] = syntax; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| 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". |
| /// This field is optional but it is recommended to be set for any metrics |
| /// associated with user-visible concepts, such as Quota. |
| 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. |
| core.List<LabelDescriptor> labels; |
| |
| /// The launch stage of the metric definition. |
| /// |
| /// Optional. |
| /// Possible string values are: |
| /// - "LAUNCH_STAGE_UNSPECIFIED" : Do not use this default value. |
| /// - "UNIMPLEMENTED" : The feature is not yet implemented. Users can not use |
| /// it. |
| /// - "PRELAUNCH" : Prelaunch features are hidden from users and are only |
| /// visible internally. |
| /// - "EARLY_ACCESS" : Early Access features are limited to a closed group of |
| /// testers. To use these features, you must sign up in advance and sign a |
| /// Trusted Tester agreement (which includes confidentiality provisions). |
| /// These features may be unstable, changed in backward-incompatible ways, and |
| /// are not guaranteed to be released. |
| /// - "ALPHA" : Alpha is a limited availability test for releases before they |
| /// are cleared for widespread use. By Alpha, all significant design issues |
| /// are resolved and we are in the process of verifying functionality. Alpha |
| /// customers need to apply for access, agree to applicable terms, and have |
| /// their projects allowlisted. Alpha releases don’t have to be feature |
| /// complete, no SLAs are provided, and there are no technical support |
| /// obligations, but they will be far enough along that customers can actually |
| /// use them in test environments or for limited-use tests -- just like they |
| /// would in normal production cases. |
| /// - "BETA" : Beta is the point at which we are ready to open a release for |
| /// any customer to use. There are no SLA or technical support obligations in |
| /// a Beta release. Products will be complete from a feature perspective, but |
| /// may have some open outstanding issues. Beta releases are suitable for |
| /// limited production use cases. |
| /// - "GA" : GA features are open to all developers and are considered stable |
| /// and fully qualified for production use. |
| /// - "DEPRECATED" : Deprecated features are scheduled to be shut down and |
| /// removed. For more information, see the “Deprecation Policy” section of our |
| /// [Terms of Service](https://cloud.google.com/terms/) and the |
| /// [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) |
| /// documentation. |
| core.String launchStage; |
| |
| /// Metadata which can be used to guide usage of the metric. |
| /// |
| /// Optional. |
| MetricDescriptorMetadata metadata; |
| |
| /// 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; |
| |
| /// Read-only. |
| /// |
| /// If present, then a time series, which is identified partially by a metric |
| /// type and a MonitoredResourceDescriptor, that is associated with this |
| /// metric type can only be associated with one of the monitored resource |
| /// types listed here. |
| core.List<core.String> monitoredResourceTypes; |
| |
| /// The resource name of the metric descriptor. |
| core.String name; |
| |
| /// The metric type, including its DNS name prefix. |
| /// |
| /// The type is not URL-encoded. All user-defined metric types have the DNS |
| /// name `custom.googleapis.com` or `external.googleapis.com`. Metric types |
| /// should use a natural hierarchical grouping. For example: |
| /// "custom.googleapis.com/invoice/paid/amount" |
| /// "external.googleapis.com/prometheus/up" |
| /// "appengine.googleapis.com/http/server/response_latencies" |
| core.String type; |
| |
| /// The units in which the metric value is reported. |
| /// |
| /// It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or |
| /// `DISTRIBUTION`. The `unit` defines the representation of the stored metric |
| /// values. Different systems might scale the values to be more easily |
| /// displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a |
| /// value of `3523kBy` _might_ be displayed as `3.5MBy`). However, if the |
| /// `unit` is `kBy`, then the value of the metric is always in thousands of |
| /// bytes, no matter how it might be displayed. If you want a custom metric to |
| /// record the exact number of CPU-seconds used by a job, you can create an |
| /// `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently |
| /// `1s{CPU}` or just `s`). If the job uses 12,005 CPU-seconds, then the value |
| /// is written as `12005`. Alternatively, if you want a custom metric to |
| /// record data in a more granular way, you can create a `DOUBLE CUMULATIVE` |
| /// metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which |
| /// is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is |
| /// `12005/1024`). The supported units are a subset of |
| /// [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) |
| /// standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * |
| /// `min` minute * `h` hour * `d` day * `1` dimensionless **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) * `Pi` pebi (2^50) **Grammar** The |
| /// grammar also includes these connectors: * `/` division or ratio (as an |
| /// infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you |
| /// should almost never have `/s` in a metric `unit`; rates should always be |
| /// computed at query time from the underlying cumulative or delta value). * |
| /// `.` multiplication or composition (as an infix operator). For examples, |
| /// `GBy.d` or `k{watt}.h`. 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`. If |
| /// the annotation is used alone, then the unit is equivalent to `1`. For |
| /// examples, `{request}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a |
| /// sequence of non-blank printable ASCII characters not containing `{` or |
| /// `}`. * `1` represents a unitary |
| /// [dimensionless unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) |
| /// of 1, such as in `1/s`. It is typically used when none of the basic units |
| /// are appropriate. For example, "new users per day" can be represented as |
| /// `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). |
| /// Alternatively, "thousands of page views per day" would be represented as |
| /// `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would |
| /// mean "5300 page views per day"). * `%` represents dimensionless value of |
| /// 1/100, and annotates values giving a percentage (so the metric values are |
| /// typically in the range of 0..100, and a metric value `3` means "3 |
| /// percent"). * `10^2.%` indicates a metric contains a ratio, typically in |
| /// the range 0..1, that will be multiplied by 100 and displayed as a |
| /// percentage (so a metric value `0.03` means "3 percent"). |
| 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. |
| core.String valueType; |
| |
| MetricDescriptor(); |
| |
| MetricDescriptor.fromJson(core.Map _json) { |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| if (_json.containsKey('displayName')) { |
| displayName = _json['displayName'] as core.String; |
| } |
| if (_json.containsKey('labels')) { |
| labels = (_json['labels'] as core.List) |
| .map<LabelDescriptor>((value) => LabelDescriptor.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('launchStage')) { |
| launchStage = _json['launchStage'] as core.String; |
| } |
| if (_json.containsKey('metadata')) { |
| metadata = MetricDescriptorMetadata.fromJson( |
| _json['metadata'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('metricKind')) { |
| metricKind = _json['metricKind'] as core.String; |
| } |
| if (_json.containsKey('monitoredResourceTypes')) { |
| monitoredResourceTypes = (_json['monitoredResourceTypes'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('type')) { |
| type = _json['type'] as core.String; |
| } |
| if (_json.containsKey('unit')) { |
| unit = _json['unit'] as core.String; |
| } |
| if (_json.containsKey('valueType')) { |
| valueType = _json['valueType'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (description != null) { |
| _json['description'] = description; |
| } |
| if (displayName != null) { |
| _json['displayName'] = displayName; |
| } |
| if (labels != null) { |
| _json['labels'] = labels.map((value) => value.toJson()).toList(); |
| } |
| if (launchStage != null) { |
| _json['launchStage'] = launchStage; |
| } |
| if (metadata != null) { |
| _json['metadata'] = metadata.toJson(); |
| } |
| if (metricKind != null) { |
| _json['metricKind'] = metricKind; |
| } |
| if (monitoredResourceTypes != null) { |
| _json['monitoredResourceTypes'] = monitoredResourceTypes; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (type != null) { |
| _json['type'] = type; |
| } |
| if (unit != null) { |
| _json['unit'] = unit; |
| } |
| if (valueType != null) { |
| _json['valueType'] = valueType; |
| } |
| return _json; |
| } |
| } |
| |
| /// Additional annotations that can be used to guide the usage of a metric. |
| class MetricDescriptorMetadata { |
| /// The delay of data points caused by ingestion. |
| /// |
| /// Data points older than this age are guaranteed to be ingested and |
| /// available to be read, excluding data loss due to errors. |
| core.String ingestDelay; |
| |
| /// Must use the MetricDescriptor.launch_stage instead. |
| /// |
| /// Deprecated. |
| /// Possible string values are: |
| /// - "LAUNCH_STAGE_UNSPECIFIED" : Do not use this default value. |
| /// - "UNIMPLEMENTED" : The feature is not yet implemented. Users can not use |
| /// it. |
| /// - "PRELAUNCH" : Prelaunch features are hidden from users and are only |
| /// visible internally. |
| /// - "EARLY_ACCESS" : Early Access features are limited to a closed group of |
| /// testers. To use these features, you must sign up in advance and sign a |
| /// Trusted Tester agreement (which includes confidentiality provisions). |
| /// These features may be unstable, changed in backward-incompatible ways, and |
| /// are not guaranteed to be released. |
| /// - "ALPHA" : Alpha is a limited availability test for releases before they |
| /// are cleared for widespread use. By Alpha, all significant design issues |
| /// are resolved and we are in the process of verifying functionality. Alpha |
| /// customers need to apply for access, agree to applicable terms, and have |
| /// their projects allowlisted. Alpha releases don’t have to be feature |
| /// complete, no SLAs are provided, and there are no technical support |
| /// obligations, but they will be far enough along that customers can actually |
| /// use them in test environments or for limited-use tests -- just like they |
| /// would in normal production cases. |
| /// - "BETA" : Beta is the point at which we are ready to open a release for |
| /// any customer to use. There are no SLA or technical support obligations in |
| /// a Beta release. Products will be complete from a feature perspective, but |
| /// may have some open outstanding issues. Beta releases are suitable for |
| /// limited production use cases. |
| /// - "GA" : GA features are open to all developers and are considered stable |
| /// and fully qualified for production use. |
| /// - "DEPRECATED" : Deprecated features are scheduled to be shut down and |
| /// removed. For more information, see the “Deprecation Policy” section of our |
| /// [Terms of Service](https://cloud.google.com/terms/) and the |
| /// [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) |
| /// documentation. |
| core.String launchStage; |
| |
| /// The sampling period of metric data points. |
| /// |
| /// For metrics which are written periodically, consecutive data points are |
| /// stored at this time interval, excluding data loss due to errors. Metrics |
| /// with a higher granularity have a smaller sampling period. |
| core.String samplePeriod; |
| |
| MetricDescriptorMetadata(); |
| |
| MetricDescriptorMetadata.fromJson(core.Map _json) { |
| if (_json.containsKey('ingestDelay')) { |
| ingestDelay = _json['ingestDelay'] as core.String; |
| } |
| if (_json.containsKey('launchStage')) { |
| launchStage = _json['launchStage'] as core.String; |
| } |
| if (_json.containsKey('samplePeriod')) { |
| samplePeriod = _json['samplePeriod'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (ingestDelay != null) { |
| _json['ingestDelay'] = ingestDelay; |
| } |
| if (launchStage != null) { |
| _json['launchStage'] = launchStage; |
| } |
| if (samplePeriod != null) { |
| _json['samplePeriod'] = samplePeriod; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.Map<core.String, core.String> metricCosts; |
| |
| /// Selects the methods to which this rule applies. |
| /// |
| /// Refer to selector for syntax details. |
| core.String selector; |
| |
| MetricRule(); |
| |
| MetricRule.fromJson(core.Map _json) { |
| if (_json.containsKey('metricCosts')) { |
| metricCosts = (_json['metricCosts'] as core.Map) |
| .cast<core.String, core.String>() |
| .map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.String, |
| ), |
| ); |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (metricCosts != null) { |
| _json['metricCosts'] = metricCosts; |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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 inheriting 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. |
| core.String name; |
| |
| /// If non-empty specifies a path under which inherited HTTP paths are rooted. |
| core.String root; |
| |
| Mixin(); |
| |
| Mixin.fromJson(core.Map _json) { |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('root')) { |
| root = _json['root'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (root != null) { |
| _json['root'] = root; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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 { |
| /// A detailed description of the monitored resource type that might be used |
| /// in documentation. |
| /// |
| /// Optional. |
| core.String description; |
| |
| /// 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. |
| core.String displayName; |
| |
| /// 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. |
| core.List<LabelDescriptor> labels; |
| |
| /// The launch stage of the monitored resource definition. |
| /// |
| /// Optional. |
| /// Possible string values are: |
| /// - "LAUNCH_STAGE_UNSPECIFIED" : Do not use this default value. |
| /// - "UNIMPLEMENTED" : The feature is not yet implemented. Users can not use |
| /// it. |
| /// - "PRELAUNCH" : Prelaunch features are hidden from users and are only |
| /// visible internally. |
| /// - "EARLY_ACCESS" : Early Access features are limited to a closed group of |
| /// testers. To use these features, you must sign up in advance and sign a |
| /// Trusted Tester agreement (which includes confidentiality provisions). |
| /// These features may be unstable, changed in backward-incompatible ways, and |
| /// are not guaranteed to be released. |
| /// - "ALPHA" : Alpha is a limited availability test for releases before they |
| /// are cleared for widespread use. By Alpha, all significant design issues |
| /// are resolved and we are in the process of verifying functionality. Alpha |
| /// customers need to apply for access, agree to applicable terms, and have |
| /// their projects allowlisted. Alpha releases don’t have to be feature |
| /// complete, no SLAs are provided, and there are no technical support |
| /// obligations, but they will be far enough along that customers can actually |
| /// use them in test environments or for limited-use tests -- just like they |
| /// would in normal production cases. |
| /// - "BETA" : Beta is the point at which we are ready to open a release for |
| /// any customer to use. There are no SLA or technical support obligations in |
| /// a Beta release. Products will be complete from a feature perspective, but |
| /// may have some open outstanding issues. Beta releases are suitable for |
| /// limited production use cases. |
| /// - "GA" : GA features are open to all developers and are considered stable |
| /// and fully qualified for production use. |
| /// - "DEPRECATED" : Deprecated features are scheduled to be shut down and |
| /// removed. For more information, see the “Deprecation Policy” section of our |
| /// [Terms of Service](https://cloud.google.com/terms/) and the |
| /// [Google Cloud Platform Subject to the Deprecation Policy](https://cloud.google.com/terms/deprecation) |
| /// documentation. |
| core.String launchStage; |
| |
| /// 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. |
| core.String name; |
| |
| /// The monitored resource type. |
| /// |
| /// For example, the type `"cloudsql_database"` represents databases in Google |
| /// Cloud SQL. |
| /// |
| /// Required. |
| core.String type; |
| |
| MonitoredResourceDescriptor(); |
| |
| MonitoredResourceDescriptor.fromJson(core.Map _json) { |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| if (_json.containsKey('displayName')) { |
| displayName = _json['displayName'] as core.String; |
| } |
| if (_json.containsKey('labels')) { |
| labels = (_json['labels'] as core.List) |
| .map<LabelDescriptor>((value) => LabelDescriptor.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('launchStage')) { |
| launchStage = _json['launchStage'] as core.String; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('type')) { |
| type = _json['type'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (description != null) { |
| _json['description'] = description; |
| } |
| if (displayName != null) { |
| _json['displayName'] = displayName; |
| } |
| if (labels != null) { |
| _json['labels'] = labels.map((value) => value.toJson()).toList(); |
| } |
| if (launchStage != null) { |
| _json['launchStage'] = launchStage; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (type != null) { |
| _json['type'] = type; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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/num_overdue` metric is only sent to the |
| /// consumer project. monitored_resources: - type: library.googleapis.com/Branch |
| /// display_name: "Library Branch" description: "A branch of a library." |
| /// launch_stage: GA labels: - key: resource_container description: "The Cloud |
| /// container (ie. project id) for the Branch." - key: location description: |
| /// "The location of the library branch." - key: branch_id description: "The id |
| /// of the branch." metrics: - name: library.googleapis.com/book/returned_count |
| /// display_name: "Books Returned" description: "The count of books that have |
| /// been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: |
| /// "1" labels: - key: customer_id description: "The id of the customer." - |
| /// name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" |
| /// description: "The current number of overdue books." launch_stage: GA |
| /// metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id |
| /// description: "The id of the customer." 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/num_overdue |
| class Monitoring { |
| /// Monitoring configurations for sending metrics to the consumer project. |
| /// |
| /// There can be multiple consumer destinations. A monitored resource type may |
| /// appear in multiple monitoring destinations if different aggregations are |
| /// needed for different sets of metrics associated with that monitored |
| /// resource type. A monitored resource and metric pair may only be used once |
| /// in the Monitoring configuration. |
| core.List<MonitoringDestination> consumerDestinations; |
| |
| /// Monitoring configurations for sending metrics to the producer project. |
| /// |
| /// There can be multiple producer destinations. A monitored resource type may |
| /// appear in multiple monitoring destinations if different aggregations are |
| /// needed for different sets of metrics associated with that monitored |
| /// resource type. A monitored resource and metric pair may only be used once |
| /// in the Monitoring configuration. |
| core.List<MonitoringDestination> producerDestinations; |
| |
| Monitoring(); |
| |
| Monitoring.fromJson(core.Map _json) { |
| if (_json.containsKey('consumerDestinations')) { |
| consumerDestinations = (_json['consumerDestinations'] as core.List) |
| .map<MonitoringDestination>((value) => MonitoringDestination.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('producerDestinations')) { |
| producerDestinations = (_json['producerDestinations'] as core.List) |
| .map<MonitoringDestination>((value) => MonitoringDestination.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (consumerDestinations != null) { |
| _json['consumerDestinations'] = |
| consumerDestinations.map((value) => value.toJson()).toList(); |
| } |
| if (producerDestinations != null) { |
| _json['producerDestinations'] = |
| producerDestinations.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Configuration of a specific monitoring destination (the producer project or |
| /// the consumer project). |
| class MonitoringDestination { |
| /// Types of the metrics to report to this monitoring destination. |
| /// |
| /// Each type 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. |
| core.String monitoredResource; |
| |
| MonitoringDestination(); |
| |
| MonitoringDestination.fromJson(core.Map _json) { |
| if (_json.containsKey('metrics')) { |
| metrics = (_json['metrics'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('monitoredResource')) { |
| monitoredResource = _json['monitoredResource'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (metrics != null) { |
| _json['metrics'] = metrics; |
| } |
| if (monitoredResource != null) { |
| _json['monitoredResource'] = monitoredResource; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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 |
| core.String canonicalScopes; |
| |
| OAuthRequirements(); |
| |
| OAuthRequirements.fromJson(core.Map _json) { |
| if (_json.containsKey('canonicalScopes')) { |
| canonicalScopes = _json['canonicalScopes'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (canonicalScopes != null) { |
| _json['canonicalScopes'] = canonicalScopes; |
| } |
| return _json; |
| } |
| } |
| |
| /// This resource represents a long-running operation that is the result of a |
| /// network API call. |
| class Operation { |
| /// If the value is `false`, it means the operation is still in progress. |
| /// |
| /// If `true`, the operation is completed, and either `error` or `response` is |
| /// available. |
| core.bool done; |
| |
| /// The error result of the operation in case of failure or cancellation. |
| Status error; |
| |
| /// Service-specific metadata associated with the operation. |
| /// |
| /// It typically contains progress information and common metadata such as |
| /// create time. Some services might not provide such metadata. Any method |
| /// that returns a long-running operation should document the metadata type, |
| /// if any. |
| /// |
| /// The values for Object must be JSON objects. It can consist of `num`, |
| /// `String`, `bool` and `null` as well as `Map` and `List` values. |
| core.Map<core.String, core.Object> metadata; |
| |
| /// The server-assigned name, which is only unique within the same service |
| /// that originally returns it. |
| /// |
| /// If you use the default HTTP mapping, the `name` should be a resource name |
| /// ending with `operations/{unique_id}`. |
| core.String name; |
| |
| /// The normal response of the operation in case of success. |
| /// |
| /// If the original method returns no data on success, such as `Delete`, the |
| /// response is `google.protobuf.Empty`. If the original method is standard |
| /// `Get`/`Create`/`Update`, the response should be the resource. For other |
| /// methods, the response should have the type `XxxResponse`, where `Xxx` is |
| /// the original method name. For example, if the original method name is |
| /// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| /// |
| /// The values for Object must be JSON objects. It can consist of `num`, |
| /// `String`, `bool` and `null` as well as `Map` and `List` values. |
| core.Map<core.String, core.Object> response; |
| |
| Operation(); |
| |
| Operation.fromJson(core.Map _json) { |
| if (_json.containsKey('done')) { |
| done = _json['done'] as core.bool; |
| } |
| if (_json.containsKey('error')) { |
| error = Status.fromJson( |
| _json['error'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('metadata')) { |
| metadata = |
| (_json['metadata'] as core.Map).cast<core.String, core.Object>().map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| ); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('response')) { |
| response = |
| (_json['response'] as core.Map).cast<core.String, core.Object>().map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| ); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (done != null) { |
| _json['done'] = done; |
| } |
| if (error != null) { |
| _json['error'] = error.toJson(); |
| } |
| if (metadata != null) { |
| _json['metadata'] = metadata; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (response != null) { |
| _json['response'] = response; |
| } |
| return _json; |
| } |
| } |
| |
| /// The operation metadata returned for the batchend services operation. |
| class OperationMetadata { |
| /// The full name of the resources that this operation is directly associated |
| /// with. |
| core.List<core.String> resourceNames; |
| |
| OperationMetadata(); |
| |
| OperationMetadata.fromJson(core.Map _json) { |
| if (_json.containsKey('resourceNames')) { |
| resourceNames = (_json['resourceNames'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (resourceNames != null) { |
| _json['resourceNames'] = resourceNames; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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"`. |
| 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. |
| core.Map<core.String, core.Object> value; |
| |
| Option(); |
| |
| Option.fromJson(core.Map _json) { |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('value')) { |
| value = (_json['value'] as core.Map).cast<core.String, core.Object>().map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| ); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (value != null) { |
| _json['value'] = value; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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 (== include {path} ==) 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: pages: - |
| /// name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java |
| /// content: (== include tutorial_java.md ==) 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. |
| core.List<Page> subpages; |
| |
| Page(); |
| |
| Page.fromJson(core.Map _json) { |
| if (_json.containsKey('content')) { |
| content = _json['content'] as core.String; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('subpages')) { |
| subpages = (_json['subpages'] as core.List) |
| .map<Page>((value) => |
| Page.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (content != null) { |
| _json['content'] = content; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (subpages != null) { |
| _json['subpages'] = subpages.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// Quota configuration helps to achieve fairness and budgeting in service |
| /// usage. |
| /// |
| /// The metric based 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: |
| /// limits: - 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. |
| core.List<QuotaLimit> limits; |
| |
| /// 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'] as core.List) |
| .map<QuotaLimit>((value) => |
| QuotaLimit.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('metricRules')) { |
| metricRules = (_json['metricRules'] as core.List) |
| .map<MetricRule>((value) => |
| MetricRule.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <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(); |
| } |
| 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`. |
| 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. |
| core.String defaultLimit; |
| |
| /// 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. |
| 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. |
| core.String displayName; |
| |
| /// Duration of this limit in textual notation. |
| /// |
| /// Must be "100s" or "1d". 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. |
| 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. |
| 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. |
| core.String metric; |
| |
| /// Name of the quota limit. |
| /// |
| /// 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. |
| 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. 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. |
| core.String unit; |
| |
| /// Tiered limit values. |
| /// |
| /// You must specify this as a key:value pair, with an integer value that is |
| /// the maximum number of requests allowed for the specified unit. Currently |
| /// only STANDARD is supported. |
| core.Map<core.String, core.String> values; |
| |
| QuotaLimit(); |
| |
| QuotaLimit.fromJson(core.Map _json) { |
| if (_json.containsKey('defaultLimit')) { |
| defaultLimit = _json['defaultLimit'] as core.String; |
| } |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| if (_json.containsKey('displayName')) { |
| displayName = _json['displayName'] as core.String; |
| } |
| if (_json.containsKey('duration')) { |
| duration = _json['duration'] as core.String; |
| } |
| if (_json.containsKey('freeTier')) { |
| freeTier = _json['freeTier'] as core.String; |
| } |
| if (_json.containsKey('maxLimit')) { |
| maxLimit = _json['maxLimit'] as core.String; |
| } |
| if (_json.containsKey('metric')) { |
| metric = _json['metric'] as core.String; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('unit')) { |
| unit = _json['unit'] as core.String; |
| } |
| if (_json.containsKey('values')) { |
| values = |
| (_json['values'] as core.Map).cast<core.String, core.String>().map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.String, |
| ), |
| ); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (defaultLimit != null) { |
| _json['defaultLimit'] = defaultLimit; |
| } |
| if (description != null) { |
| _json['description'] = description; |
| } |
| if (displayName != null) { |
| _json['displayName'] = displayName; |
| } |
| if (duration != null) { |
| _json['duration'] = duration; |
| } |
| if (freeTier != null) { |
| _json['freeTier'] = freeTier; |
| } |
| if (maxLimit != null) { |
| _json['maxLimit'] = maxLimit; |
| } |
| if (metric != null) { |
| _json['metric'] = metric; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (unit != null) { |
| _json['unit'] = unit; |
| } |
| if (values != null) { |
| _json['values'] = values; |
| } |
| return _json; |
| } |
| } |
| |
| /// A quota override |
| class QuotaOverride { |
| /// The resource name of the ancestor that requested the override. |
| /// |
| /// For example: "organizations/12345" or "folders/67890". Used by admin |
| /// overrides only. |
| core.String adminOverrideAncestor; |
| |
| /// If this map is nonempty, then this override applies only to specific |
| /// values for dimensions defined in the limit unit. |
| /// |
| /// For example, an override on a limit with the unit 1/{project}/{region} |
| /// could contain an entry with the key "region" and the value "us-east-1"; |
| /// the override is only applied to quota consumed in that region. This map |
| /// has the following restrictions: * Keys that are not defined in the limit's |
| /// unit are not valid keys. Any string appearing in {brackets} in the unit |
| /// (besides {project} or {user}) is a defined key. * "project" is not a valid |
| /// key; the project is already specified in the parent resource name. * |
| /// "user" is not a valid key; the API does not support quota overrides that |
| /// apply only to a specific user. * If "region" appears as a key, its value |
| /// must be a valid Cloud region. * If "zone" appears as a key, its value must |
| /// be a valid Cloud zone. * If any valid key other than "region" or "zone" |
| /// appears in the map, then all valid keys other than "region" or "zone" must |
| /// also appear in the map. |
| core.Map<core.String, core.String> dimensions; |
| |
| /// The name of the metric to which this override applies. |
| /// |
| /// An example name would be: `compute.googleapis.com/cpus` |
| core.String metric; |
| |
| /// The resource name of the override. |
| /// |
| /// This name is generated by the server when the override is created. Example |
| /// names would be: |
| /// `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| /// `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| /// The resource name is intended to be opaque and should not be parsed for |
| /// its component strings, since its representation could change in the |
| /// future. |
| core.String name; |
| |
| /// The overriding quota limit value. |
| /// |
| /// Can be any nonnegative integer, or -1 (unlimited quota). |
| core.String overrideValue; |
| |
| /// The limit unit of the limit to which this override applies. |
| /// |
| /// An example unit would be: `1/{project}/{region}` Note that `{project}` and |
| /// `{region}` are not placeholders in this example; the literal characters |
| /// `{` and `}` occur in the string. |
| core.String unit; |
| |
| QuotaOverride(); |
| |
| QuotaOverride.fromJson(core.Map _json) { |
| if (_json.containsKey('adminOverrideAncestor')) { |
| adminOverrideAncestor = _json['adminOverrideAncestor'] as core.String; |
| } |
| if (_json.containsKey('dimensions')) { |
| dimensions = (_json['dimensions'] as core.Map) |
| .cast<core.String, core.String>() |
| .map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.String, |
| ), |
| ); |
| } |
| if (_json.containsKey('metric')) { |
| metric = _json['metric'] as core.String; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('overrideValue')) { |
| overrideValue = _json['overrideValue'] as core.String; |
| } |
| if (_json.containsKey('unit')) { |
| unit = _json['unit'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (adminOverrideAncestor != null) { |
| _json['adminOverrideAncestor'] = adminOverrideAncestor; |
| } |
| if (dimensions != null) { |
| _json['dimensions'] = dimensions; |
| } |
| if (metric != null) { |
| _json['metric'] = metric; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (overrideValue != null) { |
| _json['overrideValue'] = overrideValue; |
| } |
| if (unit != null) { |
| _json['unit'] = unit; |
| } |
| return _json; |
| } |
| } |
| |
| /// Service identity for a service. |
| /// |
| /// This is the identity that service producer should use to access consumer |
| /// resources. |
| class ServiceIdentity { |
| /// The email address of the service account that a service producer would use |
| /// to access consumer resources. |
| core.String email; |
| |
| /// The unique and stable id of the service account. |
| /// |
| /// https://cloud.google.com/iam/reference/rest/v1/projects.serviceAccounts#ServiceAccount |
| core.String uniqueId; |
| |
| ServiceIdentity(); |
| |
| ServiceIdentity.fromJson(core.Map _json) { |
| if (_json.containsKey('email')) { |
| email = _json['email'] as core.String; |
| } |
| if (_json.containsKey('uniqueId')) { |
| uniqueId = _json['uniqueId'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (email != null) { |
| _json['email'] = email; |
| } |
| if (uniqueId != null) { |
| _json['uniqueId'] = uniqueId; |
| } |
| return _json; |
| } |
| } |
| |
| /// `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"`. |
| core.String fileName; |
| |
| SourceContext(); |
| |
| SourceContext.fromJson(core.Map _json) { |
| if (_json.containsKey('fileName')) { |
| fileName = _json['fileName'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (fileName != null) { |
| _json['fileName'] = fileName; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.List<core.Map<core.String, core.Object>> sourceFiles; |
| |
| SourceInfo(); |
| |
| SourceInfo.fromJson(core.Map _json) { |
| if (_json.containsKey('sourceFiles')) { |
| sourceFiles = (_json['sourceFiles'] as core.List) |
| .map<core.Map<core.String, core.Object>>((value) => |
| (value as core.Map).cast<core.String, core.Object>().map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| )) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (sourceFiles != null) { |
| _json['sourceFiles'] = sourceFiles; |
| } |
| return _json; |
| } |
| } |
| |
| /// The `Status` type defines a logical error model that is suitable for |
| /// different programming environments, including REST APIs and RPC APIs. |
| /// |
| /// It is used by [gRPC](https://github.com/grpc). Each `Status` message |
| /// contains three pieces of data: error code, error message, and error details. |
| /// You can find out more about this error model and how to work with it in the |
| /// [API Design Guide](https://cloud.google.com/apis/design/errors). |
| class Status { |
| /// The status code, which should be an enum value of google.rpc.Code. |
| core.int code; |
| |
| /// A list of messages that carry the error details. |
| /// |
| /// There is a common set of message types for APIs to use. |
| /// |
| /// The values for Object must be JSON objects. It can consist of `num`, |
| /// `String`, `bool` and `null` as well as `Map` and `List` values. |
| core.List<core.Map<core.String, core.Object>> details; |
| |
| /// A developer-facing error message, which should be in English. |
| /// |
| /// Any user-facing error message should be localized and sent in the |
| /// google.rpc.Status.details field, or localized by the client. |
| core.String message; |
| |
| Status(); |
| |
| Status.fromJson(core.Map _json) { |
| if (_json.containsKey('code')) { |
| code = _json['code'] as core.int; |
| } |
| if (_json.containsKey('details')) { |
| details = (_json['details'] as core.List) |
| .map<core.Map<core.String, core.Object>>((value) => |
| (value as core.Map).cast<core.String, core.Object>().map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| )) |
| .toList(); |
| } |
| if (_json.containsKey('message')) { |
| message = _json['message'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (code != null) { |
| _json['code'] = code; |
| } |
| if (details != null) { |
| _json['details'] = details; |
| } |
| if (message != null) { |
| _json['message'] = message; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.String httpHeader; |
| |
| /// 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. |
| core.String urlQueryParameter; |
| |
| SystemParameter(); |
| |
| SystemParameter.fromJson(core.Map _json) { |
| if (_json.containsKey('httpHeader')) { |
| httpHeader = _json['httpHeader'] as core.String; |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('urlQueryParameter')) { |
| urlQueryParameter = _json['urlQueryParameter'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (httpHeader != null) { |
| _json['httpHeader'] = httpHeader; |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (urlQueryParameter != null) { |
| _json['urlQueryParameter'] = urlQueryParameter; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| 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. |
| core.String selector; |
| |
| SystemParameterRule(); |
| |
| SystemParameterRule.fromJson(core.Map _json) { |
| if (_json.containsKey('parameters')) { |
| parameters = (_json['parameters'] as core.List) |
| .map<SystemParameter>((value) => SystemParameter.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (parameters != null) { |
| _json['parameters'] = parameters.map((value) => value.toJson()).toList(); |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| return _json; |
| } |
| } |
| |
| /// ### 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. |
| core.List<SystemParameterRule> rules; |
| |
| SystemParameters(); |
| |
| SystemParameters.fromJson(core.Map _json) { |
| if (_json.containsKey('rules')) { |
| rules = (_json['rules'] as core.List) |
| .map<SystemParameterRule>((value) => SystemParameterRule.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (rules != null) { |
| _json['rules'] = rules.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// A protocol buffer message type. |
| class Type { |
| /// The list of fields. |
| core.List<Field> fields; |
| |
| /// The fully qualified message name. |
| core.String name; |
| |
| /// The list of types appearing in `oneof` definitions in this type. |
| core.List<core.String> oneofs; |
| |
| /// The protocol buffer options. |
| core.List<Option> options; |
| |
| /// The source context. |
| SourceContext sourceContext; |
| |
| /// 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'] as core.List) |
| .map<Field>((value) => |
| Field.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| if (_json.containsKey('oneofs')) { |
| oneofs = (_json['oneofs'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('options')) { |
| options = (_json['options'] as core.List) |
| .map<Option>((value) => |
| Option.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('sourceContext')) { |
| sourceContext = SourceContext.fromJson( |
| _json['sourceContext'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('syntax')) { |
| syntax = _json['syntax'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (fields != null) { |
| _json['fields'] = fields.map((value) => value.toJson()).toList(); |
| } |
| if (name != null) { |
| _json['name'] = name; |
| } |
| if (oneofs != null) { |
| _json['oneofs'] = oneofs; |
| } |
| if (options != null) { |
| _json['options'] = options.map((value) => value.toJson()).toList(); |
| } |
| if (sourceContext != null) { |
| _json['sourceContext'] = sourceContext.toJson(); |
| } |
| if (syntax != null) { |
| _json['syntax'] = syntax; |
| } |
| return _json; |
| } |
| } |
| |
| /// 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. |
| core.String producerNotificationChannel; |
| |
| /// Requirements that must be satisfied before a consumer project can use the |
| /// service. |
| /// |
| /// Each requirement is of the form /; for example |
| /// 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of |
| /// Service requirement must be included here. Google Cloud APIs must include |
| /// "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include |
| /// "serviceusage.googleapis.com/tos/universal". Additional ToS can be |
| /// included based on the business needs. |
| 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. |
| core.List<UsageRule> rules; |
| |
| Usage(); |
| |
| Usage.fromJson(core.Map _json) { |
| if (_json.containsKey('producerNotificationChannel')) { |
| producerNotificationChannel = |
| _json['producerNotificationChannel'] as core.String; |
| } |
| if (_json.containsKey('requirements')) { |
| requirements = (_json['requirements'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('rules')) { |
| rules = (_json['rules'] as core.List) |
| .map<UsageRule>((value) => |
| UsageRule.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (producerNotificationChannel != null) { |
| _json['producerNotificationChannel'] = producerNotificationChannel; |
| } |
| if (requirements != null) { |
| _json['requirements'] = requirements; |
| } |
| if (rules != null) { |
| _json['rules'] = rules.map((value) => value.toJson()).toList(); |
| } |
| return _json; |
| } |
| } |
| |
| /// 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 { |
| /// If true, the selected method allows unregistered calls, e.g. calls that |
| /// don't identify any user or application. |
| 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. |
| core.String selector; |
| |
| /// If true, the selected method should skip service control and the control |
| /// plane features, such as quota and billing, will not be available. |
| /// |
| /// This flag is used by Google Cloud Endpoints to bypass checks for internal |
| /// methods, such as service health check methods. |
| core.bool skipServiceControl; |
| |
| UsageRule(); |
| |
| UsageRule.fromJson(core.Map _json) { |
| if (_json.containsKey('allowUnregisteredCalls')) { |
| allowUnregisteredCalls = _json['allowUnregisteredCalls'] as core.bool; |
| } |
| if (_json.containsKey('selector')) { |
| selector = _json['selector'] as core.String; |
| } |
| if (_json.containsKey('skipServiceControl')) { |
| skipServiceControl = _json['skipServiceControl'] as core.bool; |
| } |
| } |
| |
| core.Map<core.String, core.Object> toJson() { |
| final _json = <core.String, core.Object>{}; |
| if (allowUnregisteredCalls != null) { |
| _json['allowUnregisteredCalls'] = allowUnregisteredCalls; |
| } |
| if (selector != null) { |
| _json['selector'] = selector; |
| } |
| if (skipServiceControl != null) { |
| _json['skipServiceControl'] = skipServiceControl; |
| } |
| return _json; |
| } |
| } |