| // 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_interpolation_to_compose_strings |
| // ignore_for_file: unnecessary_brace_in_string_interps |
| // ignore_for_file: unnecessary_lambdas |
| // ignore_for_file: unnecessary_string_interpolations |
| |
| /// Service Management API - v1 |
| /// |
| /// Google Service Management allows service producers to publish their services |
| /// on Google Cloud Platform so that they can be discovered and used by service |
| /// consumers. |
| /// |
| /// For more information, see <https://cloud.google.com/service-management/> |
| /// |
| /// Create an instance of [ServiceManagementApi] to access these resources: |
| /// |
| /// - [OperationsResource] |
| /// - [ServicesResource] |
| /// - [ServicesConfigsResource] |
| /// - [ServicesConsumersResource] |
| /// - [ServicesRolloutsResource] |
| library servicemanagement.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; |
| |
| /// Google Service Management allows service producers to publish their services |
| /// on Google Cloud Platform so that they can be discovered and used by service |
| /// consumers. |
| class ServiceManagementApi { |
| /// View and manage your data across Google Cloud Platform services |
| static const cloudPlatformScope = |
| 'https://www.googleapis.com/auth/cloud-platform'; |
| |
| /// View your data across Google Cloud Platform services |
| static const cloudPlatformReadOnlyScope = |
| 'https://www.googleapis.com/auth/cloud-platform.read-only'; |
| |
| /// Manage your Google API service configuration |
| static const serviceManagementScope = |
| 'https://www.googleapis.com/auth/service.management'; |
| |
| /// View your Google API service configuration |
| static const serviceManagementReadonlyScope = |
| 'https://www.googleapis.com/auth/service.management.readonly'; |
| |
| final commons.ApiRequester _requester; |
| |
| OperationsResource get operations => OperationsResource(_requester); |
| ServicesResource get services => ServicesResource(_requester); |
| |
| ServiceManagementApi(http_1.Client client, |
| {core.String rootUrl = 'https://servicemanagement.googleapis.com/', |
| core.String servicePath = ''}) |
| : _requester = |
| commons.ApiRequester(client, rootUrl, servicePath, requestHeaders); |
| } |
| |
| class OperationsResource { |
| final commons.ApiRequester _requester; |
| |
| OperationsResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Gets the latest state of a long-running operation. |
| /// |
| /// Clients can use this method to poll the operation result at intervals as |
| /// recommended by the API service. |
| /// |
| /// Request parameters: |
| /// |
| /// [name] - The name of the operation resource. |
| /// Value must have pattern `^operations/.*$`. |
| /// |
| /// [$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 { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/' + core.Uri.encodeFull('$name'); |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Lists service operations that match the specified filter in the request. |
| /// |
| /// Request parameters: |
| /// |
| /// [filter] - A string for filtering Operations. The following filter fields |
| /// are supported: * serviceName: Required. Only `=` operator is allowed. * |
| /// startTime: The time this job was started, in ISO 8601 format. Allowed |
| /// operators are `>=`, `>`, `<=`, and `<`. * status: Can be `done`, |
| /// `in_progress`, or `failed`. Allowed operators are `=`, and `!=`. Filter |
| /// expression supports conjunction (AND) and disjunction (OR) logical |
| /// operators. However, the serviceName restriction must be at the top-level |
| /// and can only be combined with other restrictions via the AND logical |
| /// operator. Examples: * `serviceName={some-service}.googleapis.com` * |
| /// `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"` * |
| /// `serviceName={some-service}.googleapis.com AND status=done` * |
| /// `serviceName={some-service}.googleapis.com AND (status=done OR |
| /// startTime>="2017-02-01")` |
| /// |
| /// [name] - Not used. |
| /// |
| /// [pageSize] - The maximum number of operations to return. If unspecified, |
| /// defaults to 50. The maximum value is 100. |
| /// |
| /// [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 { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if (filter != null) 'filter': [filter], |
| if (name != null) 'name': [name], |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const _url = 'v1/operations'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return ListOperationsResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| class ServicesResource { |
| final commons.ApiRequester _requester; |
| |
| ServicesConfigsResource get configs => ServicesConfigsResource(_requester); |
| ServicesConsumersResource get consumers => |
| ServicesConsumersResource(_requester); |
| ServicesRolloutsResource get rollouts => ServicesRolloutsResource(_requester); |
| |
| ServicesResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Creates a new managed service. |
| /// |
| /// A managed service is immutable, and is subject to mandatory 30-day data |
| /// retention. You cannot move a service or recreate it within 30 days after |
| /// deletion. One producer project can own no more than 500 services. For |
| /// security and reliability purposes, a production service should be hosted |
| /// in a dedicated producer project. Operation |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [$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> create( |
| ManagedService request, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const _url = 'v1/services'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Deletes a managed service. |
| /// |
| /// This method will change the service to the `Soft-Delete` state for 30 |
| /// days. Within this period, service producers may call UndeleteService to |
| /// restore the service. After 30 days, the service will be permanently |
| /// deleted. Operation |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [$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> delete( |
| core.String serviceName, { |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/services/' + commons.escapeVariable('$serviceName'); |
| |
| final _response = await _requester.request( |
| _url, |
| 'DELETE', |
| queryParams: _queryParams, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Enables a service for a project, so it can be used for the project. |
| /// |
| /// See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for |
| /// more information. Operation |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. Name of the service to enable. Specifying an |
| /// unknown service name will cause the request to fail. |
| /// |
| /// [$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 serviceName, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/services/' + commons.escapeVariable('$serviceName') + ':enable'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Generates and returns a report (errors, warnings and changes from existing |
| /// configurations) associated with GenerateConfigReportRequest.new_value If |
| /// GenerateConfigReportRequest.old_value is specified, |
| /// GenerateConfigReportRequest will contain a single ChangeReport based on |
| /// the comparison between GenerateConfigReportRequest.new_value and |
| /// GenerateConfigReportRequest.old_value. |
| /// |
| /// If GenerateConfigReportRequest.old_value is not specified, this method |
| /// will compare GenerateConfigReportRequest.new_value with the last pushed |
| /// service configuration. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [GenerateConfigReportResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<GenerateConfigReportResponse> generateConfigReport( |
| GenerateConfigReportRequest request, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const _url = 'v1/services:generateConfigReport'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return GenerateConfigReportResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets a managed service. |
| /// |
| /// Authentication is required unless the service is public. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// `ServiceManager` overview for naming requirements. For example: |
| /// `example.googleapis.com`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ManagedService]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<ManagedService> get( |
| core.String serviceName, { |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/services/' + commons.escapeVariable('$serviceName'); |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return ManagedService.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets a service configuration (version) for a managed service. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [configId] - Required. The id of the service configuration resource. This |
| /// field must be specified for the server to return all fields, including |
| /// `SourceInfo`. |
| /// |
| /// [view] - Specifies which parts of the Service Config should be returned in |
| /// the response. |
| /// Possible string values are: |
| /// - "BASIC" : Server response includes all fields except SourceInfo. |
| /// - "FULL" : Server response includes all fields including SourceInfo. |
| /// SourceFiles are of type 'google.api.servicemanagement.v1.ConfigFile' and |
| /// are only available for configs created using the SubmitConfigSource |
| /// method. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Service]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Service> getConfig( |
| core.String serviceName, { |
| core.String? configId, |
| core.String? view, |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if (configId != null) 'configId': [configId], |
| if (view != null) 'view': [view], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/services/' + commons.escapeVariable('$serviceName') + '/config'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return Service.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets the access control policy for a resource. |
| /// |
| /// Returns an empty policy if the resource exists and does not have a policy |
| /// set. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy is being |
| /// requested. See the operation documentation for the appropriate value for |
| /// this field. |
| /// Value must have pattern `^services/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Policy]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Policy> getIamPolicy( |
| GetIamPolicyRequest request, |
| core.String resource, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/' + core.Uri.encodeFull('$resource') + ':getIamPolicy'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Policy.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Lists managed services. |
| /// |
| /// Returns all public services. For authenticated users, also returns all |
| /// services the calling user has "servicemanagement.services.get" permission |
| /// for. **BETA:** If the caller specifies the `consumer_id`, it returns only |
| /// the services enabled on the consumer. The `consumer_id` must have the |
| /// format of "project:{PROJECT-ID}". |
| /// |
| /// Request parameters: |
| /// |
| /// [consumerId] - Include services consumed by the specified consumer. The |
| /// Google Service Management implementation accepts the following forms: - |
| /// project: |
| /// |
| /// [pageSize] - The max number of items to include in the response list. Page |
| /// size is 50 if not specified. Maximum value is 100. |
| /// |
| /// [pageToken] - Token identifying which result to start with; returned by a |
| /// previous list call. |
| /// |
| /// [producerProjectId] - Include services produced by the specified project. |
| /// |
| /// [$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? consumerId, |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? producerProjectId, |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if (consumerId != null) 'consumerId': [consumerId], |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if (producerProjectId != null) 'producerProjectId': [producerProjectId], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| const _url = 'v1/services'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return ListServicesResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Sets the access control policy on the specified resource. |
| /// |
| /// Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, |
| /// and `PERMISSION_DENIED` errors. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy is being |
| /// specified. See the operation documentation for the appropriate value for |
| /// this field. |
| /// Value must have pattern `^services/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Policy]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Policy> setIamPolicy( |
| SetIamPolicyRequest request, |
| core.String resource, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/' + core.Uri.encodeFull('$resource') + ':setIamPolicy'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Policy.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Returns permissions that a caller has on the specified resource. |
| /// |
| /// If the resource does not exist, this will return an empty set of |
| /// permissions, not a `NOT_FOUND` error. Note: This operation is designed to |
| /// be used for building permission-aware UIs and command-line tools, not for |
| /// authorization checking. This operation may "fail open" without warning. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy detail is being |
| /// requested. See the operation documentation for the appropriate value for |
| /// this field. |
| /// Value must have pattern `^services/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [TestIamPermissionsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<TestIamPermissionsResponse> testIamPermissions( |
| TestIamPermissionsRequest request, |
| core.String resource, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/' + core.Uri.encodeFull('$resource') + ':testIamPermissions'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return TestIamPermissionsResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Revives a previously deleted managed service. |
| /// |
| /// The method restores the service using the configuration at the time the |
| /// service was deleted. The target service must exist and must have been |
| /// deleted within the last 30 days. Operation |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [$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> undelete( |
| core.String serviceName, { |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/services/' + commons.escapeVariable('$serviceName') + ':undelete'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| queryParams: _queryParams, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| class ServicesConfigsResource { |
| final commons.ApiRequester _requester; |
| |
| ServicesConfigsResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Creates a new service configuration (version) for a managed service. |
| /// |
| /// This method only stores the service configuration. To roll out the service |
| /// configuration to backend systems please call CreateServiceRollout. Only |
| /// the 100 most recent service configurations and ones referenced by existing |
| /// rollouts are kept for each service. The rest will be deleted eventually. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Service]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Service> create( |
| Service request, |
| core.String serviceName, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/services/' + commons.escapeVariable('$serviceName') + '/configs'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Service.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets a service configuration (version) for a managed service. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [configId] - Required. The id of the service configuration resource. This |
| /// field must be specified for the server to return all fields, including |
| /// `SourceInfo`. |
| /// |
| /// [view] - Specifies which parts of the Service Config should be returned in |
| /// the response. |
| /// Possible string values are: |
| /// - "BASIC" : Server response includes all fields except SourceInfo. |
| /// - "FULL" : Server response includes all fields including SourceInfo. |
| /// SourceFiles are of type 'google.api.servicemanagement.v1.ConfigFile' and |
| /// are only available for configs created using the SubmitConfigSource |
| /// method. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Service]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Service> get( |
| core.String serviceName, |
| core.String configId, { |
| core.String? view, |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if (view != null) 'view': [view], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/services/' + |
| commons.escapeVariable('$serviceName') + |
| '/configs/' + |
| commons.escapeVariable('$configId'); |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return Service.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Lists the history of the service configuration for a managed service, from |
| /// the newest to the oldest. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [pageSize] - The max number of items to include in the response list. Page |
| /// size is 50 if not specified. Maximum value is 100. |
| /// |
| /// [pageToken] - The token of the page to retrieve. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListServiceConfigsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<ListServiceConfigsResponse> list( |
| core.String serviceName, { |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/services/' + commons.escapeVariable('$serviceName') + '/configs'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return ListServiceConfigsResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Creates a new service configuration (version) for a managed service based |
| /// on user-supplied configuration source files (for example: OpenAPI |
| /// Specification). |
| /// |
| /// This method stores the source configurations as well as the generated |
| /// service configuration. To rollout the service configuration to other |
| /// services, please call CreateServiceRollout. Only the 100 most recent |
| /// configuration sources and ones referenced by existing service |
| /// configurtions are kept for each service. The rest will be deleted |
| /// eventually. Operation |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [$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> submit( |
| SubmitConfigSourceRequest request, |
| core.String serviceName, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/services/' + |
| commons.escapeVariable('$serviceName') + |
| '/configs:submit'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| class ServicesConsumersResource { |
| final commons.ApiRequester _requester; |
| |
| ServicesConsumersResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Gets the access control policy for a resource. |
| /// |
| /// Returns an empty policy if the resource exists and does not have a policy |
| /// set. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy is being |
| /// requested. See the operation documentation for the appropriate value for |
| /// this field. |
| /// Value must have pattern `^services/\[^/\]+/consumers/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Policy]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Policy> getIamPolicy( |
| GetIamPolicyRequest request, |
| core.String resource, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/' + core.Uri.encodeFull('$resource') + ':getIamPolicy'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Policy.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Sets the access control policy on the specified resource. |
| /// |
| /// Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, |
| /// and `PERMISSION_DENIED` errors. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy is being |
| /// specified. See the operation documentation for the appropriate value for |
| /// this field. |
| /// Value must have pattern `^services/\[^/\]+/consumers/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Policy]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Policy> setIamPolicy( |
| SetIamPolicyRequest request, |
| core.String resource, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/' + core.Uri.encodeFull('$resource') + ':setIamPolicy'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Policy.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Returns permissions that a caller has on the specified resource. |
| /// |
| /// If the resource does not exist, this will return an empty set of |
| /// permissions, not a `NOT_FOUND` error. Note: This operation is designed to |
| /// be used for building permission-aware UIs and command-line tools, not for |
| /// authorization checking. This operation may "fail open" without warning. |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [resource] - REQUIRED: The resource for which the policy detail is being |
| /// requested. See the operation documentation for the appropriate value for |
| /// this field. |
| /// Value must have pattern `^services/\[^/\]+/consumers/\[^/\]+$`. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [TestIamPermissionsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<TestIamPermissionsResponse> testIamPermissions( |
| TestIamPermissionsRequest request, |
| core.String resource, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/' + core.Uri.encodeFull('$resource') + ':testIamPermissions'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return TestIamPermissionsResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| class ServicesRolloutsResource { |
| final commons.ApiRequester _requester; |
| |
| ServicesRolloutsResource(commons.ApiRequester client) : _requester = client; |
| |
| /// Creates a new service configuration rollout. |
| /// |
| /// Based on rollout, the Google Service Management will roll out the service |
| /// configurations to different backend services. For example, the logging |
| /// configuration will be pushed to Google Cloud Logging. Please note that any |
| /// previous pending and running Rollouts and associated Operations will be |
| /// automatically cancelled so that the latest Rollout will not be blocked by |
| /// previous Rollouts. Only the 100 most recent (in any state) and the last 10 |
| /// successful (if not already part of the set of 100 most recent) rollouts |
| /// are kept for each service. The rest will be deleted eventually. Operation |
| /// |
| /// [request] - The metadata request object. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [$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> create( |
| Rollout request, |
| core.String serviceName, { |
| core.String? $fields, |
| }) async { |
| final _body = convert.json.encode(request.toJson()); |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/services/' + commons.escapeVariable('$serviceName') + '/rollouts'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'POST', |
| body: _body, |
| queryParams: _queryParams, |
| ); |
| return Operation.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Gets a service configuration rollout. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [rolloutId] - Required. The id of the rollout resource. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [Rollout]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<Rollout> get( |
| core.String serviceName, |
| core.String rolloutId, { |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = 'v1/services/' + |
| commons.escapeVariable('$serviceName') + |
| '/rollouts/' + |
| commons.escapeVariable('$rolloutId'); |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return Rollout.fromJson(_response as core.Map<core.String, core.dynamic>); |
| } |
| |
| /// Lists the history of the service configuration rollouts for a managed |
| /// service, from the newest to the oldest. |
| /// |
| /// Request parameters: |
| /// |
| /// [serviceName] - Required. The name of the service. See the |
| /// \[overview\](/service-management/overview) for naming requirements. For |
| /// example: `example.googleapis.com`. |
| /// |
| /// [filter] - Required. Use `filter` to return subset of rollouts. The |
| /// following filters are supported: -- To limit the results to only those in |
| /// \[status\](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use |
| /// filter='status=SUCCESS' -- To limit the results to those in |
| /// \[status\](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or |
| /// 'FAILED', use filter='status=CANCELLED OR status=FAILED' |
| /// |
| /// [pageSize] - The max number of items to include in the response list. Page |
| /// size is 50 if not specified. Maximum value is 100. |
| /// |
| /// [pageToken] - The token of the page to retrieve. |
| /// |
| /// [$fields] - Selector specifying which fields to include in a partial |
| /// response. |
| /// |
| /// Completes with a [ListServiceRolloutsResponse]. |
| /// |
| /// Completes with a [commons.ApiRequestError] if the API endpoint returned an |
| /// error. |
| /// |
| /// If the used [http_1.Client] completes with an error when making a REST |
| /// call, this method will complete with the same error. |
| async.Future<ListServiceRolloutsResponse> list( |
| core.String serviceName, { |
| core.String? filter, |
| core.int? pageSize, |
| core.String? pageToken, |
| core.String? $fields, |
| }) async { |
| final _queryParams = <core.String, core.List<core.String>>{ |
| if (filter != null) 'filter': [filter], |
| if (pageSize != null) 'pageSize': ['${pageSize}'], |
| if (pageToken != null) 'pageToken': [pageToken], |
| if ($fields != null) 'fields': [$fields], |
| }; |
| |
| final _url = |
| 'v1/services/' + commons.escapeVariable('$serviceName') + '/rollouts'; |
| |
| final _response = await _requester.request( |
| _url, |
| 'GET', |
| queryParams: _queryParams, |
| ); |
| return ListServiceRolloutsResponse.fromJson( |
| _response as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| /// Generated advice about this change, used for providing more information |
| /// about how a change will affect the existing service. |
| class Advice { |
| /// Useful description for why this advice was applied and what actions should |
| /// be taken to mitigate any implied risks. |
| core.String? description; |
| |
| Advice(); |
| |
| Advice.fromJson(core.Map _json) { |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (description != null) 'description': description!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (methods != null) |
| 'methods': methods!.map((value) => value.toJson()).toList(), |
| if (mixins != null) |
| 'mixins': mixins!.map((value) => value.toJson()).toList(), |
| if (name != null) 'name': name!, |
| if (options != null) |
| 'options': options!.map((value) => value.toJson()).toList(), |
| if (sourceContext != null) 'sourceContext': sourceContext!.toJson(), |
| if (syntax != null) 'syntax': syntax!, |
| if (version != null) 'version': version!, |
| }; |
| } |
| |
| /// Specifies the audit configuration for a service. |
| /// |
| /// The configuration determines which permission types are logged, and what |
| /// identities, if any, are exempted from logging. An AuditConfig must have one |
| /// or more AuditLogConfigs. If there are AuditConfigs for both `allServices` |
| /// and a specific service, the union of the two AuditConfigs is used for that |
| /// service: the log_types specified in each AuditConfig are enabled, and the |
| /// exempted_members in each AuditLogConfig are exempted. Example Policy with |
| /// multiple AuditConfigs: { "audit_configs": \[ { "service": "allServices", |
| /// "audit_log_configs": \[ { "log_type": "DATA_READ", "exempted_members": \[ |
| /// "user:jose@example.com" \] }, { "log_type": "DATA_WRITE" }, { "log_type": |
| /// "ADMIN_READ" } \] }, { "service": "sampleservice.googleapis.com", |
| /// "audit_log_configs": \[ { "log_type": "DATA_READ" }, { "log_type": |
| /// "DATA_WRITE", "exempted_members": \[ "user:aliya@example.com" \] } \] } \] } |
| /// For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ |
| /// logging. It also exempts jose@example.com from DATA_READ logging, and |
| /// aliya@example.com from DATA_WRITE logging. |
| class AuditConfig { |
| /// The configuration for logging of each type of permission. |
| core.List<AuditLogConfig>? auditLogConfigs; |
| |
| /// Specifies a service that will be enabled for audit logging. |
| /// |
| /// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. |
| /// `allServices` is a special value that covers all services. |
| core.String? service; |
| |
| AuditConfig(); |
| |
| AuditConfig.fromJson(core.Map _json) { |
| if (_json.containsKey('auditLogConfigs')) { |
| auditLogConfigs = (_json['auditLogConfigs'] as core.List) |
| .map<AuditLogConfig>((value) => AuditLogConfig.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('service')) { |
| service = _json['service'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (auditLogConfigs != null) |
| 'auditLogConfigs': |
| auditLogConfigs!.map((value) => value.toJson()).toList(), |
| if (service != null) 'service': service!, |
| }; |
| } |
| |
| /// Provides the configuration for logging a type of permissions. |
| /// |
| /// Example: { "audit_log_configs": \[ { "log_type": "DATA_READ", |
| /// "exempted_members": \[ "user:jose@example.com" \] }, { "log_type": |
| /// "DATA_WRITE" } \] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while |
| /// exempting jose@example.com from DATA_READ logging. |
| class AuditLogConfig { |
| /// Specifies the identities that do not cause logging for this type of |
| /// permission. |
| /// |
| /// Follows the same format of Binding.members. |
| core.List<core.String>? exemptedMembers; |
| |
| /// The log type that this config enables. |
| /// Possible string values are: |
| /// - "LOG_TYPE_UNSPECIFIED" : Default case. Should never be this. |
| /// - "ADMIN_READ" : Admin reads. Example: CloudIAM getIamPolicy |
| /// - "DATA_WRITE" : Data writes. Example: CloudSQL Users create |
| /// - "DATA_READ" : Data reads. Example: CloudSQL Users list |
| core.String? logType; |
| |
| AuditLogConfig(); |
| |
| AuditLogConfig.fromJson(core.Map _json) { |
| if (_json.containsKey('exemptedMembers')) { |
| exemptedMembers = (_json['exemptedMembers'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('logType')) { |
| logType = _json['logType'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (exemptedMembers != null) 'exemptedMembers': exemptedMembers!, |
| if (logType != null) 'logType': logType!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (audiences != null) 'audiences': audiences!, |
| if (authorizationUrl != null) 'authorizationUrl': authorizationUrl!, |
| if (id != null) 'id': id!, |
| if (issuer != null) 'issuer': issuer!, |
| if (jwksUri != null) 'jwksUri': jwksUri!, |
| if (jwtLocations != null) |
| 'jwtLocations': jwtLocations!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (audiences != null) 'audiences': audiences!, |
| if (providerId != null) 'providerId': providerId!, |
| }; |
| } |
| |
| /// `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.dynamic> toJson() => { |
| if (providers != null) |
| 'providers': providers!.map((value) => value.toJson()).toList(), |
| if (rules != null) |
| 'rules': rules!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (allowWithoutCredential != null) |
| 'allowWithoutCredential': allowWithoutCredential!, |
| if (oauth != null) 'oauth': oauth!.toJson(), |
| if (requirements != null) |
| 'requirements': requirements!.map((value) => value.toJson()).toList(), |
| if (selector != null) 'selector': selector!, |
| }; |
| } |
| |
| /// `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.dynamic> toJson() => { |
| if (rules != null) |
| 'rules': rules!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (address != null) 'address': address!, |
| if (deadline != null) 'deadline': deadline!, |
| if (disableAuth != null) 'disableAuth': disableAuth!, |
| if (jwtAudience != null) 'jwtAudience': jwtAudience!, |
| if (minDeadline != null) 'minDeadline': minDeadline!, |
| if (operationDeadline != null) 'operationDeadline': operationDeadline!, |
| if (pathTranslation != null) 'pathTranslation': pathTranslation!, |
| if (protocol != null) 'protocol': protocol!, |
| if (selector != null) 'selector': selector!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (consumerDestinations != null) |
| 'consumerDestinations': |
| consumerDestinations!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (metrics != null) 'metrics': metrics!, |
| if (monitoredResource != null) 'monitoredResource': monitoredResource!, |
| }; |
| } |
| |
| /// Associates `members` with a `role`. |
| class Binding { |
| /// The condition that is associated with this binding. |
| /// |
| /// If the condition evaluates to `true`, then this binding applies to the |
| /// current request. If the condition evaluates to `false`, then this binding |
| /// does not apply to the current request. However, a different role binding |
| /// might grant the same role to one or more of the members in this binding. |
| /// To learn which resources support conditions in their IAM policies, see the |
| /// [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| Expr? condition; |
| |
| /// Specifies the identities requesting access for a Cloud Platform resource. |
| /// |
| /// `members` can have the following values: * `allUsers`: A special |
| /// identifier that represents anyone who is on the internet; with or without |
| /// a Google account. * `allAuthenticatedUsers`: A special identifier that |
| /// represents anyone who is authenticated with a Google account or a service |
| /// account. * `user:{emailid}`: An email address that represents a specific |
| /// Google account. For example, `alice@example.com` . * |
| /// `serviceAccount:{emailid}`: An email address that represents a service |
| /// account. For example, `my-other-app@appspot.gserviceaccount.com`. * |
| /// `group:{emailid}`: An email address that represents a Google group. For |
| /// example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: |
| /// An email address (plus unique identifier) representing a user that has |
| /// been recently deleted. For example, |
| /// `alice@example.com?uid=123456789012345678901`. If the user is recovered, |
| /// this value reverts to `user:{emailid}` and the recovered user retains the |
| /// role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: |
| /// An email address (plus unique identifier) representing a service account |
| /// that has been recently deleted. For example, |
| /// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If |
| /// the service account is undeleted, this value reverts to |
| /// `serviceAccount:{emailid}` and the undeleted service account retains the |
| /// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email |
| /// address (plus unique identifier) representing a Google group that has been |
| /// recently deleted. For example, |
| /// `admins@example.com?uid=123456789012345678901`. If the group is recovered, |
| /// this value reverts to `group:{emailid}` and the recovered group retains |
| /// the role in the binding. * `domain:{domain}`: The G Suite domain (primary) |
| /// that represents all the users of that domain. For example, `google.com` or |
| /// `example.com`. |
| core.List<core.String>? members; |
| |
| /// Role that is assigned to `members`. |
| /// |
| /// For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| core.String? role; |
| |
| Binding(); |
| |
| Binding.fromJson(core.Map _json) { |
| if (_json.containsKey('condition')) { |
| condition = Expr.fromJson( |
| _json['condition'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('members')) { |
| members = (_json['members'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('role')) { |
| role = _json['role'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (condition != null) 'condition': condition!.toJson(), |
| if (members != null) 'members': members!, |
| if (role != null) 'role': role!, |
| }; |
| } |
| |
| /// Change report associated with a particular service configuration. |
| /// |
| /// It contains a list of ConfigChanges based on the comparison between two |
| /// service configurations. |
| class ChangeReport { |
| /// List of changes between two service configurations. |
| /// |
| /// The changes will be alphabetically sorted based on the identifier of each |
| /// change. A ConfigChange identifier is a dot separated path to the |
| /// configuration. Example: |
| /// visibility.rules\[selector='LibraryService.CreateBook'\].restriction |
| core.List<ConfigChange>? configChanges; |
| |
| ChangeReport(); |
| |
| ChangeReport.fromJson(core.Map _json) { |
| if (_json.containsKey('configChanges')) { |
| configChanges = (_json['configChanges'] as core.List) |
| .map<ConfigChange>((value) => ConfigChange.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (configChanges != null) |
| 'configChanges': |
| configChanges!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// Output generated from semantically comparing two versions of a service |
| /// configuration. |
| /// |
| /// Includes detailed information about a field that have changed with |
| /// applicable advice about potential consequences for the change, such as |
| /// backwards-incompatibility. |
| class ConfigChange { |
| /// Collection of advice provided for this change, useful for determining the |
| /// possible impact of this change. |
| core.List<Advice>? advices; |
| |
| /// The type for this change, either ADDED, REMOVED, or MODIFIED. |
| /// Possible string values are: |
| /// - "CHANGE_TYPE_UNSPECIFIED" : No value was provided. |
| /// - "ADDED" : The changed object exists in the 'new' service configuration, |
| /// but not in the 'old' service configuration. |
| /// - "REMOVED" : The changed object exists in the 'old' service |
| /// configuration, but not in the 'new' service configuration. |
| /// - "MODIFIED" : The changed object exists in both service configurations, |
| /// but its value is different. |
| core.String? changeType; |
| |
| /// Object hierarchy path to the change, with levels separated by a '.' |
| /// character. |
| /// |
| /// For repeated fields, an applicable unique identifier field is used for the |
| /// index (usually selector, name, or id). For maps, the term 'key' is used. |
| /// If the field has no unique identifier, the numeric index is used. |
| /// Examples: - |
| /// visibility.rules\[selector=="google.LibraryService.ListBooks"\].restriction |
| /// - |
| /// quota.metric_rules\[selector=="google"\].metric_costs\[key=="reads"\].value |
| /// - logging.producer_destinations\[0\] |
| core.String? element; |
| |
| /// Value of the changed object in the new Service configuration, in JSON |
| /// format. |
| /// |
| /// This field will not be populated if ChangeType == REMOVED. |
| core.String? newValue; |
| |
| /// Value of the changed object in the old Service configuration, in JSON |
| /// format. |
| /// |
| /// This field will not be populated if ChangeType == ADDED. |
| core.String? oldValue; |
| |
| ConfigChange(); |
| |
| ConfigChange.fromJson(core.Map _json) { |
| if (_json.containsKey('advices')) { |
| advices = (_json['advices'] as core.List) |
| .map<Advice>((value) => |
| Advice.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('changeType')) { |
| changeType = _json['changeType'] as core.String; |
| } |
| if (_json.containsKey('element')) { |
| element = _json['element'] as core.String; |
| } |
| if (_json.containsKey('newValue')) { |
| newValue = _json['newValue'] as core.String; |
| } |
| if (_json.containsKey('oldValue')) { |
| oldValue = _json['oldValue'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (advices != null) |
| 'advices': advices!.map((value) => value.toJson()).toList(), |
| if (changeType != null) 'changeType': changeType!, |
| if (element != null) 'element': element!, |
| if (newValue != null) 'newValue': newValue!, |
| if (oldValue != null) 'oldValue': oldValue!, |
| }; |
| } |
| |
| /// Generic specification of a source configuration file |
| class ConfigFile { |
| /// The bytes that constitute the file. |
| core.String? fileContents; |
| core.List<core.int> get fileContentsAsBytes => |
| convert.base64.decode(fileContents!); |
| |
| set fileContentsAsBytes(core.List<core.int> _bytes) { |
| fileContents = |
| convert.base64.encode(_bytes).replaceAll('/', '_').replaceAll('+', '-'); |
| } |
| |
| /// The file name of the configuration file (full or relative path). |
| core.String? filePath; |
| |
| /// The type of configuration file this represents. |
| /// Possible string values are: |
| /// - "FILE_TYPE_UNSPECIFIED" : Unknown file type. |
| /// - "SERVICE_CONFIG_YAML" : YAML-specification of service. |
| /// - "OPEN_API_JSON" : OpenAPI specification, serialized in JSON. |
| /// - "OPEN_API_YAML" : OpenAPI specification, serialized in YAML. |
| /// - "FILE_DESCRIPTOR_SET_PROTO" : FileDescriptorSet, generated by protoc. To |
| /// generate, use protoc with imports and source info included. For an example |
| /// test.proto file, the following command would put the value in a new file |
| /// named out.pb. $protoc --include_imports --include_source_info test.proto |
| /// -o out.pb |
| /// - "PROTO_FILE" : Uncompiled Proto file. Used for storage and display |
| /// purposes only, currently server-side compilation is not supported. Should |
| /// match the inputs to 'protoc' command used to generated |
| /// FILE_DESCRIPTOR_SET_PROTO. A file of this type can only be included if at |
| /// least one file of type FILE_DESCRIPTOR_SET_PROTO is included. |
| core.String? fileType; |
| |
| ConfigFile(); |
| |
| ConfigFile.fromJson(core.Map _json) { |
| if (_json.containsKey('fileContents')) { |
| fileContents = _json['fileContents'] as core.String; |
| } |
| if (_json.containsKey('filePath')) { |
| filePath = _json['filePath'] as core.String; |
| } |
| if (_json.containsKey('fileType')) { |
| fileType = _json['fileType'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (fileContents != null) 'fileContents': fileContents!, |
| if (filePath != null) 'filePath': filePath!, |
| if (fileType != null) 'fileType': fileType!, |
| }; |
| } |
| |
| /// Represents a service configuration with its name and id. |
| class ConfigRef { |
| /// Resource name of a service config. |
| /// |
| /// It must have the following format: "services/{service |
| /// name}/configs/{config id}". |
| core.String? name; |
| |
| ConfigRef(); |
| |
| ConfigRef.fromJson(core.Map _json) { |
| if (_json.containsKey('name')) { |
| name = _json['name'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (name != null) 'name': name!, |
| }; |
| } |
| |
| /// Represents a source file which is used to generate the service configuration |
| /// defined by `google.api.Service`. |
| class ConfigSource { |
| /// Set of source configuration files that are used to generate a service |
| /// configuration (`google.api.Service`). |
| core.List<ConfigFile>? files; |
| |
| /// A unique ID for a specific instance of this message, typically assigned by |
| /// the client for tracking purpose. |
| /// |
| /// If empty, the server may choose to generate one instead. |
| core.String? id; |
| |
| ConfigSource(); |
| |
| ConfigSource.fromJson(core.Map _json) { |
| if (_json.containsKey('files')) { |
| files = (_json['files'] as core.List) |
| .map<ConfigFile>((value) => |
| ConfigFile.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('id')) { |
| id = _json['id'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (files != null) |
| 'files': files!.map((value) => value.toJson()).toList(), |
| if (id != null) 'id': id!, |
| }; |
| } |
| |
| /// `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.dynamic> toJson() => { |
| if (rules != null) |
| 'rules': rules!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (allowedRequestExtensions != null) |
| 'allowedRequestExtensions': allowedRequestExtensions!, |
| if (allowedResponseExtensions != null) |
| 'allowedResponseExtensions': allowedResponseExtensions!, |
| if (provided != null) 'provided': provided!, |
| if (requested != null) 'requested': requested!, |
| if (selector != null) 'selector': selector!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (environment != null) 'environment': environment!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (rules != null) |
| 'rules': rules!.map((value) => value.toJson()).toList(), |
| if (types != null) 'types': types!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (isErrorType != null) 'isErrorType': isErrorType!, |
| if (selector != null) 'selector': selector!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (kind != null) 'kind': kind!, |
| if (path != null) 'path': path!, |
| }; |
| } |
| |
| /// Strategy used to delete a service. |
| /// |
| /// This strategy is a placeholder only used by the system generated rollout to |
| /// delete a service. |
| class DeleteServiceStrategy { |
| DeleteServiceStrategy(); |
| |
| DeleteServiceStrategy.fromJson( |
| // ignore: avoid_unused_constructor_parameters |
| core.Map _json); |
| |
| core.Map<core.String, core.dynamic> toJson() => {}; |
| } |
| |
| /// Represents a diagnostic message (error or warning) |
| class Diagnostic { |
| /// The kind of diagnostic information provided. |
| /// Possible string values are: |
| /// - "WARNING" : Warnings and errors |
| /// - "ERROR" : Only errors |
| core.String? kind; |
| |
| /// File name and line number of the error or warning. |
| core.String? location; |
| |
| /// Message describing the error or warning. |
| core.String? message; |
| |
| Diagnostic(); |
| |
| Diagnostic.fromJson(core.Map _json) { |
| if (_json.containsKey('kind')) { |
| kind = _json['kind'] as core.String; |
| } |
| if (_json.containsKey('location')) { |
| location = _json['location'] as core.String; |
| } |
| if (_json.containsKey('message')) { |
| message = _json['message'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (kind != null) 'kind': kind!, |
| if (location != null) 'location': location!, |
| if (message != null) 'message': message!, |
| }; |
| } |
| |
| /// Operation payload for DisableService method. |
| class DisableServiceResponse { |
| DisableServiceResponse(); |
| |
| DisableServiceResponse.fromJson( |
| // ignore: avoid_unused_constructor_parameters |
| core.Map _json); |
| |
| core.Map<core.String, core.dynamic> toJson() => {}; |
| } |
| |
| /// `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.dynamic> toJson() => { |
| if (documentationRootUrl != null) |
| 'documentationRootUrl': documentationRootUrl!, |
| if (overview != null) 'overview': overview!, |
| if (pages != null) |
| 'pages': pages!.map((value) => value.toJson()).toList(), |
| if (rules != null) |
| 'rules': rules!.map((value) => value.toJson()).toList(), |
| if (serviceRootUrl != null) 'serviceRootUrl': serviceRootUrl!, |
| if (summary != null) 'summary': summary!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (deprecationDescription != null) |
| 'deprecationDescription': deprecationDescription!, |
| if (description != null) 'description': description!, |
| if (selector != null) 'selector': selector!, |
| }; |
| } |
| |
| /// Request message for EnableService method. |
| class EnableServiceRequest { |
| /// The identity of consumer resource which service enablement will be applied |
| /// to. |
| /// |
| /// The Google Service Management implementation accepts the following forms: |
| /// - "project:" Note: this is made compatible with |
| /// google.api.servicecontrol.v1.Operation.consumer_id. |
| /// |
| /// Required. |
| core.String? consumerId; |
| |
| EnableServiceRequest(); |
| |
| EnableServiceRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('consumerId')) { |
| consumerId = _json['consumerId'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (consumerId != null) 'consumerId': consumerId!, |
| }; |
| } |
| |
| /// Operation payload for EnableService method. |
| class EnableServiceResponse { |
| EnableServiceResponse(); |
| |
| EnableServiceResponse.fromJson( |
| // ignore: avoid_unused_constructor_parameters |
| core.Map _json); |
| |
| core.Map<core.String, core.dynamic> toJson() => {}; |
| } |
| |
| /// `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.dynamic> toJson() => { |
| if (aliases != null) 'aliases': aliases!, |
| if (allowCors != null) 'allowCors': allowCors!, |
| if (name != null) 'name': name!, |
| if (target != null) 'target': target!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (enumvalue != null) |
| 'enumvalue': enumvalue!.map((value) => value.toJson()).toList(), |
| if (name != null) 'name': name!, |
| if (options != null) |
| 'options': options!.map((value) => value.toJson()).toList(), |
| if (sourceContext != null) 'sourceContext': sourceContext!.toJson(), |
| if (syntax != null) 'syntax': syntax!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (name != null) 'name': name!, |
| if (number != null) 'number': number!, |
| if (options != null) |
| 'options': options!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// Represents a textual expression in the Common Expression Language (CEL) |
| /// syntax. |
| /// |
| /// CEL is a C-like expression language. The syntax and semantics of CEL are |
| /// documented at https://github.com/google/cel-spec. Example (Comparison): |
| /// title: "Summary size limit" description: "Determines if a summary is less |
| /// than 100 chars" expression: "document.summary.size() < 100" Example |
| /// (Equality): title: "Requestor is owner" description: "Determines if |
| /// requestor is the document owner" expression: "document.owner == |
| /// request.auth.claims.email" Example (Logic): title: "Public documents" |
| /// description: "Determine whether the document should be publicly visible" |
| /// expression: "document.type != 'private' && document.type != 'internal'" |
| /// Example (Data Manipulation): title: "Notification string" description: |
| /// "Create a notification string with a timestamp." expression: "'New message |
| /// received at ' + string(document.create_time)" The exact variables and |
| /// functions that may be referenced within an expression are determined by the |
| /// service that evaluates it. See the service documentation for additional |
| /// information. |
| class Expr { |
| /// Description of the expression. |
| /// |
| /// This is a longer text which describes the expression, e.g. when hovered |
| /// over it in a UI. |
| /// |
| /// Optional. |
| core.String? description; |
| |
| /// Textual representation of an expression in Common Expression Language |
| /// syntax. |
| core.String? expression; |
| |
| /// String indicating the location of the expression for error reporting, e.g. |
| /// a file name and a position in the file. |
| /// |
| /// Optional. |
| core.String? location; |
| |
| /// Title for the expression, i.e. a short string describing its purpose. |
| /// |
| /// This can be used e.g. in UIs which allow to enter the expression. |
| /// |
| /// Optional. |
| core.String? title; |
| |
| Expr(); |
| |
| Expr.fromJson(core.Map _json) { |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| if (_json.containsKey('expression')) { |
| expression = _json['expression'] as core.String; |
| } |
| if (_json.containsKey('location')) { |
| location = _json['location'] as core.String; |
| } |
| if (_json.containsKey('title')) { |
| title = _json['title'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (description != null) 'description': description!, |
| if (expression != null) 'expression': expression!, |
| if (location != null) 'location': location!, |
| if (title != null) 'title': title!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (cardinality != null) 'cardinality': cardinality!, |
| if (defaultValue != null) 'defaultValue': defaultValue!, |
| if (jsonName != null) 'jsonName': jsonName!, |
| if (kind != null) 'kind': kind!, |
| if (name != null) 'name': name!, |
| if (number != null) 'number': number!, |
| if (oneofIndex != null) 'oneofIndex': oneofIndex!, |
| if (options != null) |
| 'options': options!.map((value) => value.toJson()).toList(), |
| if (packed != null) 'packed': packed!, |
| if (typeUrl != null) 'typeUrl': typeUrl!, |
| }; |
| } |
| |
| /// Encapsulation of flow-specific error details for debugging. |
| /// |
| /// Used as a details field on an error Status, not intended for external use. |
| class FlowErrorDetails { |
| /// The type of exception (as a class name). |
| core.String? exceptionType; |
| |
| /// The step that failed. |
| core.String? flowStepId; |
| |
| FlowErrorDetails(); |
| |
| FlowErrorDetails.fromJson(core.Map _json) { |
| if (_json.containsKey('exceptionType')) { |
| exceptionType = _json['exceptionType'] as core.String; |
| } |
| if (_json.containsKey('flowStepId')) { |
| flowStepId = _json['flowStepId'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (exceptionType != null) 'exceptionType': exceptionType!, |
| if (flowStepId != null) 'flowStepId': flowStepId!, |
| }; |
| } |
| |
| /// Request message for GenerateConfigReport method. |
| class GenerateConfigReportRequest { |
| /// Service configuration for which we want to generate the report. |
| /// |
| /// For this version of API, the supported types are |
| /// google.api.servicemanagement.v1.ConfigRef, |
| /// google.api.servicemanagement.v1.ConfigSource, and google.api.Service |
| /// |
| /// Required. |
| /// |
| /// The values for Object must be JSON objects. It can consist of `num`, |
| /// `String`, `bool` and `null` as well as `Map` and `List` values. |
| core.Map<core.String, core.Object>? newConfig; |
| |
| /// Service configuration against which the comparison will be done. |
| /// |
| /// For this version of API, the supported types are |
| /// google.api.servicemanagement.v1.ConfigRef, |
| /// google.api.servicemanagement.v1.ConfigSource, and google.api.Service |
| /// |
| /// Optional. |
| /// |
| /// The values for Object must be JSON objects. It can consist of `num`, |
| /// `String`, `bool` and `null` as well as `Map` and `List` values. |
| core.Map<core.String, core.Object>? oldConfig; |
| |
| GenerateConfigReportRequest(); |
| |
| GenerateConfigReportRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('newConfig')) { |
| newConfig = |
| (_json['newConfig'] as core.Map<core.String, core.dynamic>).map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| ); |
| } |
| if (_json.containsKey('oldConfig')) { |
| oldConfig = |
| (_json['oldConfig'] as core.Map<core.String, core.dynamic>).map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| ); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (newConfig != null) 'newConfig': newConfig!, |
| if (oldConfig != null) 'oldConfig': oldConfig!, |
| }; |
| } |
| |
| /// Response message for GenerateConfigReport method. |
| class GenerateConfigReportResponse { |
| /// list of ChangeReport, each corresponding to comparison between two service |
| /// configurations. |
| core.List<ChangeReport>? changeReports; |
| |
| /// Errors / Linter warnings associated with the service definition this |
| /// report belongs to. |
| core.List<Diagnostic>? diagnostics; |
| |
| /// ID of the service configuration this report belongs to. |
| core.String? id; |
| |
| /// Name of the service this report belongs to. |
| core.String? serviceName; |
| |
| GenerateConfigReportResponse(); |
| |
| GenerateConfigReportResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('changeReports')) { |
| changeReports = (_json['changeReports'] as core.List) |
| .map<ChangeReport>((value) => ChangeReport.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('diagnostics')) { |
| diagnostics = (_json['diagnostics'] as core.List) |
| .map<Diagnostic>((value) => |
| Diagnostic.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('id')) { |
| id = _json['id'] as core.String; |
| } |
| if (_json.containsKey('serviceName')) { |
| serviceName = _json['serviceName'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (changeReports != null) |
| 'changeReports': |
| changeReports!.map((value) => value.toJson()).toList(), |
| if (diagnostics != null) |
| 'diagnostics': diagnostics!.map((value) => value.toJson()).toList(), |
| if (id != null) 'id': id!, |
| if (serviceName != null) 'serviceName': serviceName!, |
| }; |
| } |
| |
| /// Request message for `GetIamPolicy` method. |
| class GetIamPolicyRequest { |
| /// OPTIONAL: A `GetPolicyOptions` object for specifying options to |
| /// `GetIamPolicy`. |
| GetPolicyOptions? options; |
| |
| GetIamPolicyRequest(); |
| |
| GetIamPolicyRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('options')) { |
| options = GetPolicyOptions.fromJson( |
| _json['options'] as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (options != null) 'options': options!.toJson(), |
| }; |
| } |
| |
| /// Encapsulates settings provided to GetIamPolicy. |
| class GetPolicyOptions { |
| /// The policy format version to be returned. |
| /// |
| /// Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| /// rejected. Requests for policies with any conditional bindings must specify |
| /// version 3. Policies without any conditional bindings may specify any valid |
| /// value or leave the field unset. To learn which resources support |
| /// conditions in their IAM policies, see the |
| /// [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| /// |
| /// Optional. |
| core.int? requestedPolicyVersion; |
| |
| GetPolicyOptions(); |
| |
| GetPolicyOptions.fromJson(core.Map _json) { |
| if (_json.containsKey('requestedPolicyVersion')) { |
| requestedPolicyVersion = _json['requestedPolicyVersion'] as core.int; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (requestedPolicyVersion != null) |
| 'requestedPolicyVersion': requestedPolicyVersion!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (fullyDecodeReservedExpansion != null) |
| 'fullyDecodeReservedExpansion': fullyDecodeReservedExpansion!, |
| if (rules != null) |
| 'rules': rules!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// # 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.dynamic> toJson() => { |
| if (additionalBindings != null) |
| 'additionalBindings': |
| additionalBindings!.map((value) => value.toJson()).toList(), |
| if (body != null) 'body': body!, |
| if (custom != null) 'custom': custom!.toJson(), |
| if (delete != null) 'delete': delete!, |
| if (get != null) 'get': get!, |
| if (patch != null) 'patch': patch!, |
| if (post != null) 'post': post!, |
| if (put != null) 'put': put!, |
| if (responseBody != null) 'responseBody': responseBody!, |
| if (selector != null) 'selector': selector!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (header != null) 'header': header!, |
| if (query != null) 'query': query!, |
| if (valuePrefix != null) 'valuePrefix': valuePrefix!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (description != null) 'description': description!, |
| if (key != null) 'key': key!, |
| if (valueType != null) 'valueType': valueType!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| if (operations != null) |
| 'operations': operations!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// Response message for ListServiceConfigs method. |
| class ListServiceConfigsResponse { |
| /// The token of the next page of results. |
| core.String? nextPageToken; |
| |
| /// The list of service configuration resources. |
| core.List<Service>? serviceConfigs; |
| |
| ListServiceConfigsResponse(); |
| |
| ListServiceConfigsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| if (_json.containsKey('serviceConfigs')) { |
| serviceConfigs = (_json['serviceConfigs'] as core.List) |
| .map<Service>((value) => |
| Service.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| if (serviceConfigs != null) |
| 'serviceConfigs': |
| serviceConfigs!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// Response message for ListServiceRollouts method. |
| class ListServiceRolloutsResponse { |
| /// The token of the next page of results. |
| core.String? nextPageToken; |
| |
| /// The list of rollout resources. |
| core.List<Rollout>? rollouts; |
| |
| ListServiceRolloutsResponse(); |
| |
| ListServiceRolloutsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('nextPageToken')) { |
| nextPageToken = _json['nextPageToken'] as core.String; |
| } |
| if (_json.containsKey('rollouts')) { |
| rollouts = (_json['rollouts'] as core.List) |
| .map<Rollout>((value) => |
| Rollout.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| if (rollouts != null) |
| 'rollouts': rollouts!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// Response message for `ListServices` method. |
| class ListServicesResponse { |
| /// Token that can be passed to `ListServices` to resume a paginated query. |
| core.String? nextPageToken; |
| |
| /// The returned services will only have the name field set. |
| core.List<ManagedService>? 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<ManagedService>((value) => ManagedService.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (nextPageToken != null) 'nextPageToken': nextPageToken!, |
| if (services != null) |
| 'services': services!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (description != null) 'description': description!, |
| if (displayName != null) 'displayName': displayName!, |
| if (labels != null) |
| 'labels': labels!.map((value) => value.toJson()).toList(), |
| if (name != null) 'name': name!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (consumerDestinations != null) |
| 'consumerDestinations': |
| consumerDestinations!.map((value) => value.toJson()).toList(), |
| if (producerDestinations != null) |
| 'producerDestinations': |
| producerDestinations!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (logs != null) 'logs': logs!, |
| if (monitoredResource != null) 'monitoredResource': monitoredResource!, |
| }; |
| } |
| |
| /// The full representation of a Service that is managed by Google Service |
| /// Management. |
| class ManagedService { |
| /// ID of the project that produces and owns this service. |
| core.String? producerProjectId; |
| |
| /// The name of the service. |
| /// |
| /// See the \[overview\](/service-management/overview) for naming |
| /// requirements. |
| core.String? serviceName; |
| |
| ManagedService(); |
| |
| ManagedService.fromJson(core.Map _json) { |
| if (_json.containsKey('producerProjectId')) { |
| producerProjectId = _json['producerProjectId'] as core.String; |
| } |
| if (_json.containsKey('serviceName')) { |
| serviceName = _json['serviceName'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (producerProjectId != null) 'producerProjectId': producerProjectId!, |
| if (serviceName != null) 'serviceName': serviceName!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (name != null) 'name': name!, |
| if (options != null) |
| 'options': options!.map((value) => value.toJson()).toList(), |
| if (requestStreaming != null) 'requestStreaming': requestStreaming!, |
| if (requestTypeUrl != null) 'requestTypeUrl': requestTypeUrl!, |
| if (responseStreaming != null) 'responseStreaming': responseStreaming!, |
| if (responseTypeUrl != null) 'responseTypeUrl': responseTypeUrl!, |
| if (syntax != null) 'syntax': syntax!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (description != null) 'description': description!, |
| if (displayName != null) 'displayName': displayName!, |
| if (labels != null) |
| 'labels': labels!.map((value) => value.toJson()).toList(), |
| if (launchStage != null) 'launchStage': launchStage!, |
| if (metadata != null) 'metadata': metadata!.toJson(), |
| if (metricKind != null) 'metricKind': metricKind!, |
| if (monitoredResourceTypes != null) |
| 'monitoredResourceTypes': monitoredResourceTypes!, |
| if (name != null) 'name': name!, |
| if (type != null) 'type': type!, |
| if (unit != null) 'unit': unit!, |
| if (valueType != null) 'valueType': valueType!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (ingestDelay != null) 'ingestDelay': ingestDelay!, |
| if (launchStage != null) 'launchStage': launchStage!, |
| if (samplePeriod != null) 'samplePeriod': samplePeriod!, |
| }; |
| } |
| |
| /// 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<core.String, core.dynamic>).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.dynamic> toJson() => { |
| if (metricCosts != null) 'metricCosts': metricCosts!, |
| if (selector != null) 'selector': selector!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (name != null) 'name': name!, |
| if (root != null) 'root': root!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (description != null) 'description': description!, |
| if (displayName != null) 'displayName': displayName!, |
| if (labels != null) |
| 'labels': labels!.map((value) => value.toJson()).toList(), |
| if (launchStage != null) 'launchStage': launchStage!, |
| if (name != null) 'name': name!, |
| if (type != null) 'type': type!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (consumerDestinations != null) |
| 'consumerDestinations': |
| consumerDestinations!.map((value) => value.toJson()).toList(), |
| if (producerDestinations != null) |
| 'producerDestinations': |
| producerDestinations!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (metrics != null) 'metrics': metrics!, |
| if (monitoredResource != null) 'monitoredResource': monitoredResource!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (canonicalScopes != null) 'canonicalScopes': canonicalScopes!, |
| }; |
| } |
| |
| /// 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<core.String, core.dynamic>).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<core.String, core.dynamic>).map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| ); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (done != null) 'done': done!, |
| if (error != null) 'error': error!.toJson(), |
| if (metadata != null) 'metadata': metadata!, |
| if (name != null) 'name': name!, |
| if (response != null) 'response': response!, |
| }; |
| } |
| |
| /// The metadata associated with a long running operation resource. |
| class OperationMetadata { |
| /// Percentage of completion of this operation, ranging from 0 to 100. |
| core.int? progressPercentage; |
| |
| /// The full name of the resources that this operation is directly associated |
| /// with. |
| core.List<core.String>? resourceNames; |
| |
| /// The start time of the operation. |
| core.String? startTime; |
| |
| /// Detailed status information for each step. |
| /// |
| /// The order is undetermined. |
| core.List<Step>? steps; |
| |
| OperationMetadata(); |
| |
| OperationMetadata.fromJson(core.Map _json) { |
| if (_json.containsKey('progressPercentage')) { |
| progressPercentage = _json['progressPercentage'] as core.int; |
| } |
| if (_json.containsKey('resourceNames')) { |
| resourceNames = (_json['resourceNames'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| if (_json.containsKey('startTime')) { |
| startTime = _json['startTime'] as core.String; |
| } |
| if (_json.containsKey('steps')) { |
| steps = (_json['steps'] as core.List) |
| .map<Step>((value) => |
| Step.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (progressPercentage != null) |
| 'progressPercentage': progressPercentage!, |
| if (resourceNames != null) 'resourceNames': resourceNames!, |
| if (startTime != null) 'startTime': startTime!, |
| if (steps != null) |
| 'steps': steps!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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<core.String, core.dynamic>).map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| ); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (name != null) 'name': name!, |
| if (value != null) 'value': value!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (content != null) 'content': content!, |
| if (name != null) 'name': name!, |
| if (subpages != null) |
| 'subpages': subpages!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// An Identity and Access Management (IAM) policy, which specifies access |
| /// controls for Google Cloud resources. |
| /// |
| /// A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| /// `members` to a single `role`. Members can be user accounts, service |
| /// accounts, Google groups, and domains (such as G Suite). A `role` is a named |
| /// list of permissions; each `role` can be an IAM predefined role or a |
| /// user-created custom role. For some types of Google Cloud resources, a |
| /// `binding` can also specify a `condition`, which is a logical expression that |
| /// allows access to a resource only if the expression evaluates to `true`. A |
| /// condition can add constraints based on attributes of the request, the |
| /// resource, or both. To learn which resources support conditions in their IAM |
| /// policies, see the |
| /// [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| /// **JSON example:** { "bindings": \[ { "role": |
| /// "roles/resourcemanager.organizationAdmin", "members": \[ |
| /// "user:mike@example.com", "group:admins@example.com", "domain:google.com", |
| /// "serviceAccount:my-project-id@appspot.gserviceaccount.com" \] }, { "role": |
| /// "roles/resourcemanager.organizationViewer", "members": \[ |
| /// "user:eve@example.com" \], "condition": { "title": "expirable access", |
| /// "description": "Does not grant access after Sep 2020", "expression": |
| /// "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } \], "etag": |
| /// "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - |
| /// user:mike@example.com - group:admins@example.com - domain:google.com - |
| /// serviceAccount:my-project-id@appspot.gserviceaccount.com role: |
| /// roles/resourcemanager.organizationAdmin - members: - user:eve@example.com |
| /// role: roles/resourcemanager.organizationViewer condition: title: expirable |
| /// access description: Does not grant access after Sep 2020 expression: |
| /// request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - |
| /// version: 3 For a description of IAM and its features, see the |
| /// [IAM documentation](https://cloud.google.com/iam/docs/). |
| class Policy { |
| /// Specifies cloud audit logging configuration for this policy. |
| core.List<AuditConfig>? auditConfigs; |
| |
| /// Associates a list of `members` to a `role`. |
| /// |
| /// Optionally, may specify a `condition` that determines how and when the |
| /// `bindings` are applied. Each of the `bindings` must contain at least one |
| /// member. |
| core.List<Binding>? bindings; |
| |
| /// `etag` is used for optimistic concurrency control as a way to help prevent |
| /// simultaneous updates of a policy from overwriting each other. |
| /// |
| /// It is strongly suggested that systems make use of the `etag` in the |
| /// read-modify-write cycle to perform policy updates in order to avoid race |
| /// conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| /// systems are expected to put that etag in the request to `setIamPolicy` to |
| /// ensure that their change will be applied to the same version of the |
| /// policy. **Important:** If you use IAM Conditions, you must include the |
| /// `etag` field whenever you call `setIamPolicy`. If you omit this field, |
| /// then IAM allows you to overwrite a version `3` policy with a version `1` |
| /// policy, and all of the conditions in the version `3` policy are lost. |
| core.String? etag; |
| core.List<core.int> get etagAsBytes => convert.base64.decode(etag!); |
| |
| set etagAsBytes(core.List<core.int> _bytes) { |
| etag = |
| convert.base64.encode(_bytes).replaceAll('/', '_').replaceAll('+', '-'); |
| } |
| |
| /// Specifies the format of the policy. |
| /// |
| /// Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| /// are rejected. Any operation that affects conditional role bindings must |
| /// specify version `3`. This requirement applies to the following operations: |
| /// * Getting a policy that includes a conditional role binding * Adding a |
| /// conditional role binding to a policy * Changing a conditional role binding |
| /// in a policy * Removing any role binding, with or without a condition, from |
| /// a policy that includes conditions **Important:** If you use IAM |
| /// Conditions, you must include the `etag` field whenever you call |
| /// `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a |
| /// version `3` policy with a version `1` policy, and all of the conditions in |
| /// the version `3` policy are lost. If a policy does not include any |
| /// conditions, operations on that policy may specify any valid version or |
| /// leave the field unset. To learn which resources support conditions in |
| /// their IAM policies, see the |
| /// [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| core.int? version; |
| |
| Policy(); |
| |
| Policy.fromJson(core.Map _json) { |
| if (_json.containsKey('auditConfigs')) { |
| auditConfigs = (_json['auditConfigs'] as core.List) |
| .map<AuditConfig>((value) => AuditConfig.fromJson( |
| value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('bindings')) { |
| bindings = (_json['bindings'] as core.List) |
| .map<Binding>((value) => |
| Binding.fromJson(value as core.Map<core.String, core.dynamic>)) |
| .toList(); |
| } |
| if (_json.containsKey('etag')) { |
| etag = _json['etag'] as core.String; |
| } |
| if (_json.containsKey('version')) { |
| version = _json['version'] as core.int; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (auditConfigs != null) |
| 'auditConfigs': auditConfigs!.map((value) => value.toJson()).toList(), |
| if (bindings != null) |
| 'bindings': bindings!.map((value) => value.toJson()).toList(), |
| if (etag != null) 'etag': etag!, |
| if (version != null) 'version': version!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (limits != null) |
| 'limits': limits!.map((value) => value.toJson()).toList(), |
| if (metricRules != null) |
| 'metricRules': metricRules!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// `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<core.String, core.dynamic>).map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.String, |
| ), |
| ); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (defaultLimit != null) 'defaultLimit': defaultLimit!, |
| if (description != null) 'description': description!, |
| if (displayName != null) 'displayName': displayName!, |
| if (duration != null) 'duration': duration!, |
| if (freeTier != null) 'freeTier': freeTier!, |
| if (maxLimit != null) 'maxLimit': maxLimit!, |
| if (metric != null) 'metric': metric!, |
| if (name != null) 'name': name!, |
| if (unit != null) 'unit': unit!, |
| if (values != null) 'values': values!, |
| }; |
| } |
| |
| /// Defines a proto annotation that describes a string field that refers to an |
| /// API resource. |
| class ResourceReference { |
| /// The resource type of a child collection that the annotated field |
| /// references. |
| /// |
| /// This is useful for annotating the `parent` field that doesn't have a fixed |
| /// resource type. Example: message ListLogEntriesRequest { string parent = 1 |
| /// \[(google.api.resource_reference) = { child_type: |
| /// "logging.googleapis.com/LogEntry" }; } |
| core.String? childType; |
| |
| /// The resource type that the annotated field references. |
| /// |
| /// Example: message Subscription { string topic = 2 |
| /// \[(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" |
| /// }\]; } Occasionally, a field may reference an arbitrary resource. In this |
| /// case, APIs use the special value * in their resource reference. Example: |
| /// message GetIamPolicyRequest { string resource = 2 |
| /// \[(google.api.resource_reference) = { type: "*" }\]; } |
| core.String? type; |
| |
| ResourceReference(); |
| |
| ResourceReference.fromJson(core.Map _json) { |
| if (_json.containsKey('childType')) { |
| childType = _json['childType'] as core.String; |
| } |
| if (_json.containsKey('type')) { |
| type = _json['type'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (childType != null) 'childType': childType!, |
| if (type != null) 'type': type!, |
| }; |
| } |
| |
| /// A rollout resource that defines how service configuration versions are |
| /// pushed to control plane systems. |
| /// |
| /// Typically, you create a new version of the service config, and then create a |
| /// Rollout to push the service config. |
| class Rollout { |
| /// Creation time of the rollout. |
| /// |
| /// Readonly. |
| core.String? createTime; |
| |
| /// This field is deprecated and will be deleted. |
| /// |
| /// Please remove usage of this field. |
| core.String? createdBy; |
| |
| /// The strategy associated with a rollout to delete a `ManagedService`. |
| /// |
| /// Readonly. |
| DeleteServiceStrategy? deleteServiceStrategy; |
| |
| /// Unique identifier of this Rollout. |
| /// |
| /// Must be no longer than 63 characters and only lower case letters, digits, |
| /// '.', '_' and '-' are allowed. If not specified by client, the server will |
| /// generate one. The generated id will have the form of , where "date" is the |
| /// create date in ISO 8601 format. "revision number" is a monotonically |
| /// increasing positive number that is reset every day for each service. An |
| /// example of the generated rollout_id is '2016-02-16r1' |
| /// |
| /// Optional. |
| core.String? rolloutId; |
| |
| /// The name of the service associated with this Rollout. |
| core.String? serviceName; |
| |
| /// The status of this rollout. |
| /// |
| /// Readonly. In case of a failed rollout, the system will automatically |
| /// rollback to the current Rollout version. Readonly. |
| /// Possible string values are: |
| /// - "ROLLOUT_STATUS_UNSPECIFIED" : No status specified. |
| /// - "IN_PROGRESS" : The Rollout is in progress. |
| /// - "SUCCESS" : The Rollout has completed successfully. |
| /// - "CANCELLED" : The Rollout has been cancelled. This can happen if you |
| /// have overlapping Rollout pushes, and the previous ones will be cancelled. |
| /// - "FAILED" : The Rollout has failed and the rollback attempt has failed |
| /// too. |
| /// - "PENDING" : The Rollout has not started yet and is pending for |
| /// execution. |
| /// - "FAILED_ROLLED_BACK" : The Rollout has failed and rolled back to the |
| /// previous successful Rollout. |
| core.String? status; |
| |
| /// Google Service Control selects service configurations based on traffic |
| /// percentage. |
| TrafficPercentStrategy? trafficPercentStrategy; |
| |
| Rollout(); |
| |
| Rollout.fromJson(core.Map _json) { |
| if (_json.containsKey('createTime')) { |
| createTime = _json['createTime'] as core.String; |
| } |
| if (_json.containsKey('createdBy')) { |
| createdBy = _json['createdBy'] as core.String; |
| } |
| if (_json.containsKey('deleteServiceStrategy')) { |
| deleteServiceStrategy = DeleteServiceStrategy.fromJson( |
| _json['deleteServiceStrategy'] |
| as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('rolloutId')) { |
| rolloutId = _json['rolloutId'] as core.String; |
| } |
| if (_json.containsKey('serviceName')) { |
| serviceName = _json['serviceName'] as core.String; |
| } |
| if (_json.containsKey('status')) { |
| status = _json['status'] as core.String; |
| } |
| if (_json.containsKey('trafficPercentStrategy')) { |
| trafficPercentStrategy = TrafficPercentStrategy.fromJson( |
| _json['trafficPercentStrategy'] |
| as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (createTime != null) 'createTime': createTime!, |
| if (createdBy != null) 'createdBy': createdBy!, |
| if (deleteServiceStrategy != null) |
| 'deleteServiceStrategy': deleteServiceStrategy!.toJson(), |
| if (rolloutId != null) 'rolloutId': rolloutId!, |
| if (serviceName != null) 'serviceName': serviceName!, |
| if (status != null) 'status': status!, |
| if (trafficPercentStrategy != null) |
| 'trafficPercentStrategy': trafficPercentStrategy!.toJson(), |
| }; |
| } |
| |
| /// `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 name: calendar.googleapis.com |
| /// title: Google Calendar API apis: - name: google.calendar.v3.Calendar |
| /// authentication: providers: - id: google_calendar_auth jwks_uri: |
| /// https://www.googleapis.com/oauth2/v1/certs issuer: |
| /// https://securetoken.google.com rules: - selector: "*" requirements: |
| /// provider_id: google_calendar_auth |
| class Service { |
| /// A list of API interfaces exported by this service. |
| /// |
| /// Only the `name` field of the google.protobuf.Api needs to be provided by |
| /// the configuration author, as the remaining fields will be derived from the |
| /// IDL during the normalization process. It is an error to specify an API |
| /// interface here which cannot be resolved against the associated IDL files. |
| 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; |
| |
| Service(); |
| |
| Service.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.dynamic> toJson() => { |
| if (apis != null) 'apis': apis!.map((value) => value.toJson()).toList(), |
| if (authentication != null) 'authentication': authentication!.toJson(), |
| if (backend != null) 'backend': backend!.toJson(), |
| if (billing != null) 'billing': billing!.toJson(), |
| if (configVersion != null) 'configVersion': configVersion!, |
| if (context != null) 'context': context!.toJson(), |
| if (control != null) 'control': control!.toJson(), |
| if (customError != null) 'customError': customError!.toJson(), |
| if (documentation != null) 'documentation': documentation!.toJson(), |
| if (endpoints != null) |
| 'endpoints': endpoints!.map((value) => value.toJson()).toList(), |
| if (enums != null) |
| 'enums': enums!.map((value) => value.toJson()).toList(), |
| if (http != null) 'http': http!.toJson(), |
| if (id != null) 'id': id!, |
| if (logging != null) 'logging': logging!.toJson(), |
| if (logs != null) 'logs': logs!.map((value) => value.toJson()).toList(), |
| if (metrics != null) |
| 'metrics': metrics!.map((value) => value.toJson()).toList(), |
| if (monitoredResources != null) |
| 'monitoredResources': |
| monitoredResources!.map((value) => value.toJson()).toList(), |
| if (monitoring != null) 'monitoring': monitoring!.toJson(), |
| if (name != null) 'name': name!, |
| if (producerProjectId != null) 'producerProjectId': producerProjectId!, |
| if (quota != null) 'quota': quota!.toJson(), |
| if (sourceInfo != null) 'sourceInfo': sourceInfo!.toJson(), |
| if (systemParameters != null) |
| 'systemParameters': systemParameters!.toJson(), |
| if (systemTypes != null) |
| 'systemTypes': systemTypes!.map((value) => value.toJson()).toList(), |
| if (title != null) 'title': title!, |
| if (types != null) |
| 'types': types!.map((value) => value.toJson()).toList(), |
| if (usage != null) 'usage': usage!.toJson(), |
| }; |
| } |
| |
| /// Request message for `SetIamPolicy` method. |
| class SetIamPolicyRequest { |
| /// REQUIRED: The complete policy to be applied to the `resource`. |
| /// |
| /// The size of the policy is limited to a few 10s of KB. An empty policy is a |
| /// valid policy but certain Cloud Platform services (such as Projects) might |
| /// reject them. |
| Policy? policy; |
| |
| /// OPTIONAL: A FieldMask specifying which fields of the policy to modify. |
| /// |
| /// Only the fields in the mask will be modified. If no mask is provided, the |
| /// following default mask is used: `paths: "bindings, etag"` |
| core.String? updateMask; |
| |
| SetIamPolicyRequest(); |
| |
| SetIamPolicyRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('policy')) { |
| policy = Policy.fromJson( |
| _json['policy'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('updateMask')) { |
| updateMask = _json['updateMask'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (policy != null) 'policy': policy!.toJson(), |
| if (updateMask != null) 'updateMask': updateMask!, |
| }; |
| } |
| |
| /// `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.dynamic> toJson() => { |
| if (fileName != null) 'fileName': fileName!, |
| }; |
| } |
| |
| /// 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<core.String, core.dynamic>).map( |
| (key, item) => core.MapEntry( |
| key, |
| item as core.Object, |
| ), |
| )) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (sourceFiles != null) 'sourceFiles': sourceFiles!, |
| }; |
| } |
| |
| /// 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<core.String, core.dynamic>).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.dynamic> toJson() => { |
| if (code != null) 'code': code!, |
| if (details != null) 'details': details!, |
| if (message != null) 'message': message!, |
| }; |
| } |
| |
| /// Represents the status of one operation step. |
| class Step { |
| /// The short description of the step. |
| core.String? description; |
| |
| /// The status code. |
| /// Possible string values are: |
| /// - "STATUS_UNSPECIFIED" : Unspecifed code. |
| /// - "DONE" : The operation or step has completed without errors. |
| /// - "NOT_STARTED" : The operation or step has not started yet. |
| /// - "IN_PROGRESS" : The operation or step is in progress. |
| /// - "FAILED" : The operation or step has completed with errors. If the |
| /// operation is rollbackable, the rollback completed with errors too. |
| /// - "CANCELLED" : The operation or step has completed with cancellation. |
| core.String? status; |
| |
| Step(); |
| |
| Step.fromJson(core.Map _json) { |
| if (_json.containsKey('description')) { |
| description = _json['description'] as core.String; |
| } |
| if (_json.containsKey('status')) { |
| status = _json['status'] as core.String; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (description != null) 'description': description!, |
| if (status != null) 'status': status!, |
| }; |
| } |
| |
| /// Request message for SubmitConfigSource method. |
| class SubmitConfigSourceRequest { |
| /// The source configuration for the service. |
| /// |
| /// Required. |
| ConfigSource? configSource; |
| |
| /// If set, this will result in the generation of a `google.api.Service` |
| /// configuration based on the `ConfigSource` provided, but the generated |
| /// config and the sources will NOT be persisted. |
| /// |
| /// Optional. |
| core.bool? validateOnly; |
| |
| SubmitConfigSourceRequest(); |
| |
| SubmitConfigSourceRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('configSource')) { |
| configSource = ConfigSource.fromJson( |
| _json['configSource'] as core.Map<core.String, core.dynamic>); |
| } |
| if (_json.containsKey('validateOnly')) { |
| validateOnly = _json['validateOnly'] as core.bool; |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (configSource != null) 'configSource': configSource!.toJson(), |
| if (validateOnly != null) 'validateOnly': validateOnly!, |
| }; |
| } |
| |
| /// Response message for SubmitConfigSource method. |
| class SubmitConfigSourceResponse { |
| /// The generated service configuration. |
| Service? serviceConfig; |
| |
| SubmitConfigSourceResponse(); |
| |
| SubmitConfigSourceResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('serviceConfig')) { |
| serviceConfig = Service.fromJson( |
| _json['serviceConfig'] as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (serviceConfig != null) 'serviceConfig': serviceConfig!.toJson(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (httpHeader != null) 'httpHeader': httpHeader!, |
| if (name != null) 'name': name!, |
| if (urlQueryParameter != null) 'urlQueryParameter': urlQueryParameter!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (parameters != null) |
| 'parameters': parameters!.map((value) => value.toJson()).toList(), |
| if (selector != null) 'selector': selector!, |
| }; |
| } |
| |
| /// ### 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.dynamic> toJson() => { |
| if (rules != null) |
| 'rules': rules!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// Request message for `TestIamPermissions` method. |
| class TestIamPermissionsRequest { |
| /// The set of permissions to check for the `resource`. |
| /// |
| /// Permissions with wildcards (such as '*' or 'storage.*') are not allowed. |
| /// For more information see |
| /// [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| core.List<core.String>? permissions; |
| |
| TestIamPermissionsRequest(); |
| |
| TestIamPermissionsRequest.fromJson(core.Map _json) { |
| if (_json.containsKey('permissions')) { |
| permissions = (_json['permissions'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (permissions != null) 'permissions': permissions!, |
| }; |
| } |
| |
| /// Response message for `TestIamPermissions` method. |
| class TestIamPermissionsResponse { |
| /// A subset of `TestPermissionsRequest.permissions` that the caller is |
| /// allowed. |
| core.List<core.String>? permissions; |
| |
| TestIamPermissionsResponse(); |
| |
| TestIamPermissionsResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('permissions')) { |
| permissions = (_json['permissions'] as core.List) |
| .map<core.String>((value) => value as core.String) |
| .toList(); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (permissions != null) 'permissions': permissions!, |
| }; |
| } |
| |
| /// Strategy that specifies how clients of Google Service Controller want to |
| /// send traffic to use different config versions. |
| /// |
| /// This is generally used by API proxy to split traffic based on your |
| /// configured percentage for each config version. One example of how to |
| /// gradually rollout a new service configuration using this strategy: Day 1 |
| /// Rollout { id: "example.googleapis.com/rollout_20160206" |
| /// traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": |
| /// 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: |
| /// "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { |
| /// percentages: { "example.googleapis.com/20160206": 100.00 } } } |
| class TrafficPercentStrategy { |
| /// Maps service configuration IDs to their corresponding traffic percentage. |
| /// |
| /// Key is the service configuration ID, Value is the traffic percentage which |
| /// must be greater than 0.0 and the sum must equal to 100.0. |
| core.Map<core.String, core.double>? percentages; |
| |
| TrafficPercentStrategy(); |
| |
| TrafficPercentStrategy.fromJson(core.Map _json) { |
| if (_json.containsKey('percentages')) { |
| percentages = |
| (_json['percentages'] as core.Map<core.String, core.dynamic>).map( |
| (key, item) => core.MapEntry( |
| key, |
| (item as core.num).toDouble(), |
| ), |
| ); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (percentages != null) 'percentages': percentages!, |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (fields != null) |
| 'fields': fields!.map((value) => value.toJson()).toList(), |
| if (name != null) 'name': name!, |
| if (oneofs != null) 'oneofs': oneofs!, |
| if (options != null) |
| 'options': options!.map((value) => value.toJson()).toList(), |
| if (sourceContext != null) 'sourceContext': sourceContext!.toJson(), |
| if (syntax != null) 'syntax': syntax!, |
| }; |
| } |
| |
| /// Response message for UndeleteService method. |
| class UndeleteServiceResponse { |
| /// Revived service resource. |
| ManagedService? service; |
| |
| UndeleteServiceResponse(); |
| |
| UndeleteServiceResponse.fromJson(core.Map _json) { |
| if (_json.containsKey('service')) { |
| service = ManagedService.fromJson( |
| _json['service'] as core.Map<core.String, core.dynamic>); |
| } |
| } |
| |
| core.Map<core.String, core.dynamic> toJson() => { |
| if (service != null) 'service': service!.toJson(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (producerNotificationChannel != null) |
| 'producerNotificationChannel': producerNotificationChannel!, |
| if (requirements != null) 'requirements': requirements!, |
| if (rules != null) |
| 'rules': rules!.map((value) => value.toJson()).toList(), |
| }; |
| } |
| |
| /// 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.dynamic> toJson() => { |
| if (allowUnregisteredCalls != null) |
| 'allowUnregisteredCalls': allowUnregisteredCalls!, |
| if (selector != null) 'selector': selector!, |
| if (skipServiceControl != null) |
| 'skipServiceControl': skipServiceControl!, |
| }; |
| } |