Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified	Actions
📁 ..	-	2025-03-11 18:02
📄 __init__.py """Package marker file.""" from __future__ import absolute_import import pkgutil __path__ = pkgutil.extend_path(__path__, __name__)	135 B	2025-03-11 18:02
📄 servicemanagement_v1_client.py """Generated client library for servicemanagement version v1.""" # NOTE: This file is autogenerated and should not be edited by hand. from __future__ import absolute_import from apitools.base.py import base_api from samples.servicemanagement_sample.servicemanagement_v1 import servicemanagement_v1_messages as messages class ServicemanagementV1(base_api.BaseApiClient): """Generated client library for service servicemanagement version v1.""" MESSAGES_MODULE = messages BASE_URL = 'https://servicemanagement.googleapis.com/' MTLS_BASE_URL = '' _PACKAGE = 'servicemanagement' _SCOPES = ['https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/service.management'] _VERSION = 'v1' _CLIENT_ID = 'CLIENT_ID' _CLIENT_SECRET = 'CLIENT_SECRET' _USER_AGENT = 'x_Tw5K8nnjoRAqULM9PFAC2b' _CLIENT_CLASS_NAME = 'ServicemanagementV1' _URL_VERSION = 'v1' _API_KEY = None def __init__(self, url='', credentials=None, get_credentials=True, http=None, model=None, log_request=False, log_response=False, credentials_args=None, default_global_params=None, additional_http_headers=None, response_encoding=None): """Create a new servicemanagement handle.""" url = url or self.BASE_URL super(ServicemanagementV1, self).__init__( url, credentials=credentials, get_credentials=get_credentials, http=http, model=model, log_request=log_request, log_response=log_response, credentials_args=credentials_args, default_global_params=default_global_params, additional_http_headers=additional_http_headers, response_encoding=response_encoding) self.operations = self.OperationsService(self) self.services_accessPolicy = self.ServicesAccessPolicyService(self) self.services_configs = self.ServicesConfigsService(self) self.services_customerSettings = self.ServicesCustomerSettingsService(self) self.services_projectSettings = self.ServicesProjectSettingsService(self) self.services = self.ServicesService(self) self.v1 = self.V1Service(self) class OperationsService(base_api.BaseApiService): """Service class for the operations resource.""" _NAME = 'operations' def __init__(self, client): super(ServicemanagementV1.OperationsService, self).__init__(client) self._upload_configs = { } def Get(self, request, global_params=None): r"""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. Args: request: (ServicemanagementOperationsGetRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Get') return self._RunMethod( config, request, global_params=global_params) Get.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.operations.get', ordered_params=['operationsId'], path_params=['operationsId'], query_params=[], relative_path='v1/operations/{operationsId}', request_field='', request_type_name='ServicemanagementOperationsGetRequest', response_type_name='Operation', supports_download=False, ) class ServicesAccessPolicyService(base_api.BaseApiService): """Service class for the services_accessPolicy resource.""" _NAME = 'services_accessPolicy' def __init__(self, client): super(ServicemanagementV1.ServicesAccessPolicyService, self).__init__(client) self._upload_configs = { } def Query(self, request, global_params=None): r"""Method to query the accessibility of a service and any associated. visibility labels for a specified user. Members of the producer project may call this method and specify any user. Any user may call this method, but must specify their own email address. In this case the method will return NOT_FOUND if the user has no access to the service. Args: request: (ServicemanagementServicesAccessPolicyQueryRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (QueryUserAccessResponse) The response message. """ config = self.GetMethodConfig('Query') return self._RunMethod( config, request, global_params=global_params) Query.method_config = lambda: base_api.ApiMethodInfo( http_method='POST', method_id='servicemanagement.services.accessPolicy.query', ordered_params=['serviceName'], path_params=['serviceName'], query_params=['userEmail'], relative_path='v1/services/{serviceName}/accessPolicy:query', request_field='', request_type_name='ServicemanagementServicesAccessPolicyQueryRequest', response_type_name='QueryUserAccessResponse', supports_download=False, ) class ServicesConfigsService(base_api.BaseApiService): """Service class for the services_configs resource.""" _NAME = 'services_configs' def __init__(self, client): super(ServicemanagementV1.ServicesConfigsService, self).__init__(client) self._upload_configs = { } def Create(self, request, global_params=None): r"""Creates a new service config (version) for a managed service. This method. only stores the service config, but does not apply the service config to any backend services. Args: request: (ServicemanagementServicesConfigsCreateRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Service) The response message. """ config = self.GetMethodConfig('Create') return self._RunMethod( config, request, global_params=global_params) Create.method_config = lambda: base_api.ApiMethodInfo( http_method='POST', method_id='servicemanagement.services.configs.create', ordered_params=['serviceName'], path_params=['serviceName'], query_params=[], relative_path='v1/services/{serviceName}/configs', request_field='service', request_type_name='ServicemanagementServicesConfigsCreateRequest', response_type_name='Service', supports_download=False, ) def Get(self, request, global_params=None): r"""Gets a service config (version) for a managed service. If `config_id` is. not specified, the latest service config will be returned. Args: request: (ServicemanagementServicesConfigsGetRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Service) The response message. """ config = self.GetMethodConfig('Get') return self._RunMethod( config, request, global_params=global_params) Get.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.services.configs.get', ordered_params=['serviceName', 'configId'], path_params=['configId', 'serviceName'], query_params=[], relative_path='v1/services/{serviceName}/configs/{configId}', request_field='', request_type_name='ServicemanagementServicesConfigsGetRequest', response_type_name='Service', supports_download=False, ) def List(self, request, global_params=None): r"""Lists the history of the service config for a managed service,. from the newest to the oldest. Args: request: (ServicemanagementServicesConfigsListRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (ListServiceConfigsResponse) The response message. """ config = self.GetMethodConfig('List') return self._RunMethod( config, request, global_params=global_params) List.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.services.configs.list', ordered_params=['serviceName'], path_params=['serviceName'], query_params=['pageSize', 'pageToken'], relative_path='v1/services/{serviceName}/configs', request_field='', request_type_name='ServicemanagementServicesConfigsListRequest', response_type_name='ListServiceConfigsResponse', supports_download=False, ) def Submit(self, request, global_params=None): r"""Creates a new service config (version) for a managed service based on. user-supplied configuration sources files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service config. It does NOT apply the service config to any backend services. Operation<response: SubmitConfigSourceResponse> Args: request: (ServicemanagementServicesConfigsSubmitRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Submit') return self._RunMethod( config, request, global_params=global_params) Submit.method_config = lambda: base_api.ApiMethodInfo( http_method='POST', method_id='servicemanagement.services.configs.submit', ordered_params=['serviceName'], path_params=['serviceName'], query_params=[], relative_path='v1/services/{serviceName}/configs:submit', request_field='submitConfigSourceRequest', request_type_name='ServicemanagementServicesConfigsSubmitRequest', response_type_name='Operation', supports_download=False, ) class ServicesCustomerSettingsService(base_api.BaseApiService): """Service class for the services_customerSettings resource.""" _NAME = 'services_customerSettings' def __init__(self, client): super(ServicemanagementV1.ServicesCustomerSettingsService, self).__init__(client) self._upload_configs = { } def Get(self, request, global_params=None): r"""Retrieves the settings that control the specified customer's usage of the. service. Args: request: (ServicemanagementServicesCustomerSettingsGetRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (CustomerSettings) The response message. """ config = self.GetMethodConfig('Get') return self._RunMethod( config, request, global_params=global_params) Get.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.services.customerSettings.get', ordered_params=['serviceName', 'customerId'], path_params=['customerId', 'serviceName'], query_params=['expand', 'view'], relative_path='v1/services/{serviceName}/customerSettings/{customerId}', request_field='', request_type_name='ServicemanagementServicesCustomerSettingsGetRequest', response_type_name='CustomerSettings', supports_download=False, ) def Patch(self, request, global_params=None): r"""Updates specified subset of the settings that control the specified. customer's usage of the service. Attempts to update a field not controlled by the caller will result in an access denied error. Operation<response: CustomerSettings> Args: request: (ServicemanagementServicesCustomerSettingsPatchRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Patch') return self._RunMethod( config, request, global_params=global_params) Patch.method_config = lambda: base_api.ApiMethodInfo( http_method='PATCH', method_id='servicemanagement.services.customerSettings.patch', ordered_params=['serviceName', 'customerId'], path_params=['customerId', 'serviceName'], query_params=['updateMask'], relative_path='v1/services/{serviceName}/customerSettings/{customerId}', request_field='customerSettings', request_type_name='ServicemanagementServicesCustomerSettingsPatchRequest', response_type_name='Operation', supports_download=False, ) class ServicesProjectSettingsService(base_api.BaseApiService): """Service class for the services_projectSettings resource.""" _NAME = 'services_projectSettings' def __init__(self, client): super(ServicemanagementV1.ServicesProjectSettingsService, self).__init__(client) self._upload_configs = { } def Get(self, request, global_params=None): r"""Retrieves the settings that control the specified consumer project's usage. of the service. Args: request: (ServicemanagementServicesProjectSettingsGetRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (ProjectSettings) The response message. """ config = self.GetMethodConfig('Get') return self._RunMethod( config, request, global_params=global_params) Get.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.services.projectSettings.get', ordered_params=['serviceName', 'consumerProjectId'], path_params=['consumerProjectId', 'serviceName'], query_params=['expand', 'view'], relative_path='v1/services/{serviceName}/projectSettings/{consumerProjectId}', request_field='', request_type_name='ServicemanagementServicesProjectSettingsGetRequest', response_type_name='ProjectSettings', supports_download=False, ) def Patch(self, request, global_params=None): r"""Updates specified subset of the settings that control the specified. consumer project's usage of the service. Attempts to update a field not controlled by the caller will result in an access denied error. Operation<response: ProjectSettings> Args: request: (ServicemanagementServicesProjectSettingsPatchRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Patch') return self._RunMethod( config, request, global_params=global_params) Patch.method_config = lambda: base_api.ApiMethodInfo( http_method='PATCH', method_id='servicemanagement.services.projectSettings.patch', ordered_params=['serviceName', 'consumerProjectId'], path_params=['consumerProjectId', 'serviceName'], query_params=['updateMask'], relative_path='v1/services/{serviceName}/projectSettings/{consumerProjectId}', request_field='projectSettings', request_type_name='ServicemanagementServicesProjectSettingsPatchRequest', response_type_name='Operation', supports_download=False, ) def Update(self, request, global_params=None): r"""NOTE: Currently unsupported. Use PatchProjectSettings instead. Updates the settings that control the specified consumer project's usage of the service. Attempts to update a field not controlled by the caller will result in an access denied error. Operation<response: ProjectSettings> Args: request: (ProjectSettings) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Update') return self._RunMethod( config, request, global_params=global_params) Update.method_config = lambda: base_api.ApiMethodInfo( http_method='PUT', method_id='servicemanagement.services.projectSettings.update', ordered_params=['serviceName', 'consumerProjectId'], path_params=['consumerProjectId', 'serviceName'], query_params=[], relative_path='v1/services/{serviceName}/projectSettings/{consumerProjectId}', request_field='<request>', request_type_name='ProjectSettings', response_type_name='Operation', supports_download=False, ) class ServicesService(base_api.BaseApiService): """Service class for the services resource.""" _NAME = 'services' def __init__(self, client): super(ServicemanagementV1.ServicesService, self).__init__(client) self._upload_configs = { } def ConvertConfig(self, request, global_params=None): r"""DEPRECATED. `SubmitConfigSource` with `validate_only=true` will provide. config conversion moving forward. Converts an API specification (e.g. Swagger spec) to an equivalent `google.api.Service`. Args: request: (ConvertConfigRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (ConvertConfigResponse) The response message. """ config = self.GetMethodConfig('ConvertConfig') return self._RunMethod( config, request, global_params=global_params) ConvertConfig.method_config = lambda: base_api.ApiMethodInfo( http_method='POST', method_id='servicemanagement.services.convertConfig', ordered_params=[], path_params=[], query_params=[], relative_path='v1/services:convertConfig', request_field='<request>', request_type_name='ConvertConfigRequest', response_type_name='ConvertConfigResponse', supports_download=False, ) def Create(self, request, global_params=None): r"""Creates a new managed service. Operation<response: ManagedService> Args: request: (ManagedService) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Create') return self._RunMethod( config, request, global_params=global_params) Create.method_config = lambda: base_api.ApiMethodInfo( http_method='POST', method_id='servicemanagement.services.create', ordered_params=[], path_params=[], query_params=[], relative_path='v1/services', request_field='<request>', request_type_name='ManagedService', response_type_name='Operation', supports_download=False, ) def Delete(self, request, global_params=None): r"""Deletes a managed service. Operation<response: google.protobuf.Empty> Args: request: (ServicemanagementServicesDeleteRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Delete') return self._RunMethod( config, request, global_params=global_params) Delete.method_config = lambda: base_api.ApiMethodInfo( http_method='DELETE', method_id='servicemanagement.services.delete', ordered_params=['serviceName'], path_params=['serviceName'], query_params=[], relative_path='v1/services/{serviceName}', request_field='', request_type_name='ServicemanagementServicesDeleteRequest', response_type_name='Operation', supports_download=False, ) def Disable(self, request, global_params=None): r"""Disable a managed service for a project. Google Service Management will only disable the managed service even if there are other services depend on the managed service. Operation<response: DisableServiceResponse> Args: request: (ServicemanagementServicesDisableRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Disable') return self._RunMethod( config, request, global_params=global_params) Disable.method_config = lambda: base_api.ApiMethodInfo( http_method='POST', method_id='servicemanagement.services.disable', ordered_params=['serviceName'], path_params=['serviceName'], query_params=[], relative_path='v1/services/{serviceName}:disable', request_field='disableServiceRequest', request_type_name='ServicemanagementServicesDisableRequest', response_type_name='Operation', supports_download=False, ) def Enable(self, request, global_params=None): r"""Enable a managed service for a project with default setting. If the managed service has dependencies, they will be enabled as well. Operation<response: EnableServiceResponse> Args: request: (ServicemanagementServicesEnableRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Enable') return self._RunMethod( config, request, global_params=global_params) Enable.method_config = lambda: base_api.ApiMethodInfo( http_method='POST', method_id='servicemanagement.services.enable', ordered_params=['serviceName'], path_params=['serviceName'], query_params=[], relative_path='v1/services/{serviceName}:enable', request_field='enableServiceRequest', request_type_name='ServicemanagementServicesEnableRequest', response_type_name='Operation', supports_download=False, ) def Get(self, request, global_params=None): r"""Gets a managed service. If the `consumer_project_id` is specified,. the project's settings for the specified service are also returned. Args: request: (ServicemanagementServicesGetRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (ManagedService) The response message. """ config = self.GetMethodConfig('Get') return self._RunMethod( config, request, global_params=global_params) Get.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.services.get', ordered_params=['serviceName'], path_params=['serviceName'], query_params=['consumerProjectId', 'expand', 'view'], relative_path='v1/services/{serviceName}', request_field='', request_type_name='ServicemanagementServicesGetRequest', response_type_name='ManagedService', supports_download=False, ) def GetAccessPolicy(self, request, global_params=None): r"""Producer method to retrieve current policy. Args: request: (ServicemanagementServicesGetAccessPolicyRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (ServiceAccessPolicy) The response message. """ config = self.GetMethodConfig('GetAccessPolicy') return self._RunMethod( config, request, global_params=global_params) GetAccessPolicy.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.services.getAccessPolicy', ordered_params=['serviceName'], path_params=['serviceName'], query_params=[], relative_path='v1/services/{serviceName}/accessPolicy', request_field='', request_type_name='ServicemanagementServicesGetAccessPolicyRequest', response_type_name='ServiceAccessPolicy', supports_download=False, ) def GetConfig(self, request, global_params=None): r"""Gets a service config (version) for a managed service. If `config_id` is. not specified, the latest service config will be returned. Args: request: (ServicemanagementServicesGetConfigRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Service) The response message. """ config = self.GetMethodConfig('GetConfig') return self._RunMethod( config, request, global_params=global_params) GetConfig.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.services.getConfig', ordered_params=['serviceName'], path_params=['serviceName'], query_params=['configId'], relative_path='v1/services/{serviceName}/config', request_field='', request_type_name='ServicemanagementServicesGetConfigRequest', response_type_name='Service', supports_download=False, ) def List(self, request, global_params=None): r"""Lists all managed services. If the `consumer_project_id` is specified,. the project's settings for the specified service are also returned. Args: request: (ServicemanagementServicesListRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (ListServicesResponse) The response message. """ config = self.GetMethodConfig('List') return self._RunMethod( config, request, global_params=global_params) List.method_config = lambda: base_api.ApiMethodInfo( http_method='GET', method_id='servicemanagement.services.list', ordered_params=[], path_params=[], query_params=['category', 'consumerProjectId', 'expand', 'pageSize', 'pageToken', 'producerProjectId'], relative_path='v1/services', request_field='', request_type_name='ServicemanagementServicesListRequest', response_type_name='ListServicesResponse', supports_download=False, ) def Patch(self, request, global_params=None): r"""Updates the specified subset of the configuration. If the specified service. does not exists the patch operation fails. Operation<response: ManagedService> Args: request: (ServicemanagementServicesPatchRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Patch') return self._RunMethod( config, request, global_params=global_params) Patch.method_config = lambda: base_api.ApiMethodInfo( http_method='PATCH', method_id='servicemanagement.services.patch', ordered_params=['serviceName'], path_params=['serviceName'], query_params=['updateMask'], relative_path='v1/services/{serviceName}', request_field='managedService', request_type_name='ServicemanagementServicesPatchRequest', response_type_name='Operation', supports_download=False, ) def PatchConfig(self, request, global_params=None): r"""Updates the specified subset of the service resource. Equivalent to. calling `PatchService` with only the `service_config` field updated. Operation<response: google.api.Service> Args: request: (ServicemanagementServicesPatchConfigRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('PatchConfig') return self._RunMethod( config, request, global_params=global_params) PatchConfig.method_config = lambda: base_api.ApiMethodInfo( http_method='PATCH', method_id='servicemanagement.services.patchConfig', ordered_params=['serviceName'], path_params=['serviceName'], query_params=['updateMask'], relative_path='v1/services/{serviceName}/config', request_field='service', request_type_name='ServicemanagementServicesPatchConfigRequest', response_type_name='Operation', supports_download=False, ) def Update(self, request, global_params=None): r"""Updates the configuration of a service. If the specified service does not. already exist, then it is created. Operation<response: ManagedService> Args: request: (ServicemanagementServicesUpdateRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('Update') return self._RunMethod( config, request, global_params=global_params) Update.method_config = lambda: base_api.ApiMethodInfo( http_method='PUT', method_id='servicemanagement.services.update', ordered_params=['serviceName'], path_params=['serviceName'], query_params=['updateMask'], relative_path='v1/services/{serviceName}', request_field='managedService', request_type_name='ServicemanagementServicesUpdateRequest', response_type_name='Operation', supports_download=False, ) def UpdateAccessPolicy(self, request, global_params=None): r"""Producer method to update the current policy. This method will return an. error if the policy is too large (more than 50 entries across all lists). Args: request: (ServiceAccessPolicy) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (ServiceAccessPolicy) The response message. """ config = self.GetMethodConfig('UpdateAccessPolicy') return self._RunMethod( config, request, global_params=global_params) UpdateAccessPolicy.method_config = lambda: base_api.ApiMethodInfo( http_method='PUT', method_id='servicemanagement.services.updateAccessPolicy', ordered_params=['serviceName'], path_params=['serviceName'], query_params=[], relative_path='v1/services/{serviceName}/accessPolicy', request_field='<request>', request_type_name='ServiceAccessPolicy', response_type_name='ServiceAccessPolicy', supports_download=False, ) def UpdateConfig(self, request, global_params=None): r"""Updates the specified subset of the service resource. Equivalent to. calling `UpdateService` with only the `service_config` field updated. Operation<response: google.api.Service> Args: request: (ServicemanagementServicesUpdateConfigRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (Operation) The response message. """ config = self.GetMethodConfig('UpdateConfig') return self._RunMethod( config, request, global_params=global_params) UpdateConfig.method_config = lambda: base_api.ApiMethodInfo( http_method='PUT', method_id='servicemanagement.services.updateConfig', ordered_params=['serviceName'], path_params=['serviceName'], query_params=['updateMask'], relative_path='v1/services/{serviceName}/config', request_field='service', request_type_name='ServicemanagementServicesUpdateConfigRequest', response_type_name='Operation', supports_download=False, ) class V1Service(base_api.BaseApiService): """Service class for the v1 resource.""" _NAME = 'v1' def __init__(self, client): super(ServicemanagementV1.V1Service, self).__init__(client) self._upload_configs = { } def ConvertConfig(self, request, global_params=None): r"""DEPRECATED. `SubmitConfigSource` with `validate_only=true` will provide. config conversion moving forward. Converts an API specification (e.g. Swagger spec) to an equivalent `google.api.Service`. Args: request: (ConvertConfigRequest) input message global_params: (StandardQueryParameters, default: None) global arguments Returns: (ConvertConfigResponse) The response message. """ config = self.GetMethodConfig('ConvertConfig') return self._RunMethod( config, request, global_params=global_params) ConvertConfig.method_config = lambda: base_api.ApiMethodInfo( http_method='POST', method_id='servicemanagement.convertConfig', ordered_params=[], path_params=[], query_params=[], relative_path='v1:convertConfig', request_field='<request>', request_type_name='ConvertConfigRequest', response_type_name='ConvertConfigResponse', supports_download=False, )	32.39 KB	2025-03-11 18:02
📄 servicemanagement_v1_messages.py """Generated message classes for servicemanagement version v1. The service management API for Google Cloud Platform """ # NOTE: This file is autogenerated and should not be edited by hand. from __future__ import absolute_import from apitools.base.protorpclite import messages as _messages from apitools.base.py import encoding from apitools.base.py import extra_types package = 'servicemanagement' class Api(_messages.Message): r"""Api is a light-weight descriptor for a protocol buffer service. Enums: SyntaxValueValuesEnum: The source syntax of the service. Fields: methods: The methods of this api, in unspecified order. mixins: Included APIs. See Mixin. name: The fully qualified name of this api, including package name followed by the api's simple name. options: Any metadata attached to the API. sourceContext: Source context for the protocol buffer service represented by this message. syntax: The source syntax of the service. version: A version string for this api. 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 API, which must end in `v<major-version>`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, none-GA apis. """ class SyntaxValueValuesEnum(_messages.Enum): r"""The source syntax of the service. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. """ SYNTAX_PROTO2 = 0 SYNTAX_PROTO3 = 1 methods = _messages.MessageField('Method', 1, repeated=True) mixins = _messages.MessageField('Mixin', 2, repeated=True) name = _messages.StringField(3) options = _messages.MessageField('Option', 4, repeated=True) sourceContext = _messages.MessageField('SourceContext', 5) syntax = _messages.EnumField('SyntaxValueValuesEnum', 6) version = _messages.StringField(7) class AreaUnderCurveParams(_messages.Message): r"""AreaUnderCurveParams groups the metrics relevant to generating duration based metric from base (snapshot) metric and delta (change) metric. The generated metric has two dimensions: resource usage metric and the duration the metric applies. Essentially the generated metric is the Area Under Curve(AUC) of the "duration - resource" usage curve. This AUC metric is readily appliable to billing since "billable resource usage" depends on resource usage and duration of the resource used. A service config may contain multiple resources and corresponding metrics. AreaUnderCurveParams groups the relevant ones: which snapshot_metric and change_metric are used to produce which generated_metric. Fields: changeMetric: Change of resource usage at a particular timestamp. This should a DELTA metric. generatedMetric: Metric generated from snapshot_metric and change_metric. This is also a DELTA metric. snapshotMetric: Total usage of a resource at a particular timestamp. This should be a GAUGE metric. """ changeMetric = _messages.StringField(1) generatedMetric = _messages.StringField(2) snapshotMetric = _messages.StringField(3) class AuthProvider(_messages.Message): r"""Configuration for an anthentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json- web-token-32). Fields: id: The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". issuer: 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 jwksUri: 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 """ id = _messages.StringField(1) issuer = _messages.StringField(2) jwksUri = _messages.StringField(3) class AuthRequirement(_messages.Message): r"""User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web- token-32). Fields: audiences: 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 providerId: id from authentication provider. Example: provider_id: bookstore_auth """ audiences = _messages.StringField(1) providerId = _messages.StringField(2) class Authentication(_messages.Message): r"""`Authentication` defines the authentication configuration for an API. Example for an API targeted for external use: name: calendar.googleapis.com authentication: rules: - selector: "" oauth: canonical_scopes: https://www.googleapis.com/auth/calendar - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read Fields: providers: Defines a set of authentication providers that a service supports. rules: Individual rules for authentication. """ providers = _messages.MessageField('AuthProvider', 1, repeated=True) rules = _messages.MessageField('AuthenticationRule', 2, repeated=True) class AuthenticationRule(_messages.Message): r"""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. Fields: allowWithoutCredential: Whether to allow requests without a credential. If quota is enabled, an API key is required for such request to pass the quota check. oauth: The requirements for OAuth credentials. requirements: Requirements for additional authentication providers. selector: Selects the methods to which this rule applies. Refer to selector for syntax details. """ allowWithoutCredential = _messages.BooleanField(1) oauth = _messages.MessageField('OAuthRequirements', 2) requirements = _messages.MessageField('AuthRequirement', 3, repeated=True) selector = _messages.StringField(4) class Backend(_messages.Message): r"""`Backend` defines the backend configuration for a service. Fields: rules: A list of backend rules providing configuration for individual API elements. """ rules = _messages.MessageField('BackendRule', 1, repeated=True) class BackendRule(_messages.Message): r"""A backend rule provides configuration for an individual API element. Fields: address: The address of the API backend. deadline: The number of seconds to wait for a response from a request. The default depends on the deployment context. selector: Selects the methods to which this rule applies. Refer to selector for syntax details. """ address = _messages.StringField(1) deadline = _messages.FloatField(2) selector = _messages.StringField(3) class Billing(_messages.Message): r"""Billing related configuration of the service. The following example shows how to configure metrics for billing: metrics: - name: library.googleapis.com/read_calls metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls metric_kind: DELTA value_type: INT64 billing: metrics: - library.googleapis.com/read_calls - library.googleapis.com/write_calls The next example shows how to enable billing status check and customize the check behavior. It makes sure billing status check is included in the `Check` method of [Service Control API](https://cloud.google.com/service- control/). In the example, "google.storage.Get" method can be served when the billing status is either `current` or `delinquent`, while "google.storage.Write" method can only be served when the billing status is `current`: billing: rules: - selector: google.storage.Get allowed_statuses: - current - delinquent - selector: google.storage.Write allowed_statuses: current Mostly services should only allow `current` status when serving requests. In addition, services can choose to allow both `current` and `delinquent` statuses when serving read-only requests to resources. If there's no matching selector for operation, no billing status check will be performed. Fields: areaUnderCurveParams: Per resource grouping for delta billing based resource configs. metrics: Names of the metrics to report to billing. Each name must be defined in Service.metrics section. rules: A list of billing status rules for configuring billing status check. """ areaUnderCurveParams = _messages.MessageField('AreaUnderCurveParams', 1, repeated=True) metrics = _messages.StringField(2, repeated=True) rules = _messages.MessageField('BillingStatusRule', 3, repeated=True) class BillingStatusRule(_messages.Message): r"""Defines the billing status requirements for operations. When used with [Service Control API](https://cloud.google.com/service-control/), the following statuses are supported: - current: the associated billing account is up to date and capable of paying for resource usages. - delinquent: the associated billing account has a correctable problem, such as late payment. Mostly services should only allow `current` status when serving requests. In addition, services can choose to allow both `current` and `delinquent` statuses when serving read- only requests to resources. If the list of allowed_statuses is empty, it means no billing requirement. Fields: allowedStatuses: Allowed billing statuses. The billing status check passes if the actual billing status matches any of the provided values here. selector: Selects the operation names to which this rule applies. Refer to selector for syntax details. """ allowedStatuses = _messages.StringField(1, repeated=True) selector = _messages.StringField(2) class CompositeOperationMetadata(_messages.Message): r"""Metadata for composite operations. Messages: OriginalRequestValue: Original request that triggered this operation. ResponseFieldMasksValue: Defines which part of the response a child operation will contribute. Each key of the map is the name of a child operation. Each value is a field mask that identifies what that child operation contributes to the response, for example, "quota_settings", "visiblity_settings", etc. Fields: childOperations: The child operations. The details of the asynchronous child operations are stored in a separate row and not in this metadata. Only the operation name is stored here. originalRequest: Original request that triggered this operation. persisted: Indicates whether the requested state change has been persisted. Once this field is set, it is guaranteed to propagate to all backends eventually, but it may not be visible immediately. Clients that are not concerned with waiting on propagation can stop polling the operation once the persisted field is set responseFieldMasks: Defines which part of the response a child operation will contribute. Each key of the map is the name of a child operation. Each value is a field mask that identifies what that child operation contributes to the response, for example, "quota_settings", "visiblity_settings", etc. """ @encoding.MapUnrecognizedFields('additionalProperties') class OriginalRequestValue(_messages.Message): r"""Original request that triggered this operation. Messages: AdditionalProperty: An additional property for a OriginalRequestValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a OriginalRequestValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class ResponseFieldMasksValue(_messages.Message): r"""Defines which part of the response a child operation will contribute. Each key of the map is the name of a child operation. Each value is a field mask that identifies what that child operation contributes to the response, for example, "quota_settings", "visiblity_settings", etc. Messages: AdditionalProperty: An additional property for a ResponseFieldMasksValue object. Fields: additionalProperties: Additional properties of type ResponseFieldMasksValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a ResponseFieldMasksValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) childOperations = _messages.MessageField('Operation', 1, repeated=True) originalRequest = _messages.MessageField('OriginalRequestValue', 2) persisted = _messages.BooleanField(3) responseFieldMasks = _messages.MessageField('ResponseFieldMasksValue', 4) class ConfigFile(_messages.Message): r"""Generic specification of a source configuration file Enums: FileTypeValueValuesEnum: The kind of configuration file represented. This is used to determine the method for generating `google.api.Service` using this file. Fields: contents: DEPRECATED. The contents of the configuration file. Use file_contents moving forward. fileContents: The bytes that constitute the file. filePath: The file name of the configuration file (full or relative path). fileType: The kind of configuration file represented. This is used to determine the method for generating `google.api.Service` using this file. """ class FileTypeValueValuesEnum(_messages.Enum): r"""The kind of configuration file represented. This is used to determine the method for generating `google.api.Service` using this file. Values: 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 """ FILE_TYPE_UNSPECIFIED = 0 SERVICE_CONFIG_YAML = 1 OPEN_API_JSON = 2 OPEN_API_YAML = 3 FILE_DESCRIPTOR_SET_PROTO = 4 contents = _messages.StringField(1) fileContents = _messages.BytesField(2) filePath = _messages.StringField(3) fileType = _messages.EnumField('FileTypeValueValuesEnum', 4) class ConfigOptions(_messages.Message): r"""A set of options to cover use of source config within `ServiceManager` and related tools. """ class ConfigSource(_messages.Message): r"""Represents a user-specified configuration for a service (as opposed to the the generated service config form provided by `google.api.Service`). This is meant to encode service config as manipulated directly by customers, rather than the config form resulting from toolchain generation and normalization. Fields: files: Set of source configuration files that are used to generate a service config (`google.api.Service`). id: 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. openApiSpec: OpenAPI specification options: Options to cover use of source config within ServiceManager and tools protoSpec: Protocol buffer API specification """ files = _messages.MessageField('ConfigFile', 1, repeated=True) id = _messages.StringField(2) openApiSpec = _messages.MessageField('OpenApiSpec', 3) options = _messages.MessageField('ConfigOptions', 4) protoSpec = _messages.MessageField('ProtoSpec', 5) class Context(_messages.Message): r"""`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`. Fields: rules: List of rules for context, applicable to methods. """ rules = _messages.MessageField('ContextRule', 1, repeated=True) class ContextRule(_messages.Message): r"""A context rule provides information about the context for an individual API element. Fields: provided: A list of full type names of provided contexts. requested: A list of full type names of requested contexts. selector: Selects the methods to which this rule applies. Refer to selector for syntax details. """ provided = _messages.StringField(1, repeated=True) requested = _messages.StringField(2, repeated=True) selector = _messages.StringField(3) class Control(_messages.Message): r"""Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc. Fields: environment: The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled. """ environment = _messages.StringField(1) class ConvertConfigRequest(_messages.Message): r"""Request message for `ConvertConfig` method. Messages: ConfigSpecValue: Input configuration For this version of API, the supported type is OpenApiSpec Fields: configSpec: Input configuration For this version of API, the supported type is OpenApiSpec openApiSpec: The OpenAPI specification for an API. serviceName: The service name to use for constructing the normalized service configuration equivalent of the provided configuration specification. swaggerSpec: The swagger specification for an API. """ @encoding.MapUnrecognizedFields('additionalProperties') class ConfigSpecValue(_messages.Message): r"""Input configuration For this version of API, the supported type is OpenApiSpec Messages: AdditionalProperty: An additional property for a ConfigSpecValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a ConfigSpecValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) configSpec = _messages.MessageField('ConfigSpecValue', 1) openApiSpec = _messages.MessageField('OpenApiSpec', 2) serviceName = _messages.StringField(3) swaggerSpec = _messages.MessageField('SwaggerSpec', 4) class ConvertConfigResponse(_messages.Message): r"""Response message for `ConvertConfig` method. Fields: diagnostics: Any errors or warnings that occured during config conversion. serviceConfig: The service configuration. Not set if errors occured during conversion. """ diagnostics = _messages.MessageField('Diagnostic', 1, repeated=True) serviceConfig = _messages.MessageField('Service', 2) class CustomError(_messages.Message): r"""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 Fields: rules: The list of custom error rules to select to which messages this should apply. types: The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. """ rules = _messages.MessageField('CustomErrorRule', 1, repeated=True) types = _messages.StringField(2, repeated=True) class CustomErrorRule(_messages.Message): r"""A custom error rule. Fields: isErrorType: Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. selector: Selects messages to which this rule applies. Refer to selector for syntax details. """ isErrorType = _messages.BooleanField(1) selector = _messages.StringField(2) class CustomHttpPattern(_messages.Message): r"""A custom pattern is used for defining custom HTTP verb. Fields: kind: The name of this custom HTTP verb. path: The path matched by this custom verb. """ kind = _messages.StringField(1) path = _messages.StringField(2) class CustomerSettings(_messages.Message): r"""Settings that control how a customer (identified by a billing account) uses a service Fields: customerId: ID for the customer that consumes the service (see above). The supported types of customers are: 1. domain:{domain} A Google Apps domain name. For example, google.com. 2. billingAccount:{billing_account_id} A Google Cloud Plafrom billing account. For Example, 123456-7890ab-cdef12. quotaSettings: Settings that control how much or how fast the service can be used by the consumer projects owned by the customer collectively. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. """ customerId = _messages.StringField(1) quotaSettings = _messages.MessageField('QuotaSettings', 2) serviceName = _messages.StringField(3) class Diagnostic(_messages.Message): r"""A collection that represents a diagnostic message (error or warning) Enums: KindValueValuesEnum: The kind of diagnostic information provided. Fields: kind: The kind of diagnostic information provided. location: Location of the cause or context of the diagnostic information. message: The string message of the diagnostic information. """ class KindValueValuesEnum(_messages.Enum): r"""The kind of diagnostic information provided. Values: WARNING: Warnings and errors ERROR: Only errors """ WARNING = 0 ERROR = 1 kind = _messages.EnumField('KindValueValuesEnum', 1) location = _messages.StringField(2) message = _messages.StringField(3) class DisableServiceRequest(_messages.Message): r"""Request message for DisableService method. Fields: consumerId: The identity of consumer resource which service disablement will be applied to. The Google Service Management implementation accepts the following forms: "project:<project_id>", "project_number:<project_number>". Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. """ consumerId = _messages.StringField(1) class Documentation(_messages.Message): r"""`Documentation` provides the information for describing a service. Example: <pre><code>documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... </code></pre> Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: <pre><code>[fully.qualified.proto.name][]</code></pre> To override the display text used for the link, this can be used: <pre><code>[display text][fully.qualified.proto.name]</code></pre> Text can be excluded from doc using the following notation: <pre><code>(-- internal comment --)</code></pre> Comments can be made conditional using a visibility label. The below text will be only rendered if the `BETA` label is available: <pre><code>(--BETA: comment for BETA users --)</code></pre> A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: <pre><code>(== include path/to/file ==)</code></pre> The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: <pre><code>(== resource_for v1.shelves.books ==)</code></pre> The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. Fields: documentationRootUrl: The URL to the root of documentation. overview: Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: (== include overview.md ==) </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) </code></pre> Note: you cannot specify both `overview` field and `pages` field. pages: The top level pages for the documentation set. rules: Documentation rules for individual elements of the service. summary: A short summary of what the service does. Can only be provided by plain text. """ documentationRootUrl = _messages.StringField(1) overview = _messages.StringField(2) pages = _messages.MessageField('Page', 3, repeated=True) rules = _messages.MessageField('DocumentationRule', 4, repeated=True) summary = _messages.StringField(5) class DocumentationRule(_messages.Message): r"""A documentation rule provides information about individual API elements. Fields: deprecationDescription: Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. description: Description of the selected API(s). selector: The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b" or "foo..bar". To specify a default for all applicable elements, the whole pattern "" is used. """ deprecationDescription = _messages.StringField(1) description = _messages.StringField(2) selector = _messages.StringField(3) class EffectiveQuotaGroup(_messages.Message): r"""An effective quota group contains both the metadata for a quota group as derived from the service config, and the effective limits in that group as calculated from producer and consumer overrides together with service defaults. Enums: BillingInteractionValueValuesEnum: Fields: baseGroup: The service configuration for this quota group, minus the quota limits, which are replaced by the effective limits below. billingInteraction: A BillingInteractionValueValuesEnum attribute. quotas: The usage and limit information for each limit within this quota group. """ class BillingInteractionValueValuesEnum(_messages.Enum): r"""BillingInteractionValueValuesEnum enum type. Values: BILLING_INTERACTION_UNSPECIFIED: The interaction between this quota group and the project billing status is unspecified. NONBILLABLE_ONLY: This quota group is enforced only when the consumer project is not billable. BILLABLE_ONLY: This quota group is enforced only when the consumer project is billable. ANY_BILLING_STATUS: This quota group is enforced regardless of the consumer project's billing status. """ BILLING_INTERACTION_UNSPECIFIED = 0 NONBILLABLE_ONLY = 1 BILLABLE_ONLY = 2 ANY_BILLING_STATUS = 3 baseGroup = _messages.MessageField('QuotaGroup', 1) billingInteraction = _messages.EnumField('BillingInteractionValueValuesEnum', 2) quotas = _messages.MessageField('QuotaInfo', 3, repeated=True) class EffectiveQuotaLimit(_messages.Message): r"""An effective quota limit contains the metadata for a quota limit as derived from the service config, together with fields that describe the effective limit value and what overrides can be applied to it. Fields: baseLimit: The service's configuration for this quota limit. effectiveLimit: The effective limit value, based on the stored producer and consumer overrides and the service defaults. key: The key used to identify this limit when applying overrides. The consumer_overrides and producer_overrides maps are keyed by strings of the form "QuotaGroupName/QuotaLimitName". maxConsumerOverrideAllowed: The maximum override value that a consumer may specify. """ baseLimit = _messages.MessageField('QuotaLimit', 1) effectiveLimit = _messages.IntegerField(2) key = _messages.StringField(3) maxConsumerOverrideAllowed = _messages.IntegerField(4) class EnableServiceRequest(_messages.Message): r"""Request message for EnableService method. Fields: consumerId: The identity of consumer resource which service enablement will be applied to. The Google Service Management implementation accepts the following forms: "project:<project_id>", "project_number:<project_number>". Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id. """ consumerId = _messages.StringField(1) class Enum(_messages.Message): r"""Enum type definition. Enums: SyntaxValueValuesEnum: The source syntax. Fields: enumvalue: Enum value definitions. name: Enum type name. options: Protocol buffer options. sourceContext: The source context. syntax: The source syntax. """ class SyntaxValueValuesEnum(_messages.Enum): r"""The source syntax. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. """ SYNTAX_PROTO2 = 0 SYNTAX_PROTO3 = 1 enumvalue = _messages.MessageField('EnumValue', 1, repeated=True) name = _messages.StringField(2) options = _messages.MessageField('Option', 3, repeated=True) sourceContext = _messages.MessageField('SourceContext', 4) syntax = _messages.EnumField('SyntaxValueValuesEnum', 5) class EnumValue(_messages.Message): r"""Enum value definition. Fields: name: Enum value name. number: Enum value number. options: Protocol buffer options. """ name = _messages.StringField(1) number = _messages.IntegerField(2, variant=_messages.Variant.INT32) options = _messages.MessageField('Option', 3, repeated=True) class Field(_messages.Message): r"""A single field of a message type. Enums: CardinalityValueValuesEnum: The field cardinality. KindValueValuesEnum: The field type. Fields: cardinality: The field cardinality. defaultValue: The string value of the default value of this field. Proto2 syntax only. jsonName: The field JSON name. kind: The field type. name: The field name. number: The field number. oneofIndex: 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. options: The protocol buffer options. packed: Whether to use alternative packed wire representation. typeUrl: The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. """ class CardinalityValueValuesEnum(_messages.Enum): r"""The field cardinality. Values: 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. """ CARDINALITY_UNKNOWN = 0 CARDINALITY_OPTIONAL = 1 CARDINALITY_REQUIRED = 2 CARDINALITY_REPEATED = 3 class KindValueValuesEnum(_messages.Enum): r"""The field type. Values: 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. """ TYPE_UNKNOWN = 0 TYPE_DOUBLE = 1 TYPE_FLOAT = 2 TYPE_INT64 = 3 TYPE_UINT64 = 4 TYPE_INT32 = 5 TYPE_FIXED64 = 6 TYPE_FIXED32 = 7 TYPE_BOOL = 8 TYPE_STRING = 9 TYPE_GROUP = 10 TYPE_MESSAGE = 11 TYPE_BYTES = 12 TYPE_UINT32 = 13 TYPE_ENUM = 14 TYPE_SFIXED32 = 15 TYPE_SFIXED64 = 16 TYPE_SINT32 = 17 TYPE_SINT64 = 18 cardinality = _messages.EnumField('CardinalityValueValuesEnum', 1) defaultValue = _messages.StringField(2) jsonName = _messages.StringField(3) kind = _messages.EnumField('KindValueValuesEnum', 4) name = _messages.StringField(5) number = _messages.IntegerField(6, variant=_messages.Variant.INT32) oneofIndex = _messages.IntegerField(7, variant=_messages.Variant.INT32) options = _messages.MessageField('Option', 8, repeated=True) packed = _messages.BooleanField(9) typeUrl = _messages.StringField(10) class File(_messages.Message): r"""A single swagger specification file. Fields: contents: The contents of the swagger spec file. path: The relative path of the swagger spec file. """ contents = _messages.StringField(1) path = _messages.StringField(2) class Http(_messages.Message): r"""Defines the HTTP configuration for a service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. Fields: rules: A list of HTTP rules for configuring the HTTP REST API methods. """ rules = _messages.MessageField('HttpRule', 1, repeated=True) class HttpRule(_messages.Message): r"""`HttpRule` defines the mapping of an RPC method to one or more HTTP REST APIs. The mapping determines what portions of the request message are populated from the path, query parameters, or body of the HTTP request. The mapping is typically specified as an `google.api.http` annotation, see "google/api/annotations.proto" for details. The mapping consists of a field specifying the path template and method kind. The path template can refer to fields in the request message, as in the example below which describes a REST GET operation on a resource collection of messages: ```proto service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}"; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // mapped to the URL SubMessage sub = 2; // `sub.subfield` is url-mapped } message Message { string text = 1; // content of the resource } ``` This definition enables an automatic, bidrectional mapping of HTTP JSON to RPC. Example: HTTP \| RPC -----\|----- `GET /v1/messages/123456/foo` \| `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))` In general, not only fields but also field paths can be referenced from a path pattern. Fields mapped to the path pattern cannot be repeated and must have a primitive (non-message) type. Any fields in the request message which are not bound by the path pattern automatically become (optional) HTTP query parameters. Assume the following definition of the request message: ```proto message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // mapped to the URL int64 revision = 2; // becomes a parameter SubMessage sub = 3; // `sub.subfield` becomes a parameter } ``` This enables a HTTP JSON to RPC mapping as below: HTTP \| RPC -----\|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` \| `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to HTTP parameters must have a primitive type or a repeated primitive type. Message types are not allowed. In the case of a repeated type, the parameter can be repeated in the URL, as in `...?param=A&param=B`. For HTTP method kinds which allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: ```proto service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { put: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } ``` The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP \| RPC -----\|----- `PUT /v1/messages/123456 { "text": "Hi!" }` \| `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: ```proto service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { put: "/v1/messages/{message_id}" body: "" }; } } message Message { string message_id = 1; string text = 2; } ``` The following HTTP JSON to RPC mapping is enabled: HTTP \| RPC -----\|----- `PUT /v1/messages/123456 { "text": "Hi!" }` \| `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice of defining REST APIs. The common usage of `` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: ```proto service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } ``` This enables the following two alternative HTTP JSON to RPC mappings: HTTP \| RPC -----\|----- `GET /v1/messages/123456` \| `GetMessage(message_id: "123456")` `GET /v1/users/me/messages/123456` \| `GetMessage(user_id: "me" message_id: "123456")` # Rules for HTTP mapping The rules for mapping HTTP path, query parameters, and body fields to the request message are as follows: 1. The `body` field specifies either `` or a field path, or is omitted. If omitted, it assumes there is no HTTP body. 2. Leaf fields (recursive expansion of nested messages in the request) can be classified into three types: (a) Matched in the URL template. (b) Covered by body (if body is ``, everything except (a) fields; else everything under the body field) (c) All other fields. 3. URL query parameters found in the HTTP request are mapped to (c) fields. 4. Any body sent with an HTTP request can contain only (b) fields. The syntax of the path template is as follows: Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "" \| "*" \| LITERAL \| Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `` matches a single path segment. It follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion. The syntax `*` matches zero or more path segments. It follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved Expansion. The syntax `LITERAL` matches literal text in the URL path. The syntax `Variable` matches the entire path as specified by its template; this nested template must not contain further variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=}`. NOTE: the field paths in variables and in the `body` must not refer to repeated fields or map fields. Use CustomHttpPattern to specify any HTTP method that is not included in the `pattern` field, such as HEAD, or "" to leave the HTTP method unspecified for a given URL path rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. Fields: additionalBindings: 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). body: The name of the request field whose value is mapped to the HTTP body, or `` for mapping all fields not captured by the path pattern to the HTTP body. NOTE: the referred field must not be a repeated field. custom: Custom pattern is used for defining custom verbs. delete: Used for deleting a resource. get: Used for listing and getting information about resources. mediaDownload: Do not use this. For media support, add instead [][google.bytestream.RestByteStream] as an API to your configuration. mediaUpload: Do not use this. For media support, add instead [][google.bytestream.RestByteStream] as an API to your configuration. patch: Used for updating a resource. post: Used for creating a resource. put: Used for updating a resource. selector: Selects methods to which this rule applies. Refer to selector for syntax details. """ additionalBindings = _messages.MessageField('HttpRule', 1, repeated=True) body = _messages.StringField(2) custom = _messages.MessageField('CustomHttpPattern', 3) delete = _messages.StringField(4) get = _messages.StringField(5) mediaDownload = _messages.MessageField('MediaDownload', 6) mediaUpload = _messages.MessageField('MediaUpload', 7) patch = _messages.StringField(8) post = _messages.StringField(9) put = _messages.StringField(10) selector = _messages.StringField(11) class LabelDescriptor(_messages.Message): r"""A description of a label. Enums: ValueTypeValueValuesEnum: The type of data that can be assigned to the label. Fields: description: A human-readable description for the label. key: The label key. valueType: The type of data that can be assigned to the label. """ class ValueTypeValueValuesEnum(_messages.Enum): r"""The type of data that can be assigned to the label. Values: STRING: A variable-length string. This is the default. BOOL: Boolean; true or false. INT64: A 64-bit signed integer. """ STRING = 0 BOOL = 1 INT64 = 2 description = _messages.StringField(1) key = _messages.StringField(2) valueType = _messages.EnumField('ValueTypeValueValuesEnum', 3) class ListServiceConfigsResponse(_messages.Message): r"""Response message for ListServiceConfigs method. Fields: nextPageToken: The token of the next page of results. serviceConfigs: The list of service config resources. """ nextPageToken = _messages.StringField(1) serviceConfigs = _messages.MessageField('Service', 2, repeated=True) class ListServicesResponse(_messages.Message): r"""Response message for `ListServices` method. Fields: nextPageToken: Token that can be passed to `ListServices` to resume a paginated query. services: The results of the query. """ nextPageToken = _messages.StringField(1) services = _messages.MessageField('ManagedService', 2, repeated=True) class LogDescriptor(_messages.Message): r"""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 Fields: description: A human-readable description of this log. This information appears in the documentation and can contain details. displayName: The human-readable name for this log. This information appears on the user interface and should be concise. labels: The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. name: 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 [/_-.]. """ description = _messages.StringField(1) displayName = _messages.StringField(2) labels = _messages.MessageField('LabelDescriptor', 3, repeated=True) name = _messages.StringField(4) class Logging(_messages.Message): r"""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 `library.googleapis.com/activity_history` log is sent to both the producer and consumer projects, whereas the `library.googleapis.com/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: library.googleapis.com/activity_history labels: - key: /customer_id - name: library.googleapis.com/purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - library.googleapis.com/activity_history - library.googleapis.com/purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - library.googleapis.com/activity_history Fields: consumerDestinations: 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. producerDestinations: 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. """ consumerDestinations = _messages.MessageField('LoggingDestination', 1, repeated=True) producerDestinations = _messages.MessageField('LoggingDestination', 2, repeated=True) class LoggingDestination(_messages.Message): r"""Configuration of a specific logging destination (the producer project or the consumer project). Fields: logs: Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. monitoredResource: The monitored resource type. The type must be defined in Service.monitored_resources section. """ logs = _messages.StringField(1, repeated=True) monitoredResource = _messages.StringField(2) class ManagedService(_messages.Message): r"""The full representation of an API Service that is managed by the `ServiceManager` API. Includes both the service configuration, as well as other control plane deployment related information. Fields: configSource: User-supplied source configuration for the service. This is distinct from the generated configuration provided in `google.api.Service`. This is NOT populated on GetService calls at the moment. NOTE: Any upsert operation that contains both a service_config and a config_source is considered invalid and will result in an error being returned. generation: A server-assigned monotonically increasing number that changes whenever a mutation is made to the `ManagedService` or any of its components via the `ServiceManager` API. operations: Read-only view of pending operations affecting this resource, if requested. producerProjectId: ID of the project that produces and owns this service. projectSettings: Read-only view of settings for a particular consumer project, if requested. serviceConfig: The service's generated configuration. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. This name must match `google.api.Service.name` in the `service_config` field. """ configSource = _messages.MessageField('ConfigSource', 1) generation = _messages.IntegerField(2) operations = _messages.MessageField('Operation', 3, repeated=True) producerProjectId = _messages.StringField(4) projectSettings = _messages.MessageField('ProjectSettings', 5) serviceConfig = _messages.MessageField('Service', 6) serviceName = _messages.StringField(7) class MediaDownload(_messages.Message): r"""Do not use this. For media support, add instead [][google.bytestream.RestByteStream] as an API to your configuration. Fields: enabled: Whether download is enabled. """ enabled = _messages.BooleanField(1) class MediaUpload(_messages.Message): r"""Do not use this. For media support, add instead [][google.bytestream.RestByteStream] as an API to your configuration. Fields: enabled: Whether upload is enabled. """ enabled = _messages.BooleanField(1) class Method(_messages.Message): r"""Method represents a method of an api. Enums: SyntaxValueValuesEnum: The source syntax of this method. Fields: name: The simple name of this method. options: Any metadata attached to the method. requestStreaming: If true, the request is streamed. requestTypeUrl: A URL of the input message type. responseStreaming: If true, the response is streamed. responseTypeUrl: The URL of the output message type. syntax: The source syntax of this method. """ class SyntaxValueValuesEnum(_messages.Enum): r"""The source syntax of this method. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. """ SYNTAX_PROTO2 = 0 SYNTAX_PROTO3 = 1 name = _messages.StringField(1) options = _messages.MessageField('Option', 2, repeated=True) requestStreaming = _messages.BooleanField(3) requestTypeUrl = _messages.StringField(4) responseStreaming = _messages.BooleanField(5) responseTypeUrl = _messages.StringField(6) syntax = _messages.EnumField('SyntaxValueValuesEnum', 7) class MetricDescriptor(_messages.Message): r"""Defines a metric type and its schema. Enums: MetricKindValueValuesEnum: Whether the metric records instantaneous values, changes to a value, etc. ValueTypeValueValuesEnum: Whether the measurement is an integer, a floating-point number, etc. Fields: description: A detailed description of the metric, which can be used in documentation. displayName: A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". labels: The set of labels that can be used to describe a specific instance of this metric type. For example, the `compute.googleapis.com/instance/network/received_bytes_count` metric type has a label, `loadbalanced`, that specifies whether the traffic was received through a load balanced IP address. metricKind: Whether the metric records instantaneous values, changes to a value, etc. name: Resource name. The format of the name may vary between different implementations. For examples: projects/{project_id}/metricDescriptors/{type=} metricDescriptors/{type=} type: The metric type including a DNS name prefix, for example `"compute.googleapis.com/instance/cpu/utilization"`. Metric types should use a natural hierarchical grouping such as the following: compute.googleapis.com/instance/cpu/utilization compute.googleapis.com/instance/disk/read_ops_count compute.googleapis.com/instance/network/received_bytes_count Note that if the metric type changes, the monitoring data will be discontinued, and anything depends on it will break, such as monitoring dashboards, alerting rules and quota limits. Therefore, once a metric has been published, its type should be immutable. unit: The unit in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported units are a subset of [The Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html) standard: Basic units (UNIT) * `bit` bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day Prefixes (PREFIX) * `k` kilo (10*3) `M` mega (10*6) `G` giga (10*9) `T` tera (10*12) `P` peta (10*15) `E` exa (10*18) `Z` zetta (10*21) `Y` yotta (10*24) `m` milli (10*-3) `u` micro (10*-6) `n` nano (10*-9) `p` pico (10*-12) `f` femto (10*-15) `a` atto (10*-18) `z` zepto (10*-21) `y` yocto (10*-24) `Ki` kibi (2*10) `Mi` mebi (2*20) `Gi` gibi (2*30) `Ti` tebi (240) Grammar** The grammar includes the dimensionless unit `1`, such as `1/s`. The grammar also includes these connectors: * `/` division (as an infix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy.d`) The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = [ PREFIX ] UNIT [ Annotation ] \| Annotation \| "1" ; Annotation = "{" NAME "}" ; Notes: * `Annotation` is just a comment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For examples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing '{' or '}'. valueType: Whether the measurement is an integer, a floating-point number, etc. """ class MetricKindValueValuesEnum(_messages.Enum): r"""Whether the metric records instantaneous values, changes to a value, etc. Values: METRIC_KIND_UNSPECIFIED: Do not use this default value. GAUGE: Instantaneous measurements of a varying quantity. DELTA: Changes over non-overlapping time intervals. CUMULATIVE: Cumulative value over time intervals that can overlap. The overlapping intervals must have the same start time. """ METRIC_KIND_UNSPECIFIED = 0 GAUGE = 1 DELTA = 2 CUMULATIVE = 3 class ValueTypeValueValuesEnum(_messages.Enum): r"""Whether the measurement is an integer, a floating-point number, etc. Values: 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. """ VALUE_TYPE_UNSPECIFIED = 0 BOOL = 1 INT64 = 2 DOUBLE = 3 STRING = 4 DISTRIBUTION = 5 MONEY = 6 description = _messages.StringField(1) displayName = _messages.StringField(2) labels = _messages.MessageField('LabelDescriptor', 3, repeated=True) metricKind = _messages.EnumField('MetricKindValueValuesEnum', 4) name = _messages.StringField(5) type = _messages.StringField(6) unit = _messages.StringField(7) valueType = _messages.EnumField('ValueTypeValueValuesEnum', 8) class Mixin(_messages.Message): r"""Declares an API to be included in this API. The including API must redeclare all the methods from the included API, 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 API plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=}:getAcl"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=}:getAcl"; } ... } Fields: name: The fully qualified name of the API which is included. root: If non-empty specifies a path under which inherited HTTP paths are rooted. """ name = _messages.StringField(1) root = _messages.StringField(2) class MonitoredResourceDescriptor(_messages.Message): r"""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. Fields: description: Optional. A detailed description of the monitored resource type that might be used in documentation. displayName: Optional. A concise name for the monitored resource type that might be displayed in user interfaces. For example, `"Google Cloud SQL Database"`. labels: Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels `"database_id"` and `"zone"`. name: Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format `"monitoredResourceDescriptors/{type}"`. type: Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. The maximum length of this value is 256 characters. """ description = _messages.StringField(1) displayName = _messages.StringField(2) labels = _messages.MessageField('LabelDescriptor', 3, repeated=True) name = _messages.StringField(4) type = _messages.StringField(5) class Monitoring(_messages.Message): r"""Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/overdue_count` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. metrics: - name: library.googleapis.com/book/returned_count metric_kind: DELTA value_type: INT64 labels: - key: /customer_id - name: library.googleapis.com/book/overdue_count metric_kind: GAUGE value_type: INT64 labels: - key: /customer_id monitoring: producer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/overdue_count Fields: consumerDestinations: Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A metric can be used in at most one consumer destination. producerDestinations: Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A metric can be used in at most one producer destination. """ consumerDestinations = _messages.MessageField('MonitoringDestination', 1, repeated=True) producerDestinations = _messages.MessageField('MonitoringDestination', 2, repeated=True) class MonitoringDestination(_messages.Message): r"""Configuration of a specific monitoring destination (the producer project or the consumer project). Fields: metrics: Names of the metrics to report to this monitoring destination. Each name must be defined in Service.metrics section. monitoredResource: The monitored resource type. The type must be defined in Service.monitored_resources section. """ metrics = _messages.StringField(1, repeated=True) monitoredResource = _messages.StringField(2) class OAuthRequirements(_messages.Message): r"""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. Fields: canonicalScopes: 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 """ canonicalScopes = _messages.StringField(1) class OpenApiSpec(_messages.Message): r"""A collection of OpenAPI specification files. Fields: openApiFiles: Individual files. """ openApiFiles = _messages.MessageField('ConfigFile', 1, repeated=True) class Operation(_messages.Message): r"""This resource represents a long-running operation that is the result of a network API call. Messages: MetadataValue: 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. ResponseValue: 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`. Fields: done: 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. error: The error result of the operation in case of failure. metadata: 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. name: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. response: 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`. """ @encoding.MapUnrecognizedFields('additionalProperties') class MetadataValue(_messages.Message): r"""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. Messages: AdditionalProperty: An additional property for a MetadataValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a MetadataValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class ResponseValue(_messages.Message): r"""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`. Messages: AdditionalProperty: An additional property for a ResponseValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a ResponseValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) done = _messages.BooleanField(1) error = _messages.MessageField('Status', 2) metadata = _messages.MessageField('MetadataValue', 3) name = _messages.StringField(4) response = _messages.MessageField('ResponseValue', 5) class OperationMetadata(_messages.Message): r"""The metadata associated with a long running operation resource. Fields: progressPercentage: Percentage of completion of this operation, ranging from 0 to 100. resourceNames: The full name of the resources that this operation is directly associated with. startTime: The start time of the operation. steps: Detailed status information for each step. The order is undetermined. """ progressPercentage = _messages.IntegerField(1, variant=_messages.Variant.INT32) resourceNames = _messages.StringField(2, repeated=True) startTime = _messages.StringField(3) steps = _messages.MessageField('Step', 4, repeated=True) class Option(_messages.Message): r"""A protocol buffer option, which can be attached to a message, field, enumeration, etc. Messages: ValueValue: The option's value. For example, `"com.google.protobuf"`. Fields: name: The option's name. For example, `"java_package"`. value: The option's value. For example, `"com.google.protobuf"`. """ @encoding.MapUnrecognizedFields('additionalProperties') class ValueValue(_messages.Message): r"""The option's value. For example, `"com.google.protobuf"`. Messages: AdditionalProperty: An additional property for a ValueValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a ValueValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) name = _messages.StringField(1) value = _messages.MessageField('ValueValue', 2) class Page(_messages.Message): r"""Represents a documentation page. A page can contain subpages to represent nested documentation set structure. Fields: content: The Markdown content of the page. You can use <code>(== include {path} ==)</code> to include content from a Markdown file. name: The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: <pre><code>pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) </code></pre> You can reference `Java` page using Markdown reference link syntax: `Java`. subpages: Subpages of this page. The order of subpages specified here will be honored in the generated docset. """ content = _messages.StringField(1) name = _messages.StringField(2) subpages = _messages.MessageField('Page', 3, repeated=True) class ProjectProperties(_messages.Message): r"""A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be associated with a school, or a business, or a government agency, a business type property on the project may affect how a service responds to the client. This descriptor defines which properties are allowed to be set on a project. Example: project_properties: properties: - name: NO_WATERMARK type: BOOL description: Allows usage of the API without watermarks. - name: EXTENDED_TILE_CACHE_PERIOD type: INT64 Fields: properties: List of per consumer project-specific properties. """ properties = _messages.MessageField('Property', 1, repeated=True) class ProjectSettings(_messages.Message): r"""Settings that control how a consumer project uses a service. Messages: PropertiesValue: Service-defined per-consumer properties. A key-value mapping a string key to a google.protobuf.ListValue proto. Values in the list are typed as defined in the Service configuration's consumer.properties field. Fields: consumerProjectId: ID for the project consuming this service. operations: Read-only view of pending operations affecting this resource, if requested. properties: Service-defined per-consumer properties. A key-value mapping a string key to a google.protobuf.ListValue proto. Values in the list are typed as defined in the Service configuration's consumer.properties field. quotaSettings: Settings that control how much or how fast the service can be used by the consumer project. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. usageSettings: Settings that control whether this service is usable by the consumer project. visibilitySettings: Settings that control which features of the service are visible to the consumer project. """ @encoding.MapUnrecognizedFields('additionalProperties') class PropertiesValue(_messages.Message): r"""Service-defined per-consumer properties. A key-value mapping a string key to a google.protobuf.ListValue proto. Values in the list are typed as defined in the Service configuration's consumer.properties field. Messages: AdditionalProperty: An additional property for a PropertiesValue object. Fields: additionalProperties: Additional properties of type PropertiesValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a PropertiesValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2, repeated=True) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) consumerProjectId = _messages.StringField(1) operations = _messages.MessageField('Operation', 2, repeated=True) properties = _messages.MessageField('PropertiesValue', 3) quotaSettings = _messages.MessageField('QuotaSettings', 4) serviceName = _messages.StringField(5) usageSettings = _messages.MessageField('UsageSettings', 6) visibilitySettings = _messages.MessageField('VisibilitySettings', 7) class Property(_messages.Message): r"""Defines project properties. API services can define properties that can be assigned to consumer projects so that backends can perform response customization without having to make additional calls or maintain additional storage. For example, Maps API defines properties that controls map tile cache period, or whether to embed a watermark in a result. These values can be set via API producer console. Only API providers can define and set these properties. Enums: TypeValueValuesEnum: The type of this property. Fields: description: The description of the property name: The name of the property (a.k.a key). type: The type of this property. """ class TypeValueValuesEnum(_messages.Enum): r"""The type of this property. Values: UNSPECIFIED: The type is unspecified, and will result in an error. INT64: The type is `int64`. BOOL: The type is `bool`. STRING: The type is `string`. DOUBLE: The type is 'double'. """ UNSPECIFIED = 0 INT64 = 1 BOOL = 2 STRING = 3 DOUBLE = 4 description = _messages.StringField(1) name = _messages.StringField(2) type = _messages.EnumField('TypeValueValuesEnum', 3) class ProtoDescriptor(_messages.Message): r"""Contains a serialized protoc-generated protocol buffer message descriptor set along with a URL that describes the type of the descriptor message. Fields: typeUrl: A URL/resource name whose content describes the type of the serialized protocol buffer message. Only 'type.googleapis.com/google.protobuf.FileDescriptorSet' is supported. If the type_url is not specificed, 'type.googleapis.com/google.protobuf.FileDescriptorSet' will be assumed. value: Must be a valid serialized protocol buffer descriptor set. 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 descriptor.pb. $protoc --include_imports --include_source_info test.proto -o descriptor.pb """ typeUrl = _messages.StringField(1) value = _messages.BytesField(2) class ProtoSpec(_messages.Message): r"""A collection of protocol buffer service specification files. Fields: protoDescriptor: A complete descriptor of a protocol buffer specification """ protoDescriptor = _messages.MessageField('ProtoDescriptor', 1) class QueryUserAccessResponse(_messages.Message): r"""Request message for QueryUserAccess method. Fields: accessibleVisibilityLabels: Any visibility labels on the service that are accessible by the user. canAccessService: True if the user can access the service and any unrestricted API surface. """ accessibleVisibilityLabels = _messages.StringField(1, repeated=True) canAccessService = _messages.BooleanField(2) class Quota(_messages.Message): r"""Quota configuration helps to achieve fairness and budgeting in service usage. - Fairness is achieved through the use of short-term quota limits that are usually defined over a time window of several seconds or minutes. When such a limit is applied, for example at the user level, it ensures that no single user will monopolize the service or a given customer's allocated portion of it. - Budgeting is achieved through the use of long- term quota limits that are usually defined over a time window of one or more days. These limits help client application developers predict the usage and help budgeting. Quota enforcement uses a simple token-based algorithm for resource sharing. The quota configuration structure is as follows: - `QuotaLimit` defines a single enforceable limit with a specified token amount that can be consumed over a specific duration and applies to a particular entity, like a project or an end user. If the limit applies to a user, each user making the request will get the specified number of tokens to consume. When the tokens run out, the requests from that user will be blocked until the duration elapses and the next duration window starts. - `QuotaGroup` groups a set of quota limits. - `QuotaRule` maps a method to a set of quota groups. This allows sharing of quota groups across methods as well as one method consuming tokens from more than one quota group. When a group contains multiple limits, requests to a method consuming tokens from that group must satisfy all the limits in that group. Example: quota: groups: - name: ReadGroup limits: - description: Daily Limit name: ProjectQpd default_limit: 10000 duration: 1d limit_by: CLIENT_PROJECT - description: Per-second Limit name: UserQps default_limit: 20000 duration: 100s limit_by: USER - name: WriteGroup limits: - description: Daily Limit name: ProjectQpd default_limit: 1000 max_limit: 1000 duration: 1d limit_by: CLIENT_PROJECT - description: Per-second Limit name: UserQps default_limit: 2000 max_limit: 4000 duration: 100s limit_by: USER rules: - selector: "" groups: - group: ReadGroup - selector: google.calendar.Calendar.Update groups: - group: WriteGroup cost: 2 - selector: google.calendar.Calendar.Delete groups: - group: WriteGroup Here, the configuration defines two quota groups: ReadGroup and WriteGroup, each defining its own daily and per-second limits. Note that One Platform enforces per-second limits averaged over a duration of 100 seconds. The rules map ReadGroup for all methods, except for the Update and Delete methods. These two methods consume from WriteGroup, with Update method consuming at twice the rate as Delete method. Multiple quota groups can be specified for a method. The quota limits in all of those groups will be enforced. Example: quota: groups: - name: WriteGroup limits: - description: Daily Limit name: ProjectQpd default_limit: 1000 max_limit: 1000 duration: 1d limit_by: CLIENT_PROJECT - description: Per- second Limit name: UserQps default_limit: 2000 max_limit: 4000 duration: 100s limit_by: USER - name: StorageGroup limits: - description: Storage Quota name: StorageQuota default_limit: 1000 duration: 0 limit_by: USER rules: - selector: google.calendar.Calendar.Create groups: - group: StorageGroup - group: WriteGroup - selector: google.calendar.Calendar.Delete groups: - group: StorageGroup In the above example, the Create and Delete methods manage the user's storage space. In addition, Create method uses WriteGroup to manage the requests. In this case, requests to Create method need to satisfy all quota limits defined in both quota groups. One can disable quota for selected method(s) identified by the selector by setting disable_quota to ture. For example, rules: - selector: "" group: - group ReadGroup - selector: google.calendar.Calendar.Select disable_quota: true Fields: groups: List of `QuotaGroup` definitions for the service. rules: List of `QuotaRule` definitions, each one mapping a selected method to one or more quota groups. """ groups = _messages.MessageField('QuotaGroup', 1, repeated=True) rules = _messages.MessageField('QuotaRule', 2, repeated=True) class QuotaGroup(_messages.Message): r"""`QuotaGroup` defines a set of quota limits to enforce. Fields: billable: Indicates if the quota limits defined in this quota group apply to consumers who have active billing. Quota limits defined in billable groups will be applied only to consumers who have active billing. The amount of tokens consumed from billable quota group will also be reported for billing. Quota limits defined in non-billable groups will be applied only to consumers who have no active billing. description: User-visible description of this quota group. limits: Quota limits to be enforced when this quota group is used. A request must satisfy all the limits in a group for it to be permitted. name: Name of this quota group. Must be unique within the service. Quota group name is used as part of the id for quota limits. Once the quota group has been put into use, the name of the quota group should be immutable. """ billable = _messages.BooleanField(1) description = _messages.StringField(2) limits = _messages.MessageField('QuotaLimit', 3, repeated=True) name = _messages.StringField(4) class QuotaGroupMapping(_messages.Message): r"""A quota group mapping. Fields: cost: Number of tokens to consume for each request. This allows different cost to be associated with different methods that consume from the same quota group. By default, each request will cost one token. group: The `QuotaGroup.name` of the group. Requests for the mapped methods will consume tokens from each of the limits defined in this group. """ cost = _messages.IntegerField(1, variant=_messages.Variant.INT32) group = _messages.StringField(2) class QuotaInfo(_messages.Message): r"""Metadata about an individual quota, containing usage and limit information. Fields: currentUsage: The usage data for this quota as it applies to the current limit. historicalUsage: The historical usage data of this quota limit. Currently it is only available for daily quota limit, that is, base_limit.duration = "1d". limit: The effective limit for this quota. """ currentUsage = _messages.MessageField('QuotaUsage', 1) historicalUsage = _messages.MessageField('QuotaUsage', 2, repeated=True) limit = _messages.MessageField('EffectiveQuotaLimit', 3) class QuotaLimit(_messages.Message): r"""`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`. Enums: LimitByValueValuesEnum: Limit type to use for enforcing this quota limit. Each unique value gets the defined number of tokens to consume from. For a quota limit that uses user type, each user making requests through the same client application project will get his/her own pool of tokens to consume, whereas for a limit that uses client project type, all users making requests through the same client application project share a single pool of tokens. Fields: defaultLimit: 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. description: Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see: `display_name`). displayName: 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. duration: Duration of this limit in textual notation. Example: "100s", "24h", "1d". For duration longer than a day, only multiple of days is supported. We support only "100s" and "1d" for now. Additional support will be added in the future. "0" indicates indefinite duration. freeTier: 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. limitBy: Limit type to use for enforcing this quota limit. Each unique value gets the defined number of tokens to consume from. For a quota limit that uses user type, each user making requests through the same client application project will get his/her own pool of tokens to consume, whereas for a limit that uses client project type, all users making requests through the same client application project share a single pool of tokens. maxLimit: 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. name: Name of the quota limit. Must be unique within the quota group. This name is used to refer to the limit when overriding the limit on a per-project basis. If a name is not provided, it will be generated from the limit_by and duration fields. The maximum length of the limit name is 64 characters. The name of a limit is used as a unique identifier for this limit. Therefore, once a limit has been put into use, its name should be immutable. You can use the display_name field to provide a user-friendly name for the limit. The display name can be evolved over time without affecting the identity of the limit. """ class LimitByValueValuesEnum(_messages.Enum): r"""Limit type to use for enforcing this quota limit. Each unique value gets the defined number of tokens to consume from. For a quota limit that uses user type, each user making requests through the same client application project will get his/her own pool of tokens to consume, whereas for a limit that uses client project type, all users making requests through the same client application project share a single pool of tokens. Values: CLIENT_PROJECT: ID of the project owned by the client application developer making the request. USER: ID of the end user making the request using the client application. """ CLIENT_PROJECT = 0 USER = 1 defaultLimit = _messages.IntegerField(1) description = _messages.StringField(2) displayName = _messages.StringField(3) duration = _messages.StringField(4) freeTier = _messages.IntegerField(5) limitBy = _messages.EnumField('LimitByValueValuesEnum', 6) maxLimit = _messages.IntegerField(7) name = _messages.StringField(8) class QuotaLimitOverride(_messages.Message): r"""Specifies a custom quota limit that is applied for this consumer project. This overrides the default value in google.api.QuotaLimit. Fields: limit: The new limit for this project. May be -1 (unlimited), 0 (block), or any positive integer. unlimited: Indicates the override is to provide unlimited quota. If true, any value set for limit will be ignored. DEPRECATED. Use a limit value of -1 instead. """ limit = _messages.IntegerField(1) unlimited = _messages.BooleanField(2) class QuotaRule(_messages.Message): r"""`QuotaRule` maps a method to a set of `QuotaGroup`s. Fields: disableQuota: Indicates if quota checking should be enforced. Quota will be disabled for methods without quota rules or with quota rules having this field set to true. When this field is set to true, no quota group mapping is allowed. groups: Quota groups to be used for this method. This supports associating a cost with each quota group. selector: Selects methods to which this rule applies. Refer to selector for syntax details. """ disableQuota = _messages.BooleanField(1) groups = _messages.MessageField('QuotaGroupMapping', 2, repeated=True) selector = _messages.StringField(3) class QuotaSettings(_messages.Message): r"""Per-consumer overrides for quota settings. See google/api/quota.proto for the corresponding service configuration which provides the default values. Messages: ConsumerOverridesValue: Quota overrides set by the consumer. Consumer overrides will only have an effect up to the max_limit specified in the service config, or the the producer override, if one exists. The key for this map is one of the following: - '<GROUP_NAME>/<LIMIT_NAME>' for quotas defined within quota groups, where GROUP_NAME is the google.api.QuotaGroup.name field and LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'ReadGroup/ProjectDaily'. - '<LIMIT_NAME>' for quotas defined without quota groups, where LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'borrowedCountPerOrganization'. EffectiveQuotasValue: The effective quota limits for each group, derived from the service defaults together with any producer or consumer overrides. For each limit, the effective value is the minimum of the producer and consumer overrides if either is present, or else the service default if neither is present. DEPRECATED. Use effective_quota_groups instead. ProducerOverridesValue: Quota overrides set by the producer. Note that if a consumer override is also specified, then the minimum of the two will be used. This allows consumers to cap their usage voluntarily. The key for this map is one of the following: - '<GROUP_NAME>/<LIMIT_NAME>' for quotas defined within quota groups, where GROUP_NAME is the google.api.QuotaGroup.name field and LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'ReadGroup/ProjectDaily'. - '<LIMIT_NAME>' for quotas defined without quota groups, where LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'borrowedCountPerOrganization'. Fields: consumerOverrides: Quota overrides set by the consumer. Consumer overrides will only have an effect up to the max_limit specified in the service config, or the the producer override, if one exists. The key for this map is one of the following: - '<GROUP_NAME>/<LIMIT_NAME>' for quotas defined within quota groups, where GROUP_NAME is the google.api.QuotaGroup.name field and LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'ReadGroup/ProjectDaily'. - '<LIMIT_NAME>' for quotas defined without quota groups, where LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'borrowedCountPerOrganization'. effectiveQuotaGroups: Use this field for quota limits defined under quota groups. Combines service quota configuration and project-specific settings, as a map from quota group name to the effective quota information for that group. Output-only. effectiveQuotas: The effective quota limits for each group, derived from the service defaults together with any producer or consumer overrides. For each limit, the effective value is the minimum of the producer and consumer overrides if either is present, or else the service default if neither is present. DEPRECATED. Use effective_quota_groups instead. producerOverrides: Quota overrides set by the producer. Note that if a consumer override is also specified, then the minimum of the two will be used. This allows consumers to cap their usage voluntarily. The key for this map is one of the following: - '<GROUP_NAME>/<LIMIT_NAME>' for quotas defined within quota groups, where GROUP_NAME is the google.api.QuotaGroup.name field and LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'ReadGroup/ProjectDaily'. - '<LIMIT_NAME>' for quotas defined without quota groups, where LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'borrowedCountPerOrganization'. variableTermQuotas: Quotas that are active over a specified time period. Only writeable by the producer. """ @encoding.MapUnrecognizedFields('additionalProperties') class ConsumerOverridesValue(_messages.Message): r"""Quota overrides set by the consumer. Consumer overrides will only have an effect up to the max_limit specified in the service config, or the the producer override, if one exists. The key for this map is one of the following: - '<GROUP_NAME>/<LIMIT_NAME>' for quotas defined within quota groups, where GROUP_NAME is the google.api.QuotaGroup.name field and LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'ReadGroup/ProjectDaily'. - '<LIMIT_NAME>' for quotas defined without quota groups, where LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'borrowedCountPerOrganization'. Messages: AdditionalProperty: An additional property for a ConsumerOverridesValue object. Fields: additionalProperties: Additional properties of type ConsumerOverridesValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a ConsumerOverridesValue object. Fields: key: Name of the additional property. value: A QuotaLimitOverride attribute. """ key = _messages.StringField(1) value = _messages.MessageField('QuotaLimitOverride', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class EffectiveQuotasValue(_messages.Message): r"""The effective quota limits for each group, derived from the service defaults together with any producer or consumer overrides. For each limit, the effective value is the minimum of the producer and consumer overrides if either is present, or else the service default if neither is present. DEPRECATED. Use effective_quota_groups instead. Messages: AdditionalProperty: An additional property for a EffectiveQuotasValue object. Fields: additionalProperties: Additional properties of type EffectiveQuotasValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a EffectiveQuotasValue object. Fields: key: Name of the additional property. value: A QuotaLimitOverride attribute. """ key = _messages.StringField(1) value = _messages.MessageField('QuotaLimitOverride', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class ProducerOverridesValue(_messages.Message): r"""Quota overrides set by the producer. Note that if a consumer override is also specified, then the minimum of the two will be used. This allows consumers to cap their usage voluntarily. The key for this map is one of the following: - '<GROUP_NAME>/<LIMIT_NAME>' for quotas defined within quota groups, where GROUP_NAME is the google.api.QuotaGroup.name field and LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'ReadGroup/ProjectDaily'. - '<LIMIT_NAME>' for quotas defined without quota groups, where LIMIT_NAME is the google.api.QuotaLimit.name field from the service config. For example: 'borrowedCountPerOrganization'. Messages: AdditionalProperty: An additional property for a ProducerOverridesValue object. Fields: additionalProperties: Additional properties of type ProducerOverridesValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a ProducerOverridesValue object. Fields: key: Name of the additional property. value: A QuotaLimitOverride attribute. """ key = _messages.StringField(1) value = _messages.MessageField('QuotaLimitOverride', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) consumerOverrides = _messages.MessageField('ConsumerOverridesValue', 1) effectiveQuotaGroups = _messages.MessageField('EffectiveQuotaGroup', 2, repeated=True) effectiveQuotas = _messages.MessageField('EffectiveQuotasValue', 3) producerOverrides = _messages.MessageField('ProducerOverridesValue', 4) variableTermQuotas = _messages.MessageField('VariableTermQuota', 5, repeated=True) class QuotaUsage(_messages.Message): r"""Specifies the used quota amount for a quota limit at a particular time. Fields: endTime: The time the quota duration ended. queryTime: The time the quota usage data was queried. startTime: The time the quota duration started. usage: The used quota value at the "query_time". """ endTime = _messages.StringField(1) queryTime = _messages.StringField(2) startTime = _messages.StringField(3) usage = _messages.IntegerField(4) class Service(_messages.Message): r"""`Service` is the root object of the configuration schema. It describes basic information like the name of the service and the exposed API interfaces, and delegates other aspects to configuration sub-sections. Example: type: google.api.Service config_version: 1 name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.Calendar backend: rules: - selector: "" address: calendar.example.com Fields: apis: 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. authentication: Auth configuration. backend: API backend configuration. billing: Billing configuration of the service. configVersion: The version of the service configuration. The config version may influence interpretation of the configuration, for example, to determine defaults. This is documented together with applicable options. The current default for the config version itself is `3`. context: Context configuration. control: Configuration for the service control plane. customError: Custom error configuration. documentation: Additional API documentation. enums: 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 http: HTTP configuration. id: 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. logging: Logging configuration of the service. logs: Defines the logs used by this service. metrics: Defines the metrics used by this service. monitoredResources: Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. monitoring: Monitoring configuration of the service. name: The DNS address at which this service is available, e.g. `calendar.googleapis.com`. producerProjectId: The id of the Google developer project that owns the service. Members of this project can manage the service configuration, manage consumption of the service, etc. projectProperties: Configuration of per-consumer project properties. quota: Quota configuration. systemParameters: Configuration for system parameters. systemTypes: 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. title: The product title associated with this service. types: 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 usage: Configuration controlling usage of this service. visibility: API visibility configuration. """ apis = _messages.MessageField('Api', 1, repeated=True) authentication = _messages.MessageField('Authentication', 2) backend = _messages.MessageField('Backend', 3) billing = _messages.MessageField('Billing', 4) configVersion = _messages.IntegerField(5, variant=_messages.Variant.UINT32) context = _messages.MessageField('Context', 6) control = _messages.MessageField('Control', 7) customError = _messages.MessageField('CustomError', 8) documentation = _messages.MessageField('Documentation', 9) enums = _messages.MessageField('Enum', 10, repeated=True) http = _messages.MessageField('Http', 11) id = _messages.StringField(12) logging = _messages.MessageField('Logging', 13) logs = _messages.MessageField('LogDescriptor', 14, repeated=True) metrics = _messages.MessageField('MetricDescriptor', 15, repeated=True) monitoredResources = _messages.MessageField('MonitoredResourceDescriptor', 16, repeated=True) monitoring = _messages.MessageField('Monitoring', 17) name = _messages.StringField(18) producerProjectId = _messages.StringField(19) projectProperties = _messages.MessageField('ProjectProperties', 20) quota = _messages.MessageField('Quota', 21) systemParameters = _messages.MessageField('SystemParameters', 22) systemTypes = _messages.MessageField('Type', 23, repeated=True) title = _messages.StringField(24) types = _messages.MessageField('Type', 25, repeated=True) usage = _messages.MessageField('Usage', 26) visibility = _messages.MessageField('Visibility', 27) class ServiceAccessList(_messages.Message): r"""List of users and groups that are granted access to a service or visibility label. Fields: members: Members that are granted access. - "user:{$user_email}" - Grant access to an individual user - "group:{$group_email}" - Grant access to direct members of the group - "domain:{$domain}" - Grant access to all members of the domain. For now, domain membership check will be similar to Devconsole/TT check: compare domain part of the user email to configured domain name. When IAM integration is complete, this will be replaced with IAM check. """ members = _messages.StringField(1, repeated=True) class ServiceAccessPolicy(_messages.Message): r"""Policy describing who can access a service and any visibility labels on that service. Messages: VisibilityLabelAccessListsValue: ACLs for access to restricted parts of the service. The map key is the visibility label that is being controlled. Note that access to any label also implies access to the unrestricted surface. Fields: accessList: ACL for access to the unrestricted surface of the service. serviceName: The service protected by this policy. visibilityLabelAccessLists: ACLs for access to restricted parts of the service. The map key is the visibility label that is being controlled. Note that access to any label also implies access to the unrestricted surface. """ @encoding.MapUnrecognizedFields('additionalProperties') class VisibilityLabelAccessListsValue(_messages.Message): r"""ACLs for access to restricted parts of the service. The map key is the visibility label that is being controlled. Note that access to any label also implies access to the unrestricted surface. Messages: AdditionalProperty: An additional property for a VisibilityLabelAccessListsValue object. Fields: additionalProperties: Additional properties of type VisibilityLabelAccessListsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a VisibilityLabelAccessListsValue object. Fields: key: Name of the additional property. value: A ServiceAccessList attribute. """ key = _messages.StringField(1) value = _messages.MessageField('ServiceAccessList', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) accessList = _messages.MessageField('ServiceAccessList', 1) serviceName = _messages.StringField(2) visibilityLabelAccessLists = _messages.MessageField('VisibilityLabelAccessListsValue', 3) class ServicemanagementOperationsGetRequest(_messages.Message): r"""A ServicemanagementOperationsGetRequest object. Fields: operationsId: Part of `name`. The name of the operation resource. """ operationsId = _messages.StringField(1, required=True) class ServicemanagementServicesAccessPolicyQueryRequest(_messages.Message): r"""A ServicemanagementServicesAccessPolicyQueryRequest object. Fields: serviceName: The service to query access for. userEmail: The user to query access for. """ serviceName = _messages.StringField(1, required=True) userEmail = _messages.StringField(2) class ServicemanagementServicesConfigsCreateRequest(_messages.Message): r"""A ServicemanagementServicesConfigsCreateRequest object. Fields: service: A Service resource to be passed as the request body. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. """ service = _messages.MessageField('Service', 1) serviceName = _messages.StringField(2, required=True) class ServicemanagementServicesConfigsGetRequest(_messages.Message): r"""A ServicemanagementServicesConfigsGetRequest object. Fields: configId: The id of the service config resource. Optional. If it is not specified, the latest version of config will be returned. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. """ configId = _messages.StringField(1, required=True) serviceName = _messages.StringField(2, required=True) class ServicemanagementServicesConfigsListRequest(_messages.Message): r"""A ServicemanagementServicesConfigsListRequest object. Fields: pageSize: The max number of items to include in the response list. pageToken: The token of the page to retrieve. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) serviceName = _messages.StringField(3, required=True) class ServicemanagementServicesConfigsSubmitRequest(_messages.Message): r"""A ServicemanagementServicesConfigsSubmitRequest object. Fields: serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. submitConfigSourceRequest: A SubmitConfigSourceRequest resource to be passed as the request body. """ serviceName = _messages.StringField(1, required=True) submitConfigSourceRequest = _messages.MessageField('SubmitConfigSourceRequest', 2) class ServicemanagementServicesCustomerSettingsGetRequest(_messages.Message): r"""A ServicemanagementServicesCustomerSettingsGetRequest object. Enums: ViewValueValuesEnum: Request only fields for the specified view. Fields: customerId: ID for the customer. See the comment for `CustomerSettings.customer_id` field of message for its format. This field is required. expand: Fields to expand in any results. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. This field is required. view: Request only fields for the specified view. """ class ViewValueValuesEnum(_messages.Enum): r"""Request only fields for the specified view. Values: PROJECT_SETTINGS_VIEW_UNSPECIFIED: <no description> CONSUMER_VIEW: <no description> PRODUCER_VIEW: <no description> ALL: <no description> """ PROJECT_SETTINGS_VIEW_UNSPECIFIED = 0 CONSUMER_VIEW = 1 PRODUCER_VIEW = 2 ALL = 3 customerId = _messages.StringField(1, required=True) expand = _messages.StringField(2) serviceName = _messages.StringField(3, required=True) view = _messages.EnumField('ViewValueValuesEnum', 4) class ServicemanagementServicesCustomerSettingsPatchRequest(_messages.Message): r"""A ServicemanagementServicesCustomerSettingsPatchRequest object. Fields: customerId: ID for the customer. See the comment for `CustomerSettings.customer_id` field of message for its format. This field is required. customerSettings: A CustomerSettings resource to be passed as the request body. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. This field is required. updateMask: The field mask specifying which fields are to be updated. """ customerId = _messages.StringField(1, required=True) customerSettings = _messages.MessageField('CustomerSettings', 2) serviceName = _messages.StringField(3, required=True) updateMask = _messages.StringField(4) class ServicemanagementServicesDeleteRequest(_messages.Message): r"""A ServicemanagementServicesDeleteRequest object. Fields: serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. """ serviceName = _messages.StringField(1, required=True) class ServicemanagementServicesDisableRequest(_messages.Message): r"""A ServicemanagementServicesDisableRequest object. Fields: disableServiceRequest: A DisableServiceRequest resource to be passed as the request body. serviceName: Name of the service to disable. Specifying an unknown service name will cause the request to fail. """ disableServiceRequest = _messages.MessageField('DisableServiceRequest', 1) serviceName = _messages.StringField(2, required=True) class ServicemanagementServicesEnableRequest(_messages.Message): r"""A ServicemanagementServicesEnableRequest object. Fields: enableServiceRequest: A EnableServiceRequest resource to be passed as the request body. serviceName: Name of the service to enable. Specifying an unknown service name will cause the request to fail. """ enableServiceRequest = _messages.MessageField('EnableServiceRequest', 1) serviceName = _messages.StringField(2, required=True) class ServicemanagementServicesGetAccessPolicyRequest(_messages.Message): r"""A ServicemanagementServicesGetAccessPolicyRequest object. Fields: serviceName: The name of the service. For example: `example.googleapis.com`. """ serviceName = _messages.StringField(1, required=True) class ServicemanagementServicesGetConfigRequest(_messages.Message): r"""A ServicemanagementServicesGetConfigRequest object. Fields: configId: The id of the service config resource. Optional. If it is not specified, the latest version of config will be returned. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. """ configId = _messages.StringField(1) serviceName = _messages.StringField(2, required=True) class ServicemanagementServicesGetRequest(_messages.Message): r"""A ServicemanagementServicesGetRequest object. Enums: ViewValueValuesEnum: If project_settings is expanded, request only fields for the specified view. Fields: consumerProjectId: If project_settings is expanded, return settings for the specified consumer project. expand: Fields to expand in any results. By default, the following fields are not present in the result: - `operations` - `project_settings` - `project_settings.operations` - `quota_usage` (It requires `project_settings`) - `historical_quota_usage` (It requires `project_settings`) serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. view: If project_settings is expanded, request only fields for the specified view. """ class ViewValueValuesEnum(_messages.Enum): r"""If project_settings is expanded, request only fields for the specified view. Values: PROJECT_SETTINGS_VIEW_UNSPECIFIED: <no description> CONSUMER_VIEW: <no description> PRODUCER_VIEW: <no description> ALL: <no description> """ PROJECT_SETTINGS_VIEW_UNSPECIFIED = 0 CONSUMER_VIEW = 1 PRODUCER_VIEW = 2 ALL = 3 consumerProjectId = _messages.StringField(1) expand = _messages.StringField(2) serviceName = _messages.StringField(3, required=True) view = _messages.EnumField('ViewValueValuesEnum', 4) class ServicemanagementServicesListRequest(_messages.Message): r"""A ServicemanagementServicesListRequest object. Fields: category: Include services only in the specified category. Supported categories are servicemanagement.googleapis.com/categories/google- services or servicemanagement.googleapis.com/categories/play-games. consumerProjectId: Include services consumed by the specified project. If project_settings is expanded, then this field controls which project project_settings is populated for. expand: Fields to expand in any results. By default, the following fields are not fully included in list results: - `operations` - `project_settings` - `project_settings.operations` - `quota_usage` (It requires `project_settings`) pageSize: Requested size of the next page of data. pageToken: Token identifying which result to start with; returned by a previous list call. producerProjectId: Include services produced by the specified project. """ category = _messages.StringField(1) consumerProjectId = _messages.StringField(2) expand = _messages.StringField(3) pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32) pageToken = _messages.StringField(5) producerProjectId = _messages.StringField(6) class ServicemanagementServicesPatchConfigRequest(_messages.Message): r"""A ServicemanagementServicesPatchConfigRequest object. Fields: service: A Service resource to be passed as the request body. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. updateMask: A mask specifying which fields to update. """ service = _messages.MessageField('Service', 1) serviceName = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class ServicemanagementServicesPatchRequest(_messages.Message): r"""A ServicemanagementServicesPatchRequest object. Fields: managedService: A ManagedService resource to be passed as the request body. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. updateMask: A mask specifying which fields to update. """ managedService = _messages.MessageField('ManagedService', 1) serviceName = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class ServicemanagementServicesProjectSettingsGetRequest(_messages.Message): r"""A ServicemanagementServicesProjectSettingsGetRequest object. Enums: ViewValueValuesEnum: Request only the fields for the specified view. Fields: consumerProjectId: The project ID of the consumer. expand: Fields to expand in any results. By default, the following fields are not present in the result: - `operations` - `quota_usage` serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. view: Request only the fields for the specified view. """ class ViewValueValuesEnum(_messages.Enum): r"""Request only the fields for the specified view. Values: PROJECT_SETTINGS_VIEW_UNSPECIFIED: <no description> CONSUMER_VIEW: <no description> PRODUCER_VIEW: <no description> ALL: <no description> """ PROJECT_SETTINGS_VIEW_UNSPECIFIED = 0 CONSUMER_VIEW = 1 PRODUCER_VIEW = 2 ALL = 3 consumerProjectId = _messages.StringField(1, required=True) expand = _messages.StringField(2) serviceName = _messages.StringField(3, required=True) view = _messages.EnumField('ViewValueValuesEnum', 4) class ServicemanagementServicesProjectSettingsPatchRequest(_messages.Message): r"""A ServicemanagementServicesProjectSettingsPatchRequest object. Fields: consumerProjectId: The project ID of the consumer. projectSettings: A ProjectSettings resource to be passed as the request body. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. updateMask: The field mask specifying which fields are to be updated. """ consumerProjectId = _messages.StringField(1, required=True) projectSettings = _messages.MessageField('ProjectSettings', 2) serviceName = _messages.StringField(3, required=True) updateMask = _messages.StringField(4) class ServicemanagementServicesUpdateConfigRequest(_messages.Message): r"""A ServicemanagementServicesUpdateConfigRequest object. Fields: service: A Service resource to be passed as the request body. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. updateMask: A mask specifying which fields to update. Update mask has been deprecated on UpdateServiceConfig service method. Please use PatchServiceConfig method instead to do partial updates. """ service = _messages.MessageField('Service', 1) serviceName = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class ServicemanagementServicesUpdateRequest(_messages.Message): r"""A ServicemanagementServicesUpdateRequest object. Fields: managedService: A ManagedService resource to be passed as the request body. serviceName: The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. updateMask: A mask specifying which fields to update. Update mask has been deprecated on UpdateService service method. Please use PatchService method instead to do partial updates. """ managedService = _messages.MessageField('ManagedService', 1) serviceName = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class SourceContext(_messages.Message): r"""`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. Fields: fileName: The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. """ fileName = _messages.StringField(1) class StandardQueryParameters(_messages.Message): r"""Query parameters accepted by all methods. Enums: FXgafvValueValuesEnum: V1 error format. AltValueValuesEnum: Data format for response. Fields: f__xgafv: V1 error format. access_token: OAuth access token. alt: Data format for response. bearer_token: OAuth bearer token. callback: JSONP fields: Selector specifying which fields to include in a partial response. key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. oauth_token: OAuth 2.0 token for the current user. pp: Pretty-print response. prettyPrint: Returns response with indentations and line breaks. quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. trace: A tracing token of the form "token:<tokenid>" to include in api requests. uploadType: Legacy upload protocol for media (e.g. "media", "multipart"). upload_protocol: Upload protocol for media (e.g. "raw", "multipart"). """ class AltValueValuesEnum(_messages.Enum): r"""Data format for response. Values: json: Responses with Content-Type of application/json media: Media download with context-dependent Content-Type proto: Responses with Content-Type of application/x-protobuf """ json = 0 media = 1 proto = 2 class FXgafvValueValuesEnum(_messages.Enum): r"""V1 error format. Values: _1: v1 error format _2: v2 error format """ _1 = 0 _2 = 1 f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1) access_token = _messages.StringField(2) alt = _messages.EnumField('AltValueValuesEnum', 3, default='json') bearer_token = _messages.StringField(4) callback = _messages.StringField(5) fields = _messages.StringField(6) key = _messages.StringField(7) oauth_token = _messages.StringField(8) pp = _messages.BooleanField(9, default=True) prettyPrint = _messages.BooleanField(10, default=True) quotaUser = _messages.StringField(11) trace = _messages.StringField(12) uploadType = _messages.StringField(13) upload_protocol = _messages.StringField(14) class Status(_messages.Message): r"""The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand* and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub- response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. Messages: DetailsValueListEntry: A DetailsValueListEntry object. Fields: code: The status code, which should be an enum value of google.rpc.Code. details: A list of messages that carry the error details. There will be a common set of message types for APIs to use. message: 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. """ @encoding.MapUnrecognizedFields('additionalProperties') class DetailsValueListEntry(_messages.Message): r"""A DetailsValueListEntry object. Messages: AdditionalProperty: An additional property for a DetailsValueListEntry object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a DetailsValueListEntry object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) code = _messages.IntegerField(1, variant=_messages.Variant.INT32) details = _messages.MessageField('DetailsValueListEntry', 2, repeated=True) message = _messages.StringField(3) class Step(_messages.Message): r"""Represents the status of one operation step. Enums: StatusValueValuesEnum: The status code. Fields: description: The short description of the step. status: The status code. """ class StatusValueValuesEnum(_messages.Enum): r"""The status code. Values: STATUS_UNSPECIFIED: Unspecifed code. DONE: The step has completed without errors. NOT_STARTED: The step has not started yet. IN_PROGRESS: The step is in progress. FAILED: The step has completed with errors. """ STATUS_UNSPECIFIED = 0 DONE = 1 NOT_STARTED = 2 IN_PROGRESS = 3 FAILED = 4 description = _messages.StringField(1) status = _messages.EnumField('StatusValueValuesEnum', 2) class SubmitConfigSourceRequest(_messages.Message): r"""Request message for SubmitConfigSource method. Fields: configSource: The source configuration for the service. validateOnly: Optional. If set, this will result in the generation of a `google.api.Service` configuration based on the `ConfigSource` provided, but the generated config and the sources will NOT be persisted. """ configSource = _messages.MessageField('ConfigSource', 1) validateOnly = _messages.BooleanField(2) class SwaggerSpec(_messages.Message): r"""A collection of swagger specification files. Fields: swaggerFiles: The individual files. """ swaggerFiles = _messages.MessageField('File', 1, repeated=True) class SystemParameter(_messages.Message): r"""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. Fields: httpHeader: Define the HTTP header name to use for the parameter. It is case insensitive. name: Define the name of the parameter, such as "api_key", "alt", "callback", and etc. It is case sensitive. urlQueryParameter: Define the URL query parameter name to use for the parameter. It is case sensitive. """ httpHeader = _messages.StringField(1) name = _messages.StringField(2) urlQueryParameter = _messages.StringField(3) class SystemParameterRule(_messages.Message): r"""Define a system parameter rule mapping system parameter definitions to methods. Fields: parameters: 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. selector: Selects the methods to which this rule applies. Use '' to indicate all methods in all APIs. Refer to selector for syntax details. """ parameters = _messages.MessageField('SystemParameter', 1, repeated=True) selector = _messages.StringField(2) class SystemParameters(_messages.Message): r"""### 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. Fields: rules: 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 and alt name for all methods system_parameters rules: - selector: "" parameters: - name: api_key url_query_parameter: api_key - name: alt http_header: Response-Content-Type 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 """ rules = _messages.MessageField('SystemParameterRule', 1, repeated=True) class Type(_messages.Message): r"""A protocol buffer message type. Enums: SyntaxValueValuesEnum: The source syntax. Fields: fields: The list of fields. name: The fully qualified message name. oneofs: The list of types appearing in `oneof` definitions in this type. options: The protocol buffer options. sourceContext: The source context. syntax: The source syntax. """ class SyntaxValueValuesEnum(_messages.Enum): r"""The source syntax. Values: SYNTAX_PROTO2: Syntax `proto2`. SYNTAX_PROTO3: Syntax `proto3`. """ SYNTAX_PROTO2 = 0 SYNTAX_PROTO3 = 1 fields = _messages.MessageField('Field', 1, repeated=True) name = _messages.StringField(2) oneofs = _messages.StringField(3, repeated=True) options = _messages.MessageField('Option', 4, repeated=True) sourceContext = _messages.MessageField('SourceContext', 5) syntax = _messages.EnumField('SyntaxValueValuesEnum', 6) class Usage(_messages.Message): r"""Configuration controlling usage of a service. Enums: ServiceAccessValueValuesEnum: Controls which users can see or activate the service. Fields: activationHooks: Services that must be contacted before a consumer can begin using the service. Each service will be contacted in sequence, and, if any activation call fails, the entire activation will fail. Each hook is of the form <service.name>/<hook-id>, where <hook-id> is optional; for example: 'robotservice.googleapis.com/default'. deactivationHooks: Services that must be contacted before a consumer can deactivate a service. Each service will be contacted in sequence, and, if any deactivation call fails, the entire deactivation will fail. Each hook is of the form <service.name>/<hook-id>, where <hook-id> is optional; for example: 'compute.googleapis.com/'. dependsOnServices: Services that must be activated in order for this service to be used. The set of services activated as a result of these relations are all activated in parallel with no guaranteed order of activation. Each string is a service name, e.g. `calendar.googleapis.com`. requirements: Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; for example 'serviceusage.googleapis.com/billing-enabled'. rules: Individual rules for configuring usage on selected methods. serviceAccess: Controls which users can see or activate the service. """ class ServiceAccessValueValuesEnum(_messages.Enum): r"""Controls which users can see or activate the service. Values: RESTRICTED: The service can only be seen/used by users identified in the service's access control policy. If the service has not been whitelisted by your domain administrator for out-of-org publishing, then this mode will be treated like ORG_RESTRICTED. PUBLIC: The service can be seen/used by anyone. If the service has not been whitelisted by your domain administrator for out-of-org publishing, then this mode will be treated like ORG_PUBLIC. The discovery document for the service will also be public and allow unregistered access. ORG_RESTRICTED: The service can be seen/used by users identified in the service's access control policy and they are within the organization that owns the service. Access is further constrained to the group controlled by the administrator of the project/org that owns the service. ORG_PUBLIC: The service can be seen/used by the group of users controlled by the administrator of the project/org that owns the service. """ RESTRICTED = 0 PUBLIC = 1 ORG_RESTRICTED = 2 ORG_PUBLIC = 3 activationHooks = _messages.StringField(1, repeated=True) deactivationHooks = _messages.StringField(2, repeated=True) dependsOnServices = _messages.StringField(3, repeated=True) requirements = _messages.StringField(4, repeated=True) rules = _messages.MessageField('UsageRule', 5, repeated=True) serviceAccess = _messages.EnumField('ServiceAccessValueValuesEnum', 6) class UsageRule(_messages.Message): r"""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 Fields: allowUnregisteredCalls: True, if the method allows unregistered calls; false otherwise. selector: Selects the methods to which this rule applies. Use '' to indicate all methods in all APIs. Refer to selector for syntax details. """ allowUnregisteredCalls = _messages.BooleanField(1) selector = _messages.StringField(2) class UsageSettings(_messages.Message): r"""Usage settings for a consumer of a service. Enums: ConsumerEnableStatusValueValuesEnum: Consumer controlled setting to enable/disable use of this service by the consumer project. The default value of this is controlled by the service configuration. Fields: consumerEnableStatus: Consumer controlled setting to enable/disable use of this service by the consumer project. The default value of this is controlled by the service configuration. """ class ConsumerEnableStatusValueValuesEnum(_messages.Enum): r"""Consumer controlled setting to enable/disable use of this service by the consumer project. The default value of this is controlled by the service configuration. Values: DISABLED: The service is disabled. ENABLED: The service is enabled. """ DISABLED = 0 ENABLED = 1 consumerEnableStatus = _messages.EnumField('ConsumerEnableStatusValueValuesEnum', 1) class VariableTermQuota(_messages.Message): r"""A variable term quota is a bucket of tokens that is consumed over a specified (usually long) time period. When present, it overrides any "1d" duration per-project quota specified on the group. Variable terms run from midnight to midnight, start_date to end_date (inclusive) in the America/Los_Angeles time zone. Fields: createTime: Time when this variable term quota was created. If multiple quotas are simultaneously active, then the quota with the latest create_time is the effective one. displayEndDate: The displayed end of the active period for the variable term quota. This may be before the effective end to give the user a grace period. YYYYMMdd date format, e.g. 20140730. endDate: The effective end of the active period for the variable term quota (inclusive). This must be no more than 5 years after start_date. YYYYMMdd date format, e.g. 20140730. groupName: The quota group that has the variable term quota applied to it. This must be a google.api.QuotaGroup.name specified in the service configuration. limit: The number of tokens available during the configured term. quotaUsage: The usage data of this quota. startDate: The beginning of the active period for the variable term quota. YYYYMMdd date format, e.g. 20140730. """ createTime = _messages.StringField(1) displayEndDate = _messages.StringField(2) endDate = _messages.StringField(3) groupName = _messages.StringField(4) limit = _messages.IntegerField(5) quotaUsage = _messages.MessageField('QuotaUsage', 6) startDate = _messages.StringField(7) class Visibility(_messages.Message): r"""`Visibility` defines restrictions for the visibility of service elements. Restrictions are specified using visibility labels (e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects. Users and projects can have access to more than one visibility label. The effective visibility for multiple labels is the union of each label's elements, plus any unrestricted elements. If an element and its parents have no restrictions, visibility is unconditionally granted. Example: visibility: rules: - selector: google.calendar.Calendar.EnhancedSearch restriction: TRUSTED_TESTER - selector: google.calendar.Calendar.Delegate restriction: GOOGLE_INTERNAL Here, all methods are publicly visible except for the restricted methods EnhancedSearch and Delegate. Fields: enforceRuntimeVisibility: Controls whether visibility rules are enforced at runtime for requests to all APIs and methods. If true, requests without method visibility will receive a NOT_FOUND error, and any non- visible fields will be scrubbed from the response messages. In service config version 0, the default is false. In later config versions, it's true. Note, the `enforce_runtime_visibility` specified in a visibility rule overrides this setting for the APIs or methods asscoiated with the rule. rules: A list of visibility rules providing visibility configuration for individual API elements. """ enforceRuntimeVisibility = _messages.BooleanField(1) rules = _messages.MessageField('VisibilityRule', 2, repeated=True) class VisibilityRule(_messages.Message): r"""A visibility rule provides visibility configuration for an individual API element. Fields: enforceRuntimeVisibility: Controls whether visibility is enforced at runtime for requests to an API method. This setting has meaning only when the selector applies to a method or an API. If true, requests without method visibility will receive a NOT_FOUND error, and any non- visible fields will be scrubbed from the response messages. The default is determined by the value of google.api.Visibility.enforce_runtime_visibility. restriction: Lists the visibility labels for this rule. Any of the listed labels grants visibility to the element. If a rule has multiple labels, removing one of the labels but not all of them can break clients. Example: visibility: rules: - selector: google.calendar.Calendar.EnhancedSearch restriction: GOOGLE_INTERNAL, TRUSTED_TESTER Removing GOOGLE_INTERNAL from this restriction will break clients that rely on this method and only had access to it through GOOGLE_INTERNAL. selector: Selects methods, messages, fields, enums, etc. to which this rule applies. Refer to selector for syntax details. """ enforceRuntimeVisibility = _messages.BooleanField(1) restriction = _messages.StringField(2) selector = _messages.StringField(3) class VisibilitySettings(_messages.Message): r"""Settings that control which features of the service are visible to the consumer project. Fields: visibilityLabels: The set of visibility labels that are used to determine what API surface is visible to calls made by this project. The visible surface is a union of the surface features associated with each label listed here, plus the publicly visible (unrestricted) surface. The service producer may add or remove labels at any time. The service consumer may add a label if the calling user has been granted permission to do so by the producer. The service consumer may also remove any label at any time. """ visibilityLabels = _messages.StringField(1, repeated=True) encoding.AddCustomJsonFieldMapping( StandardQueryParameters, 'f__xgafv', '$.xgafv') encoding.AddCustomJsonEnumMapping( StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1') encoding.AddCustomJsonEnumMapping( StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2')	149.49 KB	2025-03-11 18:02

Terminal