google-apis-serviceusage-v1-0.28.0/0000755000175000017500000000000014410110425015472 5ustar raviravigoogle-apis-serviceusage-v1-0.28.0/google-apis-serviceusage_v1.gemspec0000644000175000017500000000514114410110425024337 0ustar raviravi######################################################### # This file has been automatically generated by gem2tgz # ######################################################### # -*- encoding: utf-8 -*- # stub: google-apis-serviceusage_v1 0.28.0 ruby lib Gem::Specification.new do |s| s.name = "google-apis-serviceusage_v1".freeze s.version = "0.28.0" s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version= s.metadata = { "bug_tracker_uri" => "https://github.com/googleapis/google-api-ruby-client/issues", "changelog_uri" => "https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-serviceusage_v1/CHANGELOG.md", "documentation_uri" => "https://googleapis.dev/ruby/google-apis-serviceusage_v1/v0.28.0", "source_code_uri" => "https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-serviceusage_v1" } if s.respond_to? :metadata= s.require_paths = ["lib".freeze] s.authors = ["Google LLC".freeze] s.date = "2022-12-12" s.description = "This is the simple REST client for Service Usage API V1. Simple REST clients are Ruby client libraries that provide access to Google services via their HTTP REST API endpoints. These libraries are generated and updated automatically based on the discovery documents published by the service, and they handle most concerns such as authentication, pagination, retry, timeouts, and logging. You can use this client to access the Service Usage API, but note that some services may provide a separate modern client that is easier to use.".freeze s.email = "googleapis-packages@google.com".freeze s.files = [".yardopts".freeze, "CHANGELOG.md".freeze, "LICENSE.md".freeze, "OVERVIEW.md".freeze, "lib/google-apis-serviceusage_v1.rb".freeze, "lib/google/apis/serviceusage_v1.rb".freeze, "lib/google/apis/serviceusage_v1/classes.rb".freeze, "lib/google/apis/serviceusage_v1/gem_version.rb".freeze, "lib/google/apis/serviceusage_v1/representations.rb".freeze, "lib/google/apis/serviceusage_v1/service.rb".freeze] s.homepage = "https://github.com/google/google-api-ruby-client".freeze s.licenses = ["Apache-2.0".freeze] s.required_ruby_version = Gem::Requirement.new(">= 2.5".freeze) s.rubygems_version = "3.3.15".freeze s.summary = "Simple REST client for Service Usage API V1".freeze if s.respond_to? :specification_version then s.specification_version = 4 end if s.respond_to? :add_runtime_dependency then s.add_runtime_dependency(%q.freeze, [">= 0.9.1", "< 2.a"]) else s.add_dependency(%q.freeze, [">= 0.9.1", "< 2.a"]) end end google-apis-serviceusage-v1-0.28.0/lib/0000755000175000017500000000000014410110425016240 5ustar raviravigoogle-apis-serviceusage-v1-0.28.0/lib/google/0000755000175000017500000000000014410110425017514 5ustar raviravigoogle-apis-serviceusage-v1-0.28.0/lib/google/apis/0000755000175000017500000000000014410110425020450 5ustar raviravigoogle-apis-serviceusage-v1-0.28.0/lib/google/apis/serviceusage_v1/0000755000175000017500000000000014410110425023543 5ustar raviravigoogle-apis-serviceusage-v1-0.28.0/lib/google/apis/serviceusage_v1/service.rb0000644000175000017500000006554614410110425025550 0ustar raviravi# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module ServiceusageV1 # Service Usage API # # Enables services that service consumers want to use on Google Cloud Platform, # lists the available or enabled services, or disables services that service # consumers no longer use. # # @example # require 'google/apis/serviceusage_v1' # # Serviceusage = Google::Apis::ServiceusageV1 # Alias the module # service = Serviceusage::ServiceUsageService.new # # @see https://cloud.google.com/service-usage/ class ServiceUsageService < Google::Apis::Core::BaseService # @return [String] # 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. attr_accessor :key # @return [String] # 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. attr_accessor :quota_user def initialize super('https://serviceusage.googleapis.com/', '', client_name: 'google-apis-serviceusage_v1', client_version: Google::Apis::ServiceusageV1::GEM_VERSION) @batch_path = 'batch' end # Starts asynchronous cancellation on a long-running operation. The server makes # a best effort to cancel the operation, but success is not guaranteed. If the # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. # Clients can use Operations.GetOperation or other methods to check whether the # cancellation succeeded or whether the operation completed despite cancellation. # On successful cancellation, the operation is not deleted; instead, it becomes # an operation with an Operation.error value with a google.rpc.Status.code of 1, # corresponding to `Code.CANCELLED`. # @param [String] name # The name of the operation resource to be cancelled. # @param [Google::Apis::ServiceusageV1::CancelOperationRequest] cancel_operation_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:cancel', options) command.request_representation = Google::Apis::ServiceusageV1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::ServiceusageV1::Empty::Representation command.response_class = Google::Apis::ServiceusageV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Deletes a long-running operation. This method indicates that the client is no # longer interested in the operation result. It does not cancel the operation. # If the server doesn't support this method, it returns `google.rpc.Code. # UNIMPLEMENTED`. # @param [String] name # The name of the operation resource to be deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', options) command.response_representation = Google::Apis::ServiceusageV1::Empty::Representation command.response_class = Google::Apis::ServiceusageV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # 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. # @param [String] name # The name of the operation resource. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::Operation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation command.response_class = Google::Apis::ServiceusageV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Lists operations that match the specified filter in the request. If the server # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` # binding allows API services to override the binding to use different resource # name schemes, such as `users/*/operations`. To override the binding, API # services can add a binding such as `"/v1/`name=users/*`/operations"` to their # service configuration. For backwards compatibility, the default name includes # the operations collection id, however overriding users must ensure the name # binding is the parent resource, without the operations collection id. # @param [String] filter # The standard list filter. # @param [String] name # The name of the operation's parent resource. # @param [Fixnum] page_size # The standard list page size. # @param [String] page_token # The standard list page token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::ListOperationsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::ListOperationsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/operations', options) command.response_representation = Google::Apis::ServiceusageV1::ListOperationsResponse::Representation command.response_class = Google::Apis::ServiceusageV1::ListOperationsResponse command.query['filter'] = filter unless filter.nil? command.query['name'] = name unless name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Enable multiple services on a project. The operation is atomic: if enabling # any service fails, then the entire batch fails, and no state changes occur. To # enable a single service, use the `EnableService` method instead. # @param [String] parent # Parent to enable services on. An example name would be: `projects/123` where ` # 123` is the project number. The `BatchEnableServices` method currently only # supports projects. # @param [Google::Apis::ServiceusageV1::BatchEnableServicesRequest] batch_enable_services_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::Operation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def batch_enable_services(parent, batch_enable_services_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/services:batchEnable', options) command.request_representation = Google::Apis::ServiceusageV1::BatchEnableServicesRequest::Representation command.request_object = batch_enable_services_request_object command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation command.response_class = Google::Apis::ServiceusageV1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Returns the service configurations and enabled states for a given list of # services. # @param [String] parent # Parent to retrieve services from. If this is set, the parent of all of the # services specified in `names` must match this field. An example name would be: # `projects/123` where `123` is the project number. The `BatchGetServices` # method currently only supports projects. # @param [Array, String] names # Names of the services to retrieve. An example name would be: `projects/123/ # services/serviceusage.googleapis.com` where `123` is the project number. A # single request can get a maximum of 30 services at a time. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::BatchGetServicesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::BatchGetServicesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def batch_service_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/services:batchGet', options) command.response_representation = Google::Apis::ServiceusageV1::BatchGetServicesResponse::Representation command.response_class = Google::Apis::ServiceusageV1::BatchGetServicesResponse command.params['parent'] = parent unless parent.nil? command.query['names'] = names unless names.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Disable a service so that it can no longer be used with a project. This # prevents unintended usage that may cause unexpected billing charges or # security leaks. It is not valid to call the disable method on a service that # is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status # if the target service is not currently enabled. # @param [String] name # Name of the consumer and service to disable the service on. The enable and # disable methods currently only support projects. An example name would be: ` # projects/123/services/serviceusage.googleapis.com` where `123` is the project # number. # @param [Google::Apis::ServiceusageV1::DisableServiceRequest] disable_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::Operation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def disable_service(name, disable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:disable', options) command.request_representation = Google::Apis::ServiceusageV1::DisableServiceRequest::Representation command.request_object = disable_service_request_object command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation command.response_class = Google::Apis::ServiceusageV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Enable a service so that it can be used with a project. # @param [String] name # Name of the consumer and service to enable the service on. The `EnableService` # and `DisableService` methods currently only support projects. Enabling a # service requires that the service is public or is shared with the user # enabling the service. An example name would be: `projects/123/services/ # serviceusage.googleapis.com` where `123` is the project number. # @param [Google::Apis::ServiceusageV1::EnableServiceRequest] enable_service_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::Operation] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::Operation] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def enable_service(name, enable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:enable', options) command.request_representation = Google::Apis::ServiceusageV1::EnableServiceRequest::Representation command.request_object = enable_service_request_object command.response_representation = Google::Apis::ServiceusageV1::Operation::Representation command.response_class = Google::Apis::ServiceusageV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # Returns the service configuration and enabled state for a given service. # @param [String] name # Name of the consumer and service to get the `ConsumerState` for. An example # name would be: `projects/123/services/serviceusage.googleapis.com` where `123` # is the project number. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def get_service(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', options) command.response_representation = Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation command.response_class = Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end # List all services available to the specified project, and the current state of # those services with respect to the project. The list includes all public # services, all services for which the calling user has the `servicemanagement. # services.bind` permission, and all services that have already been enabled on # the project. The list can be filtered to only include services in a specific # state, for example to only include services enabled on the project. WARNING: # If you need to query enabled services frequently or across an organization, # you should use [Cloud Asset Inventory API](https://cloud.google.com/asset- # inventory/docs/apis), which provides higher throughput and richer filtering # capability. # @param [String] parent # Parent to search for services on. An example name would be: `projects/123` # where `123` is the project number. # @param [String] filter # Only list services that conform to the given filter. The allowed filter # strings are `state:ENABLED` and `state:DISABLED`. # @param [Fixnum] page_size # Requested size of the next page of data. Requested page size cannot exceed 200. # If not set, the default page size is 50. # @param [String] page_token # Token identifying which result to start with, which is returned by a previous # list call. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user # 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. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied # @yieldparam result [Google::Apis::ServiceusageV1::ListServicesResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # # @return [Google::Apis::ServiceusageV1::ListServicesResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required def list_services(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/services', options) command.response_representation = Google::Apis::ServiceusageV1::ListServicesResponse::Representation command.response_class = Google::Apis::ServiceusageV1::ListServicesResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end protected def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end end end end end google-apis-serviceusage-v1-0.28.0/lib/google/apis/serviceusage_v1/representations.rb0000644000175000017500000017242314410110425027326 0ustar raviravi# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module ServiceusageV1 class AdminQuotaPolicy class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Api class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthProvider class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthRequirement class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Authentication class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AuthenticationRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Backend class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BackendRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchCreateAdminOverridesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchCreateConsumerOverridesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchEnableServicesRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchEnableServicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BatchGetServicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Billing class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class BillingDestination class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CancelOperationRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ClientLibrarySettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CommonLanguageSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Context class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ContextRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Control class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CppSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CreateAdminQuotaPolicyMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomError class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomErrorRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class CustomHttpPattern class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DeleteAdminQuotaPolicyMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DisableServiceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DisableServiceResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Documentation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DocumentationRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class DotnetSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Empty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EnableFailure class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EnableServiceRequest class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EnableServiceResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Endpoint class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Enum class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class EnumValue class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Field class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetServiceIdentityMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GetServiceIdentityResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleApiService class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleApiServiceusageV1OperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleApiServiceusageV1Service class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleApiServiceusageV1ServiceConfig class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleApiServiceusageV1beta1GetServiceIdentityResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class GoogleApiServiceusageV1beta1ServiceIdentity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Http class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class HttpRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportAdminOverridesMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportAdminOverridesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportAdminQuotaPoliciesMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportAdminQuotaPoliciesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportConsumerOverridesMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ImportConsumerOverridesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class JavaSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class JwtLocation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LabelDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListOperationsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ListServicesResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LogDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Logging class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LoggingDestination class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class LongRunning class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MethodProp class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MethodSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricDescriptorMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MetricRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Mixin class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MonitoredResourceDescriptor class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Monitoring class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class MonitoringDestination class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class NodeSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OAuthRequirements class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Operation class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class OperationMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Option class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Page class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PhpSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Publishing class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class PythonSettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Quota class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuotaLimit class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class QuotaOverride class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class RubySettings class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class ServiceIdentity class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceContext class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SourceInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Status class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SystemParameter class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SystemParameterRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class SystemParameters class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Type class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UpdateAdminQuotaPolicyMetadata class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class Usage class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class UsageRule class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end class AdminQuotaPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation property :container, as: 'container' hash :dimensions, as: 'dimensions' property :metric, as: 'metric' property :name, as: 'name' property :policy_value, :numeric_string => true, as: 'policyValue' property :unit, as: 'unit' end end class Api # @private class Representation < Google::Apis::Core::JsonRepresentation collection :methods_prop, as: 'methods', class: Google::Apis::ServiceusageV1::MethodProp, decorator: Google::Apis::ServiceusageV1::MethodProp::Representation collection :mixins, as: 'mixins', class: Google::Apis::ServiceusageV1::Mixin, decorator: Google::Apis::ServiceusageV1::Mixin::Representation property :name, as: 'name' collection :options, as: 'options', class: Google::Apis::ServiceusageV1::Option, decorator: Google::Apis::ServiceusageV1::Option::Representation property :source_context, as: 'sourceContext', class: Google::Apis::ServiceusageV1::SourceContext, decorator: Google::Apis::ServiceusageV1::SourceContext::Representation property :syntax, as: 'syntax' property :version, as: 'version' end end class AuthProvider # @private class Representation < Google::Apis::Core::JsonRepresentation property :audiences, as: 'audiences' property :authorization_url, as: 'authorizationUrl' property :id, as: 'id' property :issuer, as: 'issuer' property :jwks_uri, as: 'jwksUri' collection :jwt_locations, as: 'jwtLocations', class: Google::Apis::ServiceusageV1::JwtLocation, decorator: Google::Apis::ServiceusageV1::JwtLocation::Representation end end class AuthRequirement # @private class Representation < Google::Apis::Core::JsonRepresentation property :audiences, as: 'audiences' property :provider_id, as: 'providerId' end end class Authentication # @private class Representation < Google::Apis::Core::JsonRepresentation collection :providers, as: 'providers', class: Google::Apis::ServiceusageV1::AuthProvider, decorator: Google::Apis::ServiceusageV1::AuthProvider::Representation collection :rules, as: 'rules', class: Google::Apis::ServiceusageV1::AuthenticationRule, decorator: Google::Apis::ServiceusageV1::AuthenticationRule::Representation end end class AuthenticationRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_without_credential, as: 'allowWithoutCredential' property :oauth, as: 'oauth', class: Google::Apis::ServiceusageV1::OAuthRequirements, decorator: Google::Apis::ServiceusageV1::OAuthRequirements::Representation collection :requirements, as: 'requirements', class: Google::Apis::ServiceusageV1::AuthRequirement, decorator: Google::Apis::ServiceusageV1::AuthRequirement::Representation property :selector, as: 'selector' end end class Backend # @private class Representation < Google::Apis::Core::JsonRepresentation collection :rules, as: 'rules', class: Google::Apis::ServiceusageV1::BackendRule, decorator: Google::Apis::ServiceusageV1::BackendRule::Representation end end class BackendRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :address, as: 'address' property :deadline, as: 'deadline' property :disable_auth, as: 'disableAuth' property :jwt_audience, as: 'jwtAudience' property :min_deadline, as: 'minDeadline' property :operation_deadline, as: 'operationDeadline' property :path_translation, as: 'pathTranslation' property :protocol, as: 'protocol' property :selector, as: 'selector' end end class BatchCreateAdminOverridesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1::QuotaOverride, decorator: Google::Apis::ServiceusageV1::QuotaOverride::Representation end end class BatchCreateConsumerOverridesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1::QuotaOverride, decorator: Google::Apis::ServiceusageV1::QuotaOverride::Representation end end class BatchEnableServicesRequest # @private class Representation < Google::Apis::Core::JsonRepresentation collection :service_ids, as: 'serviceIds' end end class BatchEnableServicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :failures, as: 'failures', class: Google::Apis::ServiceusageV1::EnableFailure, decorator: Google::Apis::ServiceusageV1::EnableFailure::Representation collection :services, as: 'services', class: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service, decorator: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation end end class BatchGetServicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :services, as: 'services', class: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service, decorator: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation end end class Billing # @private class Representation < Google::Apis::Core::JsonRepresentation collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceusageV1::BillingDestination, decorator: Google::Apis::ServiceusageV1::BillingDestination::Representation end end class BillingDestination # @private class Representation < Google::Apis::Core::JsonRepresentation collection :metrics, as: 'metrics' property :monitored_resource, as: 'monitoredResource' end end class CancelOperationRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ClientLibrarySettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :cpp_settings, as: 'cppSettings', class: Google::Apis::ServiceusageV1::CppSettings, decorator: Google::Apis::ServiceusageV1::CppSettings::Representation property :dotnet_settings, as: 'dotnetSettings', class: Google::Apis::ServiceusageV1::DotnetSettings, decorator: Google::Apis::ServiceusageV1::DotnetSettings::Representation property :go_settings, as: 'goSettings', class: Google::Apis::ServiceusageV1::GoSettings, decorator: Google::Apis::ServiceusageV1::GoSettings::Representation property :java_settings, as: 'javaSettings', class: Google::Apis::ServiceusageV1::JavaSettings, decorator: Google::Apis::ServiceusageV1::JavaSettings::Representation property :launch_stage, as: 'launchStage' property :node_settings, as: 'nodeSettings', class: Google::Apis::ServiceusageV1::NodeSettings, decorator: Google::Apis::ServiceusageV1::NodeSettings::Representation property :php_settings, as: 'phpSettings', class: Google::Apis::ServiceusageV1::PhpSettings, decorator: Google::Apis::ServiceusageV1::PhpSettings::Representation property :python_settings, as: 'pythonSettings', class: Google::Apis::ServiceusageV1::PythonSettings, decorator: Google::Apis::ServiceusageV1::PythonSettings::Representation property :rest_numeric_enums, as: 'restNumericEnums' property :ruby_settings, as: 'rubySettings', class: Google::Apis::ServiceusageV1::RubySettings, decorator: Google::Apis::ServiceusageV1::RubySettings::Representation property :version, as: 'version' end end class CommonLanguageSettings # @private class Representation < Google::Apis::Core::JsonRepresentation collection :destinations, as: 'destinations' property :reference_docs_uri, as: 'referenceDocsUri' end end class Context # @private class Representation < Google::Apis::Core::JsonRepresentation collection :rules, as: 'rules', class: Google::Apis::ServiceusageV1::ContextRule, decorator: Google::Apis::ServiceusageV1::ContextRule::Representation end end class ContextRule # @private class Representation < Google::Apis::Core::JsonRepresentation collection :allowed_request_extensions, as: 'allowedRequestExtensions' collection :allowed_response_extensions, as: 'allowedResponseExtensions' collection :provided, as: 'provided' collection :requested, as: 'requested' property :selector, as: 'selector' end end class Control # @private class Representation < Google::Apis::Core::JsonRepresentation property :environment, as: 'environment' end end class CppSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::ServiceusageV1::CommonLanguageSettings, decorator: Google::Apis::ServiceusageV1::CommonLanguageSettings::Representation end end class CreateAdminQuotaPolicyMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation end end class CustomError # @private class Representation < Google::Apis::Core::JsonRepresentation collection :rules, as: 'rules', class: Google::Apis::ServiceusageV1::CustomErrorRule, decorator: Google::Apis::ServiceusageV1::CustomErrorRule::Representation collection :types, as: 'types' end end class CustomErrorRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :is_error_type, as: 'isErrorType' property :selector, as: 'selector' end end class CustomHttpPattern # @private class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :path, as: 'path' end end class DeleteAdminQuotaPolicyMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation end end class DisableServiceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation property :check_if_service_has_usage, as: 'checkIfServiceHasUsage' property :disable_dependent_services, as: 'disableDependentServices' end end class DisableServiceResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :service, as: 'service', class: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service, decorator: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation end end class Documentation # @private class Representation < Google::Apis::Core::JsonRepresentation property :documentation_root_url, as: 'documentationRootUrl' property :overview, as: 'overview' collection :pages, as: 'pages', class: Google::Apis::ServiceusageV1::Page, decorator: Google::Apis::ServiceusageV1::Page::Representation collection :rules, as: 'rules', class: Google::Apis::ServiceusageV1::DocumentationRule, decorator: Google::Apis::ServiceusageV1::DocumentationRule::Representation property :service_root_url, as: 'serviceRootUrl' property :summary, as: 'summary' end end class DocumentationRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :deprecation_description, as: 'deprecationDescription' property :description, as: 'description' property :selector, as: 'selector' end end class DotnetSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::ServiceusageV1::CommonLanguageSettings, decorator: Google::Apis::ServiceusageV1::CommonLanguageSettings::Representation end end class Empty # @private class Representation < Google::Apis::Core::JsonRepresentation end end class EnableFailure # @private class Representation < Google::Apis::Core::JsonRepresentation property :error_message, as: 'errorMessage' property :service_id, as: 'serviceId' end end class EnableServiceRequest # @private class Representation < Google::Apis::Core::JsonRepresentation end end class EnableServiceResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :service, as: 'service', class: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service, decorator: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation end end class Endpoint # @private class Representation < Google::Apis::Core::JsonRepresentation collection :aliases, as: 'aliases' property :allow_cors, as: 'allowCors' property :name, as: 'name' property :target, as: 'target' end end class Enum # @private class Representation < Google::Apis::Core::JsonRepresentation collection :enumvalue, as: 'enumvalue', class: Google::Apis::ServiceusageV1::EnumValue, decorator: Google::Apis::ServiceusageV1::EnumValue::Representation property :name, as: 'name' collection :options, as: 'options', class: Google::Apis::ServiceusageV1::Option, decorator: Google::Apis::ServiceusageV1::Option::Representation property :source_context, as: 'sourceContext', class: Google::Apis::ServiceusageV1::SourceContext, decorator: Google::Apis::ServiceusageV1::SourceContext::Representation property :syntax, as: 'syntax' end end class EnumValue # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :number, as: 'number' collection :options, as: 'options', class: Google::Apis::ServiceusageV1::Option, decorator: Google::Apis::ServiceusageV1::Option::Representation end end class Field # @private class Representation < Google::Apis::Core::JsonRepresentation property :cardinality, as: 'cardinality' property :default_value, as: 'defaultValue' property :json_name, as: 'jsonName' property :kind, as: 'kind' property :name, as: 'name' property :number, as: 'number' property :oneof_index, as: 'oneofIndex' collection :options, as: 'options', class: Google::Apis::ServiceusageV1::Option, decorator: Google::Apis::ServiceusageV1::Option::Representation property :packed, as: 'packed' property :type_url, as: 'typeUrl' end end class GetServiceIdentityMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation end end class GetServiceIdentityResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :identity, as: 'identity', class: Google::Apis::ServiceusageV1::ServiceIdentity, decorator: Google::Apis::ServiceusageV1::ServiceIdentity::Representation property :state, as: 'state' end end class GoSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::ServiceusageV1::CommonLanguageSettings, decorator: Google::Apis::ServiceusageV1::CommonLanguageSettings::Representation end end class GoogleApiService # @private class Representation < Google::Apis::Core::JsonRepresentation collection :apis, as: 'apis', class: Google::Apis::ServiceusageV1::Api, decorator: Google::Apis::ServiceusageV1::Api::Representation property :authentication, as: 'authentication', class: Google::Apis::ServiceusageV1::Authentication, decorator: Google::Apis::ServiceusageV1::Authentication::Representation property :backend, as: 'backend', class: Google::Apis::ServiceusageV1::Backend, decorator: Google::Apis::ServiceusageV1::Backend::Representation property :billing, as: 'billing', class: Google::Apis::ServiceusageV1::Billing, decorator: Google::Apis::ServiceusageV1::Billing::Representation property :config_version, as: 'configVersion' property :context, as: 'context', class: Google::Apis::ServiceusageV1::Context, decorator: Google::Apis::ServiceusageV1::Context::Representation property :control, as: 'control', class: Google::Apis::ServiceusageV1::Control, decorator: Google::Apis::ServiceusageV1::Control::Representation property :custom_error, as: 'customError', class: Google::Apis::ServiceusageV1::CustomError, decorator: Google::Apis::ServiceusageV1::CustomError::Representation property :documentation, as: 'documentation', class: Google::Apis::ServiceusageV1::Documentation, decorator: Google::Apis::ServiceusageV1::Documentation::Representation collection :endpoints, as: 'endpoints', class: Google::Apis::ServiceusageV1::Endpoint, decorator: Google::Apis::ServiceusageV1::Endpoint::Representation collection :enums, as: 'enums', class: Google::Apis::ServiceusageV1::Enum, decorator: Google::Apis::ServiceusageV1::Enum::Representation property :http, as: 'http', class: Google::Apis::ServiceusageV1::Http, decorator: Google::Apis::ServiceusageV1::Http::Representation property :id, as: 'id' property :logging, as: 'logging', class: Google::Apis::ServiceusageV1::Logging, decorator: Google::Apis::ServiceusageV1::Logging::Representation collection :logs, as: 'logs', class: Google::Apis::ServiceusageV1::LogDescriptor, decorator: Google::Apis::ServiceusageV1::LogDescriptor::Representation collection :metrics, as: 'metrics', class: Google::Apis::ServiceusageV1::MetricDescriptor, decorator: Google::Apis::ServiceusageV1::MetricDescriptor::Representation collection :monitored_resources, as: 'monitoredResources', class: Google::Apis::ServiceusageV1::MonitoredResourceDescriptor, decorator: Google::Apis::ServiceusageV1::MonitoredResourceDescriptor::Representation property :monitoring, as: 'monitoring', class: Google::Apis::ServiceusageV1::Monitoring, decorator: Google::Apis::ServiceusageV1::Monitoring::Representation property :name, as: 'name' property :producer_project_id, as: 'producerProjectId' property :publishing, as: 'publishing', class: Google::Apis::ServiceusageV1::Publishing, decorator: Google::Apis::ServiceusageV1::Publishing::Representation property :quota, as: 'quota', class: Google::Apis::ServiceusageV1::Quota, decorator: Google::Apis::ServiceusageV1::Quota::Representation property :source_info, as: 'sourceInfo', class: Google::Apis::ServiceusageV1::SourceInfo, decorator: Google::Apis::ServiceusageV1::SourceInfo::Representation property :system_parameters, as: 'systemParameters', class: Google::Apis::ServiceusageV1::SystemParameters, decorator: Google::Apis::ServiceusageV1::SystemParameters::Representation collection :system_types, as: 'systemTypes', class: Google::Apis::ServiceusageV1::Type, decorator: Google::Apis::ServiceusageV1::Type::Representation property :title, as: 'title' collection :types, as: 'types', class: Google::Apis::ServiceusageV1::Type, decorator: Google::Apis::ServiceusageV1::Type::Representation property :usage, as: 'usage', class: Google::Apis::ServiceusageV1::Usage, decorator: Google::Apis::ServiceusageV1::Usage::Representation end end class GoogleApiServiceusageV1OperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation collection :resource_names, as: 'resourceNames' end end class GoogleApiServiceusageV1Service # @private class Representation < Google::Apis::Core::JsonRepresentation property :config, as: 'config', class: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1ServiceConfig, decorator: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1ServiceConfig::Representation property :name, as: 'name' property :parent, as: 'parent' property :state, as: 'state' end end class GoogleApiServiceusageV1ServiceConfig # @private class Representation < Google::Apis::Core::JsonRepresentation collection :apis, as: 'apis', class: Google::Apis::ServiceusageV1::Api, decorator: Google::Apis::ServiceusageV1::Api::Representation property :authentication, as: 'authentication', class: Google::Apis::ServiceusageV1::Authentication, decorator: Google::Apis::ServiceusageV1::Authentication::Representation property :documentation, as: 'documentation', class: Google::Apis::ServiceusageV1::Documentation, decorator: Google::Apis::ServiceusageV1::Documentation::Representation collection :endpoints, as: 'endpoints', class: Google::Apis::ServiceusageV1::Endpoint, decorator: Google::Apis::ServiceusageV1::Endpoint::Representation collection :monitored_resources, as: 'monitoredResources', class: Google::Apis::ServiceusageV1::MonitoredResourceDescriptor, decorator: Google::Apis::ServiceusageV1::MonitoredResourceDescriptor::Representation property :monitoring, as: 'monitoring', class: Google::Apis::ServiceusageV1::Monitoring, decorator: Google::Apis::ServiceusageV1::Monitoring::Representation property :name, as: 'name' property :quota, as: 'quota', class: Google::Apis::ServiceusageV1::Quota, decorator: Google::Apis::ServiceusageV1::Quota::Representation property :title, as: 'title' property :usage, as: 'usage', class: Google::Apis::ServiceusageV1::Usage, decorator: Google::Apis::ServiceusageV1::Usage::Representation end end class GoogleApiServiceusageV1beta1GetServiceIdentityResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :identity, as: 'identity', class: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1beta1ServiceIdentity, decorator: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1beta1ServiceIdentity::Representation property :state, as: 'state' end end class GoogleApiServiceusageV1beta1ServiceIdentity # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :unique_id, as: 'uniqueId' end end class Http # @private class Representation < Google::Apis::Core::JsonRepresentation property :fully_decode_reserved_expansion, as: 'fullyDecodeReservedExpansion' collection :rules, as: 'rules', class: Google::Apis::ServiceusageV1::HttpRule, decorator: Google::Apis::ServiceusageV1::HttpRule::Representation end end class HttpRule # @private class Representation < Google::Apis::Core::JsonRepresentation collection :additional_bindings, as: 'additionalBindings', class: Google::Apis::ServiceusageV1::HttpRule, decorator: Google::Apis::ServiceusageV1::HttpRule::Representation property :body, as: 'body' property :custom, as: 'custom', class: Google::Apis::ServiceusageV1::CustomHttpPattern, decorator: Google::Apis::ServiceusageV1::CustomHttpPattern::Representation property :delete, as: 'delete' property :get, as: 'get' property :patch, as: 'patch' property :post, as: 'post' property :put, as: 'put' property :response_body, as: 'responseBody' property :selector, as: 'selector' end end class ImportAdminOverridesMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ImportAdminOverridesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1::QuotaOverride, decorator: Google::Apis::ServiceusageV1::QuotaOverride::Representation end end class ImportAdminQuotaPoliciesMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ImportAdminQuotaPoliciesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :policies, as: 'policies', class: Google::Apis::ServiceusageV1::AdminQuotaPolicy, decorator: Google::Apis::ServiceusageV1::AdminQuotaPolicy::Representation end end class ImportConsumerOverridesMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation end end class ImportConsumerOverridesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation collection :overrides, as: 'overrides', class: Google::Apis::ServiceusageV1::QuotaOverride, decorator: Google::Apis::ServiceusageV1::QuotaOverride::Representation end end class JavaSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::ServiceusageV1::CommonLanguageSettings, decorator: Google::Apis::ServiceusageV1::CommonLanguageSettings::Representation property :library_package, as: 'libraryPackage' hash :service_class_names, as: 'serviceClassNames' end end class JwtLocation # @private class Representation < Google::Apis::Core::JsonRepresentation property :cookie, as: 'cookie' property :header, as: 'header' property :query, as: 'query' property :value_prefix, as: 'valuePrefix' end end class LabelDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :key, as: 'key' property :value_type, as: 'valueType' end end class ListOperationsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :operations, as: 'operations', class: Google::Apis::ServiceusageV1::Operation, decorator: Google::Apis::ServiceusageV1::Operation::Representation end end class ListServicesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation property :next_page_token, as: 'nextPageToken' collection :services, as: 'services', class: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service, decorator: Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service::Representation end end class LogDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :display_name, as: 'displayName' collection :labels, as: 'labels', class: Google::Apis::ServiceusageV1::LabelDescriptor, decorator: Google::Apis::ServiceusageV1::LabelDescriptor::Representation property :name, as: 'name' end end class Logging # @private class Representation < Google::Apis::Core::JsonRepresentation collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceusageV1::LoggingDestination, decorator: Google::Apis::ServiceusageV1::LoggingDestination::Representation collection :producer_destinations, as: 'producerDestinations', class: Google::Apis::ServiceusageV1::LoggingDestination, decorator: Google::Apis::ServiceusageV1::LoggingDestination::Representation end end class LoggingDestination # @private class Representation < Google::Apis::Core::JsonRepresentation collection :logs, as: 'logs' property :monitored_resource, as: 'monitoredResource' end end class LongRunning # @private class Representation < Google::Apis::Core::JsonRepresentation property :initial_poll_delay, as: 'initialPollDelay' property :max_poll_delay, as: 'maxPollDelay' property :poll_delay_multiplier, as: 'pollDelayMultiplier' property :total_poll_timeout, as: 'totalPollTimeout' end end class MethodProp # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' collection :options, as: 'options', class: Google::Apis::ServiceusageV1::Option, decorator: Google::Apis::ServiceusageV1::Option::Representation property :request_streaming, as: 'requestStreaming' property :request_type_url, as: 'requestTypeUrl' property :response_streaming, as: 'responseStreaming' property :response_type_url, as: 'responseTypeUrl' property :syntax, as: 'syntax' end end class MethodSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :long_running, as: 'longRunning', class: Google::Apis::ServiceusageV1::LongRunning, decorator: Google::Apis::ServiceusageV1::LongRunning::Representation property :selector, as: 'selector' end end class MetricDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :display_name, as: 'displayName' collection :labels, as: 'labels', class: Google::Apis::ServiceusageV1::LabelDescriptor, decorator: Google::Apis::ServiceusageV1::LabelDescriptor::Representation property :launch_stage, as: 'launchStage' property :metadata, as: 'metadata', class: Google::Apis::ServiceusageV1::MetricDescriptorMetadata, decorator: Google::Apis::ServiceusageV1::MetricDescriptorMetadata::Representation property :metric_kind, as: 'metricKind' collection :monitored_resource_types, as: 'monitoredResourceTypes' property :name, as: 'name' property :type, as: 'type' property :unit, as: 'unit' property :value_type, as: 'valueType' end end class MetricDescriptorMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation property :ingest_delay, as: 'ingestDelay' property :launch_stage, as: 'launchStage' property :sample_period, as: 'samplePeriod' end end class MetricRule # @private class Representation < Google::Apis::Core::JsonRepresentation hash :metric_costs, as: 'metricCosts' property :selector, as: 'selector' end end class Mixin # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' property :root, as: 'root' end end class MonitoredResourceDescriptor # @private class Representation < Google::Apis::Core::JsonRepresentation property :description, as: 'description' property :display_name, as: 'displayName' collection :labels, as: 'labels', class: Google::Apis::ServiceusageV1::LabelDescriptor, decorator: Google::Apis::ServiceusageV1::LabelDescriptor::Representation property :launch_stage, as: 'launchStage' property :name, as: 'name' property :type, as: 'type' end end class Monitoring # @private class Representation < Google::Apis::Core::JsonRepresentation collection :consumer_destinations, as: 'consumerDestinations', class: Google::Apis::ServiceusageV1::MonitoringDestination, decorator: Google::Apis::ServiceusageV1::MonitoringDestination::Representation collection :producer_destinations, as: 'producerDestinations', class: Google::Apis::ServiceusageV1::MonitoringDestination, decorator: Google::Apis::ServiceusageV1::MonitoringDestination::Representation end end class MonitoringDestination # @private class Representation < Google::Apis::Core::JsonRepresentation collection :metrics, as: 'metrics' property :monitored_resource, as: 'monitoredResource' end end class NodeSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::ServiceusageV1::CommonLanguageSettings, decorator: Google::Apis::ServiceusageV1::CommonLanguageSettings::Representation end end class OAuthRequirements # @private class Representation < Google::Apis::Core::JsonRepresentation property :canonical_scopes, as: 'canonicalScopes' end end class Operation # @private class Representation < Google::Apis::Core::JsonRepresentation property :done, as: 'done' property :error, as: 'error', class: Google::Apis::ServiceusageV1::Status, decorator: Google::Apis::ServiceusageV1::Status::Representation hash :metadata, as: 'metadata' property :name, as: 'name' hash :response, as: 'response' end end class OperationMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation collection :resource_names, as: 'resourceNames' end end class Option # @private class Representation < Google::Apis::Core::JsonRepresentation property :name, as: 'name' hash :value, as: 'value' end end class Page # @private class Representation < Google::Apis::Core::JsonRepresentation property :content, as: 'content' property :name, as: 'name' collection :subpages, as: 'subpages', class: Google::Apis::ServiceusageV1::Page, decorator: Google::Apis::ServiceusageV1::Page::Representation end end class PhpSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::ServiceusageV1::CommonLanguageSettings, decorator: Google::Apis::ServiceusageV1::CommonLanguageSettings::Representation end end class Publishing # @private class Representation < Google::Apis::Core::JsonRepresentation property :api_short_name, as: 'apiShortName' collection :codeowner_github_teams, as: 'codeownerGithubTeams' property :doc_tag_prefix, as: 'docTagPrefix' property :documentation_uri, as: 'documentationUri' property :github_label, as: 'githubLabel' collection :library_settings, as: 'librarySettings', class: Google::Apis::ServiceusageV1::ClientLibrarySettings, decorator: Google::Apis::ServiceusageV1::ClientLibrarySettings::Representation collection :method_settings, as: 'methodSettings', class: Google::Apis::ServiceusageV1::MethodSettings, decorator: Google::Apis::ServiceusageV1::MethodSettings::Representation property :new_issue_uri, as: 'newIssueUri' property :organization, as: 'organization' end end class PythonSettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::ServiceusageV1::CommonLanguageSettings, decorator: Google::Apis::ServiceusageV1::CommonLanguageSettings::Representation end end class Quota # @private class Representation < Google::Apis::Core::JsonRepresentation collection :limits, as: 'limits', class: Google::Apis::ServiceusageV1::QuotaLimit, decorator: Google::Apis::ServiceusageV1::QuotaLimit::Representation collection :metric_rules, as: 'metricRules', class: Google::Apis::ServiceusageV1::MetricRule, decorator: Google::Apis::ServiceusageV1::MetricRule::Representation end end class QuotaLimit # @private class Representation < Google::Apis::Core::JsonRepresentation property :default_limit, :numeric_string => true, as: 'defaultLimit' property :description, as: 'description' property :display_name, as: 'displayName' property :duration, as: 'duration' property :free_tier, :numeric_string => true, as: 'freeTier' property :max_limit, :numeric_string => true, as: 'maxLimit' property :metric, as: 'metric' property :name, as: 'name' property :unit, as: 'unit' hash :values, as: 'values' end end class QuotaOverride # @private class Representation < Google::Apis::Core::JsonRepresentation property :admin_override_ancestor, as: 'adminOverrideAncestor' hash :dimensions, as: 'dimensions' property :metric, as: 'metric' property :name, as: 'name' property :override_value, :numeric_string => true, as: 'overrideValue' property :unit, as: 'unit' end end class RubySettings # @private class Representation < Google::Apis::Core::JsonRepresentation property :common, as: 'common', class: Google::Apis::ServiceusageV1::CommonLanguageSettings, decorator: Google::Apis::ServiceusageV1::CommonLanguageSettings::Representation end end class ServiceIdentity # @private class Representation < Google::Apis::Core::JsonRepresentation property :email, as: 'email' property :unique_id, as: 'uniqueId' end end class SourceContext # @private class Representation < Google::Apis::Core::JsonRepresentation property :file_name, as: 'fileName' end end class SourceInfo # @private class Representation < Google::Apis::Core::JsonRepresentation collection :source_files, as: 'sourceFiles' end end class Status # @private class Representation < Google::Apis::Core::JsonRepresentation property :code, as: 'code' collection :details, as: 'details' property :message, as: 'message' end end class SystemParameter # @private class Representation < Google::Apis::Core::JsonRepresentation property :http_header, as: 'httpHeader' property :name, as: 'name' property :url_query_parameter, as: 'urlQueryParameter' end end class SystemParameterRule # @private class Representation < Google::Apis::Core::JsonRepresentation collection :parameters, as: 'parameters', class: Google::Apis::ServiceusageV1::SystemParameter, decorator: Google::Apis::ServiceusageV1::SystemParameter::Representation property :selector, as: 'selector' end end class SystemParameters # @private class Representation < Google::Apis::Core::JsonRepresentation collection :rules, as: 'rules', class: Google::Apis::ServiceusageV1::SystemParameterRule, decorator: Google::Apis::ServiceusageV1::SystemParameterRule::Representation end end class Type # @private class Representation < Google::Apis::Core::JsonRepresentation collection :fields, as: 'fields', class: Google::Apis::ServiceusageV1::Field, decorator: Google::Apis::ServiceusageV1::Field::Representation property :name, as: 'name' collection :oneofs, as: 'oneofs' collection :options, as: 'options', class: Google::Apis::ServiceusageV1::Option, decorator: Google::Apis::ServiceusageV1::Option::Representation property :source_context, as: 'sourceContext', class: Google::Apis::ServiceusageV1::SourceContext, decorator: Google::Apis::ServiceusageV1::SourceContext::Representation property :syntax, as: 'syntax' end end class UpdateAdminQuotaPolicyMetadata # @private class Representation < Google::Apis::Core::JsonRepresentation end end class Usage # @private class Representation < Google::Apis::Core::JsonRepresentation property :producer_notification_channel, as: 'producerNotificationChannel' collection :requirements, as: 'requirements' collection :rules, as: 'rules', class: Google::Apis::ServiceusageV1::UsageRule, decorator: Google::Apis::ServiceusageV1::UsageRule::Representation end end class UsageRule # @private class Representation < Google::Apis::Core::JsonRepresentation property :allow_unregistered_calls, as: 'allowUnregisteredCalls' property :selector, as: 'selector' property :skip_service_control, as: 'skipServiceControl' end end end end end google-apis-serviceusage-v1-0.28.0/lib/google/apis/serviceusage_v1/gem_version.rb0000644000175000017500000000165214410110425026411 0ustar raviravi# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. module Google module Apis module ServiceusageV1 # Version of the google-apis-serviceusage_v1 gem GEM_VERSION = "0.28.0" # Version of the code generator used to generate this client GENERATOR_VERSION = "0.11.0" # Revision of the discovery document this client was generated from REVISION = "20221115" end end end google-apis-serviceusage-v1-0.28.0/lib/google/apis/serviceusage_v1/classes.rb0000644000175000017500000061025414410110425025535 0ustar raviravi# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module ServiceusageV1 # Quota policy created by quota administrator. class AdminQuotaPolicy include Google::Apis::Core::Hashable # The cloud resource container at which the quota policy is created. The format # is ``container_type`/`container_number`` # Corresponds to the JSON property `container` # @return [String] attr_accessor :container # If this map is nonempty, then this policy applies only to specific values for # dimensions defined in the limit unit. For example, an policy on a limit with # the unit `1/`project`/`region`` could contain an entry with the key `region` # and the value `us-east-1`; the policy is only applied to quota consumed in # that region. This map has the following restrictions: * If `region` appears as # a key, its value must be a valid Cloud region. * If `zone` appears as a key, # its value must be a valid Cloud zone. * Keys other than `region` or `zone` are # not valid. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions # The name of the metric to which this policy applies. An example name would be: # `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric # The resource name of the policy. This name is generated by the server when the # policy is created. Example names would be: `organizations/123/services/compute. # googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/% # 2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota) # . # Corresponds to the JSON property `policyValue` # @return [Fixnum] attr_accessor :policy_value # The limit unit of the limit to which this policy applies. An example unit # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not # placeholders in this example; the literal characters ``` and ``` occur in the # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @container = args[:container] if args.key?(:container) @dimensions = args[:dimensions] if args.key?(:dimensions) @metric = args[:metric] if args.key?(:metric) @name = args[:name] if args.key?(:name) @policy_value = args[:policy_value] if args.key?(:policy_value) @unit = args[:unit] if args.key?(:unit) end end # Api is a light-weight descriptor for an API Interface. Interfaces are also # described as "protocol buffer services" in some contexts, such as by the " # service" keyword in a .proto file, but they are different from API Services, # which represent a concrete implementation of an interface as opposed to simply # a description of methods and bindings. They are also sometimes simply referred # to as "APIs" in other contexts, such as the name of this message itself. See # https://cloud.google.com/apis/design/glossary for detailed terminology. class Api include Google::Apis::Core::Hashable # The methods of this interface, in unspecified order. # Corresponds to the JSON property `methods` # @return [Array] attr_accessor :methods_prop # Included interfaces. See Mixin. # Corresponds to the JSON property `mixins` # @return [Array] attr_accessor :mixins # The fully qualified name of this interface, including package name followed by # the interface's simple name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Any metadata attached to the interface. # Corresponds to the JSON property `options` # @return [Array] attr_accessor :options # `SourceContext` represents information about the source of a protobuf element, # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1::SourceContext] attr_accessor :source_context # The source syntax of the service. # Corresponds to the JSON property `syntax` # @return [String] attr_accessor :syntax # A version string for this interface. If specified, must have the form `major- # version.minor-version`, as in `1.10`. If the minor version is omitted, it # defaults to zero. If the entire version field is empty, the major version is # derived from the package name, as outlined below. If the field is not empty, # the version in the package name will be verified to be consistent with what is # provided here. The versioning schema uses [semantic versioning](http://semver. # org) where the major version number indicates a breaking change and the minor # version an additive, non-breaking change. Both version numbers are signals to # users what to expect from different versions, and should be carefully chosen # based on the product plan. The major version is also reflected in the package # name of the interface, which must end in `v`, as in `google.feature.v1`. For # major versions 0 and 1, the suffix can be omitted. Zero major versions must # only be used for experimental, non-GA interfaces. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @methods_prop = args[:methods_prop] if args.key?(:methods_prop) @mixins = args[:mixins] if args.key?(:mixins) @name = args[:name] if args.key?(:name) @options = args[:options] if args.key?(:options) @source_context = args[:source_context] if args.key?(:source_context) @syntax = args[:syntax] if args.key?(:syntax) @version = args[:version] if args.key?(:version) end end # Configuration for an authentication provider, including support for [JSON Web # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthProvider include Google::Apis::Core::Hashable # The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json- # web-token-32#section-4.1.3). that are allowed to access. A JWT containing any # of these audiences will be accepted. When this setting is absent, JWTs with # audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[ # service.name]/" will be accepted. For example, if no audiences are in the # setting, LibraryService API will accept JWTs with the following audiences: - # https://library-example.googleapis.com/google.example.library.v1. # LibraryService - https://library-example.googleapis.com/ Example: audiences: # bookstore_android.apps.googleusercontent.com, bookstore_web.apps. # googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences # Redirect URL if JWT token is required but not present or is expired. Implement # authorizationUrl of securityDefinitions in OpenAPI spec. # Corresponds to the JSON property `authorizationUrl` # @return [String] attr_accessor :authorization_url # The unique identifier of the auth provider. It will be referred to by ` # AuthRequirement.provider_id`. Example: "bookstore_auth". # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Identifies the principal that issued the JWT. See https://tools.ietf.org/html/ # draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email # address. Example: https://securetoken.google.com Example: 1234567-compute@ # developer.gserviceaccount.com # Corresponds to the JSON property `issuer` # @return [String] attr_accessor :issuer # URL of the provider's public key set to validate signature of the JWT. See [ # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html# # ProviderMetadata). Optional if the key set document: - can be retrieved from [ # OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) # of the issuer. - can be inferred from the email domain of the issuer (e.g. a # Google service account). Example: https://www.googleapis.com/oauth2/v1/certs # Corresponds to the JSON property `jwksUri` # @return [String] attr_accessor :jwks_uri # Defines the locations to extract the JWT. For now it is only used by the Cloud # Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https:// # cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt- # locations) JWT locations can be one of HTTP headers, URL query parameters or # cookies. The rule is that the first match wins. If not specified, default to # use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt- # assertion 3) access_token query parameter Default locations can be specified # as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - # header: x-goog-iap-jwt-assertion - query: access_token # Corresponds to the JSON property `jwtLocations` # @return [Array] attr_accessor :jwt_locations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audiences = args[:audiences] if args.key?(:audiences) @authorization_url = args[:authorization_url] if args.key?(:authorization_url) @id = args[:id] if args.key?(:id) @issuer = args[:issuer] if args.key?(:issuer) @jwks_uri = args[:jwks_uri] if args.key?(:jwks_uri) @jwt_locations = args[:jwt_locations] if args.key?(:jwt_locations) end end # User-defined authentication requirements, including support for [JSON Web # Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). class AuthRequirement include Google::Apis::Core::Hashable # NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented # and accepted in all the runtime components. The list of JWT [audiences](https:/ # /tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that # are allowed to access. A JWT containing any of these audiences will be # accepted. When this setting is absent, only JWTs with audience "https:// # Service_name/API_name" will be accepted. For example, if no audiences are in # the setting, LibraryService API will only accept JWTs with the following # audience "https://library-example.googleapis.com/google.example.library.v1. # LibraryService". Example: audiences: bookstore_android.apps.googleusercontent. # com, bookstore_web.apps.googleusercontent.com # Corresponds to the JSON property `audiences` # @return [String] attr_accessor :audiences # id from authentication provider. Example: provider_id: bookstore_auth # Corresponds to the JSON property `providerId` # @return [String] attr_accessor :provider_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @audiences = args[:audiences] if args.key?(:audiences) @provider_id = args[:provider_id] if args.key?(:provider_id) end end # `Authentication` defines the authentication configuration for API methods # provided by an API service. Example: name: calendar.googleapis.com # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - # selector: "*" requirements: provider_id: google_calendar_auth - selector: # google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/ # auth/calendar.read class Authentication include Google::Apis::Core::Hashable # Defines a set of authentication providers that a service supports. # Corresponds to the JSON property `providers` # @return [Array] attr_accessor :providers # A list of authentication rules that apply to individual API methods. **NOTE:** # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @providers = args[:providers] if args.key?(:providers) @rules = args[:rules] if args.key?(:rules) end end # Authentication rules for the service. By default, if a method has any # authentication requirements, every request must include a valid credential # matching one of the requirements. It's an error to include more than one kind # of credential in a single request. If a method doesn't have any auth # requirements, request credentials will be ignored. class AuthenticationRule include Google::Apis::Core::Hashable # If true, the service accepts API keys without any other credential. This flag # only applies to HTTP and gRPC requests. # Corresponds to the JSON property `allowWithoutCredential` # @return [Boolean] attr_accessor :allow_without_credential alias_method :allow_without_credential?, :allow_without_credential # 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. # Corresponds to the JSON property `oauth` # @return [Google::Apis::ServiceusageV1::OAuthRequirements] attr_accessor :oauth # Requirements for additional authentication providers. # Corresponds to the JSON property `requirements` # @return [Array] attr_accessor :requirements # Selects the methods to which this rule applies. Refer to selector for syntax # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_without_credential = args[:allow_without_credential] if args.key?(:allow_without_credential) @oauth = args[:oauth] if args.key?(:oauth) @requirements = args[:requirements] if args.key?(:requirements) @selector = args[:selector] if args.key?(:selector) end end # `Backend` defines the backend configuration for a service. class Backend include Google::Apis::Core::Hashable # A list of API backend rules that apply to individual API methods. **NOTE:** # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rules = args[:rules] if args.key?(:rules) end end # A backend rule provides configuration for an individual API element. class BackendRule include Google::Apis::Core::Hashable # The address of the API backend. The scheme is used to determine the backend # protocol and security. The following schemes are accepted: SCHEME PROTOCOL # SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC # TLS It is recommended to explicitly include a scheme. Leaving out the scheme # may cause constrasting behaviors across platforms. If the port is unspecified, # the default is: - 80 for schemes without TLS - 443 for schemes with TLS For # HTTP backends, use protocol to specify the protocol version. # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # The number of seconds to wait for a response from a request. The default # varies based on the request protocol and deployment environment. # Corresponds to the JSON property `deadline` # @return [Float] attr_accessor :deadline # When disable_auth is true, a JWT ID token won't be generated and the original " # Authorization" HTTP header will be preserved. If the header is used to carry # the original token and is expected by the backend, this field must be set to # true to preserve the header. # Corresponds to the JSON property `disableAuth` # @return [Boolean] attr_accessor :disable_auth alias_method :disable_auth?, :disable_auth # The JWT audience is used when generating a JWT ID token for the backend. This # ID token will be added in the HTTP "authorization" header, and sent to the # backend. # Corresponds to the JSON property `jwtAudience` # @return [String] attr_accessor :jwt_audience # Deprecated, do not use. # Corresponds to the JSON property `minDeadline` # @return [Float] attr_accessor :min_deadline # The number of seconds to wait for the completion of a long running operation. # The default is no deadline. # Corresponds to the JSON property `operationDeadline` # @return [Float] attr_accessor :operation_deadline # # Corresponds to the JSON property `pathTranslation` # @return [String] attr_accessor :path_translation # The protocol used for sending a request to the backend. The supported values # are "http/1.1" and "h2". The default value is inferred from the scheme in the # address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 # grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this # field to "h2" for improved performance. Configuring this field to non-default # values is only supported for secure HTTP backends. This field will be ignored # for all other backends. See https://www.iana.org/assignments/tls-extensiontype- # values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on # the supported values. # Corresponds to the JSON property `protocol` # @return [String] attr_accessor :protocol # Selects the methods to which this rule applies. Refer to selector for syntax # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @address = args[:address] if args.key?(:address) @deadline = args[:deadline] if args.key?(:deadline) @disable_auth = args[:disable_auth] if args.key?(:disable_auth) @jwt_audience = args[:jwt_audience] if args.key?(:jwt_audience) @min_deadline = args[:min_deadline] if args.key?(:min_deadline) @operation_deadline = args[:operation_deadline] if args.key?(:operation_deadline) @path_translation = args[:path_translation] if args.key?(:path_translation) @protocol = args[:protocol] if args.key?(:protocol) @selector = args[:selector] if args.key?(:selector) end end # Response message for BatchCreateAdminOverrides class BatchCreateAdminOverridesResponse include Google::Apis::Core::Hashable # The overrides that were created. # Corresponds to the JSON property `overrides` # @return [Array] attr_accessor :overrides def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @overrides = args[:overrides] if args.key?(:overrides) end end # Response message for BatchCreateConsumerOverrides class BatchCreateConsumerOverridesResponse include Google::Apis::Core::Hashable # The overrides that were created. # Corresponds to the JSON property `overrides` # @return [Array] attr_accessor :overrides def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @overrides = args[:overrides] if args.key?(:overrides) end end # Request message for the `BatchEnableServices` method. class BatchEnableServicesRequest include Google::Apis::Core::Hashable # The identifiers of the services to enable on the project. A valid identifier # would be: serviceusage.googleapis.com Enabling services requires that each # service is public or is shared with the user enabling the service. A single # request can enable a maximum of 20 services at a time. If more than 20 # services are specified, the request will fail, and no state changes will occur. # Corresponds to the JSON property `serviceIds` # @return [Array] attr_accessor :service_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @service_ids = args[:service_ids] if args.key?(:service_ids) end end # Response message for the `BatchEnableServices` method. This response message # is assigned to the `response` field of the returned Operation when that # operation is done. class BatchEnableServicesResponse include Google::Apis::Core::Hashable # If allow_partial_success is true, and one or more services could not be # enabled, this field contains the details about each failure. # Corresponds to the JSON property `failures` # @return [Array] attr_accessor :failures # The new state of the services after enabling. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @failures = args[:failures] if args.key?(:failures) @services = args[:services] if args.key?(:services) end end # Response message for the `BatchGetServices` method. class BatchGetServicesResponse include Google::Apis::Core::Hashable # The requested Service states. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @services = args[:services] if args.key?(:services) end end # Billing related configuration of the service. The following example shows how # to configure monitored resources and metrics for billing, ` # consumer_destinations` is the only supported destination and the monitored # resources need at least one label key `cloud.googleapis.com/location` to # indicate the location of the billing usage, using different monitored # resources between monitoring and billing is recommended so they can be evolved # independently: monitored_resources: - type: library.googleapis.com/ # billing_branch labels: - key: cloud.googleapis.com/location description: | # Predefined label to support billing location restriction. - key: city # description: | Custom label to define the city where the library branch is # located in. - key: name description: Custom label to define the name of the # library branch. metrics: - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. # googleapis.com/book/borrowed_count class Billing include Google::Apis::Core::Hashable # Billing configurations for sending metrics to the consumer project. There can # be multiple consumer destinations per service, each one must have a different # monitored resource type. A metric can be used in at most one consumer # destination. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) end end # Configuration of a specific billing destination (Currently only support bill # against consumer project). class BillingDestination include Google::Apis::Core::Hashable # Names of the metrics to report to this billing destination. Each name must be # defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # The monitored resource type. The type must be defined in Service. # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @metrics = args[:metrics] if args.key?(:metrics) @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) end end # The request message for Operations.CancelOperation. class CancelOperationRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Details about how and where to publish client libraries. class ClientLibrarySettings include Google::Apis::Core::Hashable # Settings for C++ client libraries. # Corresponds to the JSON property `cppSettings` # @return [Google::Apis::ServiceusageV1::CppSettings] attr_accessor :cpp_settings # Settings for Dotnet client libraries. # Corresponds to the JSON property `dotnetSettings` # @return [Google::Apis::ServiceusageV1::DotnetSettings] attr_accessor :dotnet_settings # Settings for Go client libraries. # Corresponds to the JSON property `goSettings` # @return [Google::Apis::ServiceusageV1::GoSettings] attr_accessor :go_settings # Settings for Java client libraries. # Corresponds to the JSON property `javaSettings` # @return [Google::Apis::ServiceusageV1::JavaSettings] attr_accessor :java_settings # Launch stage of this version of the API. # Corresponds to the JSON property `launchStage` # @return [String] attr_accessor :launch_stage # Settings for Node client libraries. # Corresponds to the JSON property `nodeSettings` # @return [Google::Apis::ServiceusageV1::NodeSettings] attr_accessor :node_settings # Settings for Php client libraries. # Corresponds to the JSON property `phpSettings` # @return [Google::Apis::ServiceusageV1::PhpSettings] attr_accessor :php_settings # Settings for Python client libraries. # Corresponds to the JSON property `pythonSettings` # @return [Google::Apis::ServiceusageV1::PythonSettings] attr_accessor :python_settings # When using transport=rest, the client request will encode enums as numbers # rather than strings. # Corresponds to the JSON property `restNumericEnums` # @return [Boolean] attr_accessor :rest_numeric_enums alias_method :rest_numeric_enums?, :rest_numeric_enums # Settings for Ruby client libraries. # Corresponds to the JSON property `rubySettings` # @return [Google::Apis::ServiceusageV1::RubySettings] attr_accessor :ruby_settings # Version of the API to apply these settings to. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cpp_settings = args[:cpp_settings] if args.key?(:cpp_settings) @dotnet_settings = args[:dotnet_settings] if args.key?(:dotnet_settings) @go_settings = args[:go_settings] if args.key?(:go_settings) @java_settings = args[:java_settings] if args.key?(:java_settings) @launch_stage = args[:launch_stage] if args.key?(:launch_stage) @node_settings = args[:node_settings] if args.key?(:node_settings) @php_settings = args[:php_settings] if args.key?(:php_settings) @python_settings = args[:python_settings] if args.key?(:python_settings) @rest_numeric_enums = args[:rest_numeric_enums] if args.key?(:rest_numeric_enums) @ruby_settings = args[:ruby_settings] if args.key?(:ruby_settings) @version = args[:version] if args.key?(:version) end end # Required information for every language. class CommonLanguageSettings include Google::Apis::Core::Hashable # The destination where API teams want this client library to be published. # Corresponds to the JSON property `destinations` # @return [Array] attr_accessor :destinations # Link to automatically generated reference documentation. Example: https:// # cloud.google.com/nodejs/docs/reference/asset/latest # Corresponds to the JSON property `referenceDocsUri` # @return [String] attr_accessor :reference_docs_uri def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @destinations = args[:destinations] if args.key?(:destinations) @reference_docs_uri = args[:reference_docs_uri] if args.key?(:reference_docs_uri) end end # `Context` defines which contexts an API requests. Example: context: rules: - # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. # context.OriginContext The above specifies that all methods in the API request ` # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. # Available context types are defined in package `google.rpc.context`. This also # provides mechanism to allowlist any protobuf message extension that can be # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. # For example, list any service specific protobuf types that can appear in grpc # metadata as follows in your yaml file: Example: context: rules: - selector: " # google.example.library.v1.LibraryService.CreateBook" # allowed_request_extensions: - google.foo.v1.NewExtension # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify # extension ID instead of fully qualified extension name here. class Context include Google::Apis::Core::Hashable # A list of RPC context rules that apply to individual API methods. **NOTE:** # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rules = args[:rules] if args.key?(:rules) end end # A context rule provides information about the context for an individual API # element. class ContextRule include Google::Apis::Core::Hashable # A list of full type names or extension IDs of extensions allowed in grpc side # channel from client to backend. # Corresponds to the JSON property `allowedRequestExtensions` # @return [Array] attr_accessor :allowed_request_extensions # A list of full type names or extension IDs of extensions allowed in grpc side # channel from backend to client. # Corresponds to the JSON property `allowedResponseExtensions` # @return [Array] attr_accessor :allowed_response_extensions # A list of full type names of provided contexts. # Corresponds to the JSON property `provided` # @return [Array] attr_accessor :provided # A list of full type names of requested contexts. # Corresponds to the JSON property `requested` # @return [Array] attr_accessor :requested # Selects the methods to which this rule applies. Refer to selector for syntax # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allowed_request_extensions = args[:allowed_request_extensions] if args.key?(:allowed_request_extensions) @allowed_response_extensions = args[:allowed_response_extensions] if args.key?(:allowed_response_extensions) @provided = args[:provided] if args.key?(:provided) @requested = args[:requested] if args.key?(:requested) @selector = args[:selector] if args.key?(:selector) end end # Selects and configures the service controller used by the service. Example: # control: environment: servicecontrol.googleapis.com class Control include Google::Apis::Core::Hashable # The service controller environment to use. If empty, no control plane feature ( # like quota and billing) will be enabled. The recommended value for most # services is servicecontrol.googleapis.com # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @environment = args[:environment] if args.key?(:environment) end end # Settings for C++ client libraries. class CppSettings include Google::Apis::Core::Hashable # Required information for every language. # Corresponds to the JSON property `common` # @return [Google::Apis::ServiceusageV1::CommonLanguageSettings] attr_accessor :common def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) end end # Metadata message that provides information such as progress, partial failures, # and similar information on each GetOperation call of LRO returned by # CreateAdminQuotaPolicy. class CreateAdminQuotaPolicyMetadata include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Customize service error responses. For example, list any service specific # protobuf types that can appear in error detail lists of error responses. # Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1. # AnotherError class CustomError include Google::Apis::Core::Hashable # The list of custom error rules that apply to individual API messages. **NOTE:** # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules # The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rules = args[:rules] if args.key?(:rules) @types = args[:types] if args.key?(:types) end end # A custom error rule. class CustomErrorRule include Google::Apis::Core::Hashable # Mark this message as possible payload in error response. Otherwise, objects of # this type will be filtered when they appear in error payload. # Corresponds to the JSON property `isErrorType` # @return [Boolean] attr_accessor :is_error_type alias_method :is_error_type?, :is_error_type # Selects messages to which this rule applies. Refer to selector for syntax # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @is_error_type = args[:is_error_type] if args.key?(:is_error_type) @selector = args[:selector] if args.key?(:selector) end end # A custom pattern is used for defining custom HTTP verb. class CustomHttpPattern include Google::Apis::Core::Hashable # The name of this custom HTTP verb. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The path matched by this custom verb. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kind = args[:kind] if args.key?(:kind) @path = args[:path] if args.key?(:path) end end # Metadata message that provides information such as progress, partial failures, # and similar information on each GetOperation call of LRO returned by # DeleteAdminQuotaPolicy. class DeleteAdminQuotaPolicyMetadata include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Request message for the `DisableService` method. class DisableServiceRequest include Google::Apis::Core::Hashable # Defines the behavior for checking service usage when disabling a service. # Corresponds to the JSON property `checkIfServiceHasUsage` # @return [String] attr_accessor :check_if_service_has_usage # Indicates if services that are enabled and which depend on this service should # also be disabled. If not set, an error will be generated if any enabled # services depend on the service to be disabled. When set, the service, and any # enabled services that depend on it, will be disabled together. # Corresponds to the JSON property `disableDependentServices` # @return [Boolean] attr_accessor :disable_dependent_services alias_method :disable_dependent_services?, :disable_dependent_services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @check_if_service_has_usage = args[:check_if_service_has_usage] if args.key?(:check_if_service_has_usage) @disable_dependent_services = args[:disable_dependent_services] if args.key?(:disable_dependent_services) end end # Response message for the `DisableService` method. This response message is # assigned to the `response` field of the returned Operation when that operation # is done. class DisableServiceResponse include Google::Apis::Core::Hashable # A service that is available for use by the consumer. # Corresponds to the JSON property `service` # @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service] attr_accessor :service def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @service = args[:service] if args.key?(:service) end end # `Documentation` provides the information for describing a service. Example: # documentation: summary: > The Google Calendar API gives access to most # calendar features. pages: - name: Overview content: (== include google/foo/ # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: # google.calendar.Calendar.Put description: > ... Documentation is provided in # markdown syntax. In addition to standard markdown features, definition lists, # tables and fenced code blocks are supported. Section headers can be provided # and are interpreted relative to the section nesting of the context where a # documentation fragment is embedded. Documentation from the IDL is merged with # documentation defined via the config at normalization time, where # documentation provided by config rules overrides IDL provided. A number of # constructs specific to the API platform are supported in documentation text. # In order to reference a proto element, the following notation can be used: [ # fully.qualified.proto.name][] To override the display text used for the link, # this can be used: [display text][fully.qualified.proto.name] Text can be # excluded from doc using the following notation: (-- internal comment --) A few # directives are available in documentation. Note that directives must appear on # a single line to be properly identified. The `include` directive includes a # markdown file from an external source: (== include path/to/file ==) The ` # resource_for` directive marks a message to be the resource of a collection in # REST view. If it is not specified, tools attempt to infer the resource from # the operations in a collection: (== resource_for v1.shelves.books ==) The # directive `suppress_warning` does not directly affect documentation and is # documented together with service config validation. class Documentation include Google::Apis::Core::Hashable # The URL to the root of documentation. # Corresponds to the JSON property `documentationRootUrl` # @return [String] attr_accessor :documentation_root_url # Declares a single overview page. For example: documentation: summary: ... # overview: (== include overview.md ==) This is a shortcut for the following # declaration (using pages style): documentation: summary: ... pages: - name: # Overview content: (== include overview.md ==) Note: you cannot specify both ` # overview` field and `pages` field. # Corresponds to the JSON property `overview` # @return [String] attr_accessor :overview # The top level pages for the documentation set. # Corresponds to the JSON property `pages` # @return [Array] attr_accessor :pages # A list of documentation rules that apply to individual API elements. **NOTE:** # All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules # Specifies the service root url if the default one (the service name from the # yaml file) is not suitable. This can be seen in any fully specified service # urls as well as sections that show a base that other urls are relative to. # Corresponds to the JSON property `serviceRootUrl` # @return [String] attr_accessor :service_root_url # A short description of what the service does. The summary must be plain text. # It becomes the overview of the service displayed in Google Cloud Console. NOTE: # This field is equivalent to the standard field `description`. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @documentation_root_url = args[:documentation_root_url] if args.key?(:documentation_root_url) @overview = args[:overview] if args.key?(:overview) @pages = args[:pages] if args.key?(:pages) @rules = args[:rules] if args.key?(:rules) @service_root_url = args[:service_root_url] if args.key?(:service_root_url) @summary = args[:summary] if args.key?(:summary) end end # A documentation rule provides information about individual API elements. class DocumentationRule include Google::Apis::Core::Hashable # Deprecation description of the selected element(s). It can be provided if an # element is marked as `deprecated`. # Corresponds to the JSON property `deprecationDescription` # @return [String] attr_accessor :deprecation_description # Description of the selected proto element (e.g. a message, a method, a ' # service' definition, or a field). Defaults to leading & trailing comments # taken from the proto source definition of the proto element. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The selector is a comma-separated list of patterns for any element such as a # method, a field, an enum value. Each pattern is a qualified name of the # element which may end in "*", indicating a wildcard. Wildcards are only # allowed at the end and for a whole component of the qualified name, i.e. "foo.* # " is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more # components. To specify a default for all applicable elements, the whole # pattern "*" is used. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deprecation_description = args[:deprecation_description] if args.key?(:deprecation_description) @description = args[:description] if args.key?(:description) @selector = args[:selector] if args.key?(:selector) end end # Settings for Dotnet client libraries. class DotnetSettings include Google::Apis::Core::Hashable # Required information for every language. # Corresponds to the JSON property `common` # @return [Google::Apis::ServiceusageV1::CommonLanguageSettings] attr_accessor :common def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) end end # A generic empty message that you can re-use to avoid defining duplicated empty # messages in your APIs. A typical example is to use it as the request or the # response type of an API method. For instance: service Foo ` rpc Bar(google. # protobuf.Empty) returns (google.protobuf.Empty); ` class Empty include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Provides error messages for the failing services. class EnableFailure include Google::Apis::Core::Hashable # An error message describing why the service could not be enabled. # Corresponds to the JSON property `errorMessage` # @return [String] attr_accessor :error_message # The service id of a service that could not be enabled. # Corresponds to the JSON property `serviceId` # @return [String] attr_accessor :service_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @error_message = args[:error_message] if args.key?(:error_message) @service_id = args[:service_id] if args.key?(:service_id) end end # Request message for the `EnableService` method. class EnableServiceRequest include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Response message for the `EnableService` method. This response message is # assigned to the `response` field of the returned Operation when that operation # is done. class EnableServiceResponse include Google::Apis::Core::Hashable # A service that is available for use by the consumer. # Corresponds to the JSON property `service` # @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1Service] attr_accessor :service def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @service = args[:service] if args.key?(:service) end end # `Endpoint` describes a network address of a service that serves a set of APIs. # It is commonly known as a service endpoint. A service may expose any number of # service endpoints, and all service endpoints share the same service definition, # such as quota limits and monitoring metrics. Example: type: google.api. # Service name: library-example.googleapis.com endpoints: # Declares network # address `https://library-example.googleapis.com` # for service `library- # example.googleapis.com`. The `https` scheme # is implicit for all service # endpoints. Other schemes may be # supported in the future. - name: library- # example.googleapis.com allow_cors: false - name: content-staging-library- # example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API # frontend, for it # to decide whether the subsequent cross-origin request is # allowed # to proceed. allow_cors: true class Endpoint include Google::Apis::Core::Hashable # Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. # Instead of using aliases, please specify multiple google.api.Endpoint for each # of the intended aliases. Additional names that this endpoint will be hosted on. # Corresponds to the JSON property `aliases` # @return [Array] attr_accessor :aliases # Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), # aka cross-domain traffic, would allow the backends served from this endpoint # to receive and respond to HTTP OPTIONS requests. The response will be used by # the browser to determine whether the subsequent cross-origin request is # allowed to proceed. # Corresponds to the JSON property `allowCors` # @return [Boolean] attr_accessor :allow_cors alias_method :allow_cors?, :allow_cors # The canonical name of this endpoint. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The specification of an Internet routable address of API frontend that will # handle requests to this [API Endpoint](https://cloud.google.com/apis/design/ # glossary). It should be either a valid IPv4 address or a fully-qualified # domain name. For example, "8.8.8.8" or "myservice.appspot.com". # Corresponds to the JSON property `target` # @return [String] attr_accessor :target def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @aliases = args[:aliases] if args.key?(:aliases) @allow_cors = args[:allow_cors] if args.key?(:allow_cors) @name = args[:name] if args.key?(:name) @target = args[:target] if args.key?(:target) end end # Enum type definition. class Enum include Google::Apis::Core::Hashable # Enum value definitions. # Corresponds to the JSON property `enumvalue` # @return [Array] attr_accessor :enumvalue # Enum type name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Protocol buffer options. # Corresponds to the JSON property `options` # @return [Array] attr_accessor :options # `SourceContext` represents information about the source of a protobuf element, # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1::SourceContext] attr_accessor :source_context # The source syntax. # Corresponds to the JSON property `syntax` # @return [String] attr_accessor :syntax def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @enumvalue = args[:enumvalue] if args.key?(:enumvalue) @name = args[:name] if args.key?(:name) @options = args[:options] if args.key?(:options) @source_context = args[:source_context] if args.key?(:source_context) @syntax = args[:syntax] if args.key?(:syntax) end end # Enum value definition. class EnumValue include Google::Apis::Core::Hashable # Enum value name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Enum value number. # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number # Protocol buffer options. # Corresponds to the JSON property `options` # @return [Array] attr_accessor :options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @number = args[:number] if args.key?(:number) @options = args[:options] if args.key?(:options) end end # A single field of a message type. class Field include Google::Apis::Core::Hashable # The field cardinality. # Corresponds to the JSON property `cardinality` # @return [String] attr_accessor :cardinality # The string value of the default value of this field. Proto2 syntax only. # Corresponds to the JSON property `defaultValue` # @return [String] attr_accessor :default_value # The field JSON name. # Corresponds to the JSON property `jsonName` # @return [String] attr_accessor :json_name # The field type. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The field name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The field number. # Corresponds to the JSON property `number` # @return [Fixnum] attr_accessor :number # The index of the field type in `Type.oneofs`, for message or enumeration types. # The first type has index 1; zero means the type is not in the list. # Corresponds to the JSON property `oneofIndex` # @return [Fixnum] attr_accessor :oneof_index # The protocol buffer options. # Corresponds to the JSON property `options` # @return [Array] attr_accessor :options # Whether to use alternative packed wire representation. # Corresponds to the JSON property `packed` # @return [Boolean] attr_accessor :packed alias_method :packed?, :packed # The field type URL, without the scheme, for message or enumeration types. # Example: `"type.googleapis.com/google.protobuf.Timestamp"`. # Corresponds to the JSON property `typeUrl` # @return [String] attr_accessor :type_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cardinality = args[:cardinality] if args.key?(:cardinality) @default_value = args[:default_value] if args.key?(:default_value) @json_name = args[:json_name] if args.key?(:json_name) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @number = args[:number] if args.key?(:number) @oneof_index = args[:oneof_index] if args.key?(:oneof_index) @options = args[:options] if args.key?(:options) @packed = args[:packed] if args.key?(:packed) @type_url = args[:type_url] if args.key?(:type_url) end end # Metadata for the `GetServiceIdentity` method. class GetServiceIdentityMetadata include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Response message for getting service identity. class GetServiceIdentityResponse include Google::Apis::Core::Hashable # Service identity for a service. This is the identity that service producer # should use to access consumer resources. # Corresponds to the JSON property `identity` # @return [Google::Apis::ServiceusageV1::ServiceIdentity] attr_accessor :identity # Service identity state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @identity = args[:identity] if args.key?(:identity) @state = args[:state] if args.key?(:state) end end # Settings for Go client libraries. class GoSettings include Google::Apis::Core::Hashable # Required information for every language. # Corresponds to the JSON property `common` # @return [Google::Apis::ServiceusageV1::CommonLanguageSettings] attr_accessor :common def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) end end # `Service` is the root object of Google API service configuration (service # config). It describes the basic information about a logical service, such as # the service name and the user-facing title, and delegates other aspects to sub- # sections. Each sub-section is either a proto message or a repeated proto # message that configures a specific aspect, such as auth. For more information, # see each proto message definition. Example: type: google.api.Service name: # calendar.googleapis.com title: Google Calendar API apis: - name: google. # calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" # restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" # address: calendar.example.com authentication: providers: - id: # google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs # issuer: https://securetoken.google.com rules: - selector: "*" requirements: # provider_id: google_calendar_auth class GoogleApiService include Google::Apis::Core::Hashable # 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. # Corresponds to the JSON property `apis` # @return [Array] attr_accessor :apis # `Authentication` defines the authentication configuration for API methods # provided by an API service. Example: name: calendar.googleapis.com # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - # selector: "*" requirements: provider_id: google_calendar_auth - selector: # google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/ # auth/calendar.read # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceusageV1::Authentication] attr_accessor :authentication # `Backend` defines the backend configuration for a service. # Corresponds to the JSON property `backend` # @return [Google::Apis::ServiceusageV1::Backend] attr_accessor :backend # Billing related configuration of the service. The following example shows how # to configure monitored resources and metrics for billing, ` # consumer_destinations` is the only supported destination and the monitored # resources need at least one label key `cloud.googleapis.com/location` to # indicate the location of the billing usage, using different monitored # resources between monitoring and billing is recommended so they can be evolved # independently: monitored_resources: - type: library.googleapis.com/ # billing_branch labels: - key: cloud.googleapis.com/location description: | # Predefined label to support billing location restriction. - key: city # description: | Custom label to define the city where the library branch is # located in. - key: name description: Custom label to define the name of the # library branch. metrics: - name: library.googleapis.com/book/borrowed_count # metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: # - monitored_resource: library.googleapis.com/billing_branch metrics: - library. # googleapis.com/book/borrowed_count # Corresponds to the JSON property `billing` # @return [Google::Apis::ServiceusageV1::Billing] attr_accessor :billing # Obsolete. Do not use. This field has no semantic meaning. The service config # compiler always sets this field to `3`. # Corresponds to the JSON property `configVersion` # @return [Fixnum] attr_accessor :config_version # `Context` defines which contexts an API requests. Example: context: rules: - # selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc. # context.OriginContext The above specifies that all methods in the API request ` # google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. # Available context types are defined in package `google.rpc.context`. This also # provides mechanism to allowlist any protobuf message extension that can be # sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. # For example, list any service specific protobuf types that can appear in grpc # metadata as follows in your yaml file: Example: context: rules: - selector: " # google.example.library.v1.LibraryService.CreateBook" # allowed_request_extensions: - google.foo.v1.NewExtension # allowed_response_extensions: - google.foo.v1.NewExtension You can also specify # extension ID instead of fully qualified extension name here. # Corresponds to the JSON property `context` # @return [Google::Apis::ServiceusageV1::Context] attr_accessor :context # Selects and configures the service controller used by the service. Example: # control: environment: servicecontrol.googleapis.com # Corresponds to the JSON property `control` # @return [Google::Apis::ServiceusageV1::Control] attr_accessor :control # 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 # Corresponds to the JSON property `customError` # @return [Google::Apis::ServiceusageV1::CustomError] attr_accessor :custom_error # `Documentation` provides the information for describing a service. Example: # documentation: summary: > The Google Calendar API gives access to most # calendar features. pages: - name: Overview content: (== include google/foo/ # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: # google.calendar.Calendar.Put description: > ... Documentation is provided in # markdown syntax. In addition to standard markdown features, definition lists, # tables and fenced code blocks are supported. Section headers can be provided # and are interpreted relative to the section nesting of the context where a # documentation fragment is embedded. Documentation from the IDL is merged with # documentation defined via the config at normalization time, where # documentation provided by config rules overrides IDL provided. A number of # constructs specific to the API platform are supported in documentation text. # In order to reference a proto element, the following notation can be used: [ # fully.qualified.proto.name][] To override the display text used for the link, # this can be used: [display text][fully.qualified.proto.name] Text can be # excluded from doc using the following notation: (-- internal comment --) A few # directives are available in documentation. Note that directives must appear on # a single line to be properly identified. The `include` directive includes a # markdown file from an external source: (== include path/to/file ==) The ` # resource_for` directive marks a message to be the resource of a collection in # REST view. If it is not specified, tools attempt to infer the resource from # the operations in a collection: (== resource_for v1.shelves.books ==) The # directive `suppress_warning` does not directly affect documentation and is # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceusageV1::Documentation] attr_accessor :documentation # Configuration for network endpoints. If this is empty, then an endpoint with # the same name as the service is automatically generated to service all defined # APIs. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints # A list of all enum types included in this API service. Enums referenced # directly or indirectly by the `apis` are automatically included. Enums which # are not referenced but shall be included should be listed here by name by the # configuration author. Example: enums: - name: google.someapi.v1.SomeEnum # Corresponds to the JSON property `enums` # @return [Array] attr_accessor :enums # Defines the HTTP configuration for an API service. It contains a list of # HttpRule, each specifying the mapping of an RPC method to one or more HTTP # REST API methods. # Corresponds to the JSON property `http` # @return [Google::Apis::ServiceusageV1::Http] attr_accessor :http # A unique ID for a specific instance of this message, typically assigned by the # client for tracking purpose. Must be no longer than 63 characters and only # lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server # may choose to generate one instead. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Logging configuration of the service. The following example shows how to # configure logs to be sent to the producer and consumer projects. In the # example, the `activity_history` log is sent to both the producer and consumer # projects, whereas the `purchase_history` log is only sent to the producer # project. monitored_resources: - type: library.googleapis.com/branch labels: - # key: /city description: The city where the library branch is located in. - key: # /name description: The name of the branch. logs: - name: activity_history # labels: - key: /customer_id - name: purchase_history logging: # producer_destinations: - monitored_resource: library.googleapis.com/branch # logs: - activity_history - purchase_history consumer_destinations: - # monitored_resource: library.googleapis.com/branch logs: - activity_history # Corresponds to the JSON property `logging` # @return [Google::Apis::ServiceusageV1::Logging] attr_accessor :logging # Defines the logs used by this service. # Corresponds to the JSON property `logs` # @return [Array] attr_accessor :logs # Defines the metrics used by this service. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # Defines the monitored resources used by this service. This is required by the # Service.monitoring and Service.logging configurations. # Corresponds to the JSON property `monitoredResources` # @return [Array] attr_accessor :monitored_resources # Monitoring configuration of the service. The example below shows how to # configure monitored resources and metrics for monitoring. In the example, a # monitored resource and two metrics are defined. The `library.googleapis.com/ # book/returned_count` metric is sent to both producer and consumer projects, # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to # the consumer project. monitored_resources: - type: library.googleapis.com/ # Branch display_name: "Library Branch" description: "A branch of a library." # launch_stage: GA labels: - key: resource_container description: "The Cloud # container (ie. project id) for the Branch." - key: location description: "The # location of the library branch." - key: branch_id description: "The id of the # branch." metrics: - name: library.googleapis.com/book/returned_count # display_name: "Books Returned" description: "The count of books that have been # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" # labels: - key: customer_id description: "The id of the customer." - name: # library.googleapis.com/book/num_overdue display_name: "Books Overdue" # description: "The current number of overdue books." launch_stage: GA # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id # description: "The id of the customer." monitoring: producer_destinations: - # monitored_resource: library.googleapis.com/Branch metrics: - library. # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ # returned_count - library.googleapis.com/book/num_overdue # Corresponds to the JSON property `monitoring` # @return [Google::Apis::ServiceusageV1::Monitoring] attr_accessor :monitoring # The service name, which is a DNS-like logical identifier for the service, such # as `calendar.googleapis.com`. The service name typically goes through DNS # verification to make sure the owner of the service also owns the DNS name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The Google project that owns this service. # Corresponds to the JSON property `producerProjectId` # @return [String] attr_accessor :producer_project_id # This message configures the settings for publishing [Google Cloud Client # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) # generated from the service config. # Corresponds to the JSON property `publishing` # @return [Google::Apis::ServiceusageV1::Publishing] attr_accessor :publishing # Quota configuration helps to achieve fairness and budgeting in service usage. # The metric based quota configuration works this way: - The service # configuration defines a set of metrics. - For API calls, the quota. # metric_rules maps methods to metrics with corresponding costs. - The quota. # limits defines limits on the metrics, which will be used for quota checks at # runtime. An example quota configuration in yaml format: quota: limits: - name: # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` # project`" # rate limit for consumer projects values: STANDARD: 10000 (The # metric rules bind all methods to the read_calls metric, except for the # UpdateBook and DeleteBook methods. These two methods are mapped to the # write_calls metric, with the UpdateBook method consuming at twice rate as the # DeleteBook method.) metric_rules: - selector: "*" metric_costs: library. # googleapis.com/read_calls: 1 - selector: google.example.library.v1. # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: # - name: library.googleapis.com/read_calls display_name: Read requests # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceusageV1::Quota] attr_accessor :quota # Source information used to create a Service Config # Corresponds to the JSON property `sourceInfo` # @return [Google::Apis::ServiceusageV1::SourceInfo] attr_accessor :source_info # ### 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. # Corresponds to the JSON property `systemParameters` # @return [Google::Apis::ServiceusageV1::SystemParameters] attr_accessor :system_parameters # 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. # Corresponds to the JSON property `systemTypes` # @return [Array] attr_accessor :system_types # The product title for this service, it is the name displayed in Google Cloud # Console. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # A list of all proto message types included in this API service. Types # referenced directly or indirectly by the `apis` are automatically included. # Messages which are not referenced but shall be included, such as types used by # the `google.protobuf.Any` type, should be listed here by name by the # configuration author. Example: types: - name: google.protobuf.Int32 # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types # Configuration controlling usage of a service. # Corresponds to the JSON property `usage` # @return [Google::Apis::ServiceusageV1::Usage] attr_accessor :usage def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @apis = args[:apis] if args.key?(:apis) @authentication = args[:authentication] if args.key?(:authentication) @backend = args[:backend] if args.key?(:backend) @billing = args[:billing] if args.key?(:billing) @config_version = args[:config_version] if args.key?(:config_version) @context = args[:context] if args.key?(:context) @control = args[:control] if args.key?(:control) @custom_error = args[:custom_error] if args.key?(:custom_error) @documentation = args[:documentation] if args.key?(:documentation) @endpoints = args[:endpoints] if args.key?(:endpoints) @enums = args[:enums] if args.key?(:enums) @http = args[:http] if args.key?(:http) @id = args[:id] if args.key?(:id) @logging = args[:logging] if args.key?(:logging) @logs = args[:logs] if args.key?(:logs) @metrics = args[:metrics] if args.key?(:metrics) @monitored_resources = args[:monitored_resources] if args.key?(:monitored_resources) @monitoring = args[:monitoring] if args.key?(:monitoring) @name = args[:name] if args.key?(:name) @producer_project_id = args[:producer_project_id] if args.key?(:producer_project_id) @publishing = args[:publishing] if args.key?(:publishing) @quota = args[:quota] if args.key?(:quota) @source_info = args[:source_info] if args.key?(:source_info) @system_parameters = args[:system_parameters] if args.key?(:system_parameters) @system_types = args[:system_types] if args.key?(:system_types) @title = args[:title] if args.key?(:title) @types = args[:types] if args.key?(:types) @usage = args[:usage] if args.key?(:usage) end end # The operation metadata returned for the batchend services operation. class GoogleApiServiceusageV1OperationMetadata include Google::Apis::Core::Hashable # The full name of the resources that this operation is directly associated with. # Corresponds to the JSON property `resourceNames` # @return [Array] attr_accessor :resource_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_names = args[:resource_names] if args.key?(:resource_names) end end # A service that is available for use by the consumer. class GoogleApiServiceusageV1Service include Google::Apis::Core::Hashable # The configuration of the service. # Corresponds to the JSON property `config` # @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1ServiceConfig] attr_accessor :config # The resource name of the consumer and service. A valid name would be: - # projects/123/services/serviceusage.googleapis.com # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The resource name of the consumer. A valid name would be: - projects/123 # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent # Whether or not the service has been enabled for use by the consumer. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @config = args[:config] if args.key?(:config) @name = args[:name] if args.key?(:name) @parent = args[:parent] if args.key?(:parent) @state = args[:state] if args.key?(:state) end end # The configuration of the service. class GoogleApiServiceusageV1ServiceConfig include Google::Apis::Core::Hashable # A list of API interfaces exported by this service. Contains only the names, # versions, and method names of the interfaces. # Corresponds to the JSON property `apis` # @return [Array] attr_accessor :apis # `Authentication` defines the authentication configuration for API methods # provided by an API service. Example: name: calendar.googleapis.com # authentication: providers: - id: google_calendar_auth jwks_uri: https://www. # googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - # selector: "*" requirements: provider_id: google_calendar_auth - selector: # google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/ # auth/calendar.read # Corresponds to the JSON property `authentication` # @return [Google::Apis::ServiceusageV1::Authentication] attr_accessor :authentication # `Documentation` provides the information for describing a service. Example: # documentation: summary: > The Google Calendar API gives access to most # calendar features. pages: - name: Overview content: (== include google/foo/ # overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md == # ) subpages; - name: Java content: (== include google/foo/tutorial_java.md ==) # rules: - selector: google.calendar.Calendar.Get description: > ... - selector: # google.calendar.Calendar.Put description: > ... Documentation is provided in # markdown syntax. In addition to standard markdown features, definition lists, # tables and fenced code blocks are supported. Section headers can be provided # and are interpreted relative to the section nesting of the context where a # documentation fragment is embedded. Documentation from the IDL is merged with # documentation defined via the config at normalization time, where # documentation provided by config rules overrides IDL provided. A number of # constructs specific to the API platform are supported in documentation text. # In order to reference a proto element, the following notation can be used: [ # fully.qualified.proto.name][] To override the display text used for the link, # this can be used: [display text][fully.qualified.proto.name] Text can be # excluded from doc using the following notation: (-- internal comment --) A few # directives are available in documentation. Note that directives must appear on # a single line to be properly identified. The `include` directive includes a # markdown file from an external source: (== include path/to/file ==) The ` # resource_for` directive marks a message to be the resource of a collection in # REST view. If it is not specified, tools attempt to infer the resource from # the operations in a collection: (== resource_for v1.shelves.books ==) The # directive `suppress_warning` does not directly affect documentation and is # documented together with service config validation. # Corresponds to the JSON property `documentation` # @return [Google::Apis::ServiceusageV1::Documentation] attr_accessor :documentation # Configuration for network endpoints. Contains only the names and aliases of # the endpoints. # Corresponds to the JSON property `endpoints` # @return [Array] attr_accessor :endpoints # Defines the monitored resources used by this service. This is required by the # Service.monitoring and Service.logging configurations. # Corresponds to the JSON property `monitoredResources` # @return [Array] attr_accessor :monitored_resources # Monitoring configuration of the service. The example below shows how to # configure monitored resources and metrics for monitoring. In the example, a # monitored resource and two metrics are defined. The `library.googleapis.com/ # book/returned_count` metric is sent to both producer and consumer projects, # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to # the consumer project. monitored_resources: - type: library.googleapis.com/ # Branch display_name: "Library Branch" description: "A branch of a library." # launch_stage: GA labels: - key: resource_container description: "The Cloud # container (ie. project id) for the Branch." - key: location description: "The # location of the library branch." - key: branch_id description: "The id of the # branch." metrics: - name: library.googleapis.com/book/returned_count # display_name: "Books Returned" description: "The count of books that have been # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" # labels: - key: customer_id description: "The id of the customer." - name: # library.googleapis.com/book/num_overdue display_name: "Books Overdue" # description: "The current number of overdue books." launch_stage: GA # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id # description: "The id of the customer." monitoring: producer_destinations: - # monitored_resource: library.googleapis.com/Branch metrics: - library. # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ # returned_count - library.googleapis.com/book/num_overdue # Corresponds to the JSON property `monitoring` # @return [Google::Apis::ServiceusageV1::Monitoring] attr_accessor :monitoring # The DNS address at which this service is available. An example DNS address # would be: `calendar.googleapis.com`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Quota configuration helps to achieve fairness and budgeting in service usage. # The metric based quota configuration works this way: - The service # configuration defines a set of metrics. - For API calls, the quota. # metric_rules maps methods to metrics with corresponding costs. - The quota. # limits defines limits on the metrics, which will be used for quota checks at # runtime. An example quota configuration in yaml format: quota: limits: - name: # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` # project`" # rate limit for consumer projects values: STANDARD: 10000 (The # metric rules bind all methods to the read_calls metric, except for the # UpdateBook and DeleteBook methods. These two methods are mapped to the # write_calls metric, with the UpdateBook method consuming at twice rate as the # DeleteBook method.) metric_rules: - selector: "*" metric_costs: library. # googleapis.com/read_calls: 1 - selector: google.example.library.v1. # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: # - name: library.googleapis.com/read_calls display_name: Read requests # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 # Corresponds to the JSON property `quota` # @return [Google::Apis::ServiceusageV1::Quota] attr_accessor :quota # The product title for this service. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title # Configuration controlling usage of a service. # Corresponds to the JSON property `usage` # @return [Google::Apis::ServiceusageV1::Usage] attr_accessor :usage def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @apis = args[:apis] if args.key?(:apis) @authentication = args[:authentication] if args.key?(:authentication) @documentation = args[:documentation] if args.key?(:documentation) @endpoints = args[:endpoints] if args.key?(:endpoints) @monitored_resources = args[:monitored_resources] if args.key?(:monitored_resources) @monitoring = args[:monitoring] if args.key?(:monitoring) @name = args[:name] if args.key?(:name) @quota = args[:quota] if args.key?(:quota) @title = args[:title] if args.key?(:title) @usage = args[:usage] if args.key?(:usage) end end # Response message for getting service identity. class GoogleApiServiceusageV1beta1GetServiceIdentityResponse include Google::Apis::Core::Hashable # Service identity for a service. This is the identity that service producer # should use to access consumer resources. # Corresponds to the JSON property `identity` # @return [Google::Apis::ServiceusageV1::GoogleApiServiceusageV1beta1ServiceIdentity] attr_accessor :identity # Service identity state. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @identity = args[:identity] if args.key?(:identity) @state = args[:state] if args.key?(:state) end end # Service identity for a service. This is the identity that service producer # should use to access consumer resources. class GoogleApiServiceusageV1beta1ServiceIdentity include Google::Apis::Core::Hashable # The email address of the service account that a service producer would use to # access consumer resources. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The unique and stable id of the service account. https://cloud.google.com/iam/ # reference/rest/v1/projects.serviceAccounts#ServiceAccount # Corresponds to the JSON property `uniqueId` # @return [String] attr_accessor :unique_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @unique_id = args[:unique_id] if args.key?(:unique_id) end end # Defines the HTTP configuration for an API service. It contains a list of # HttpRule, each specifying the mapping of an RPC method to one or more HTTP # REST API methods. class Http include Google::Apis::Core::Hashable # When set to true, URL path parameters will be fully URI-decoded except in # cases of single segment matches in reserved expansion, where "%2F" will be # left encoded. The default behavior is to not decode RFC 6570 reserved # characters in multi segment matches. # Corresponds to the JSON property `fullyDecodeReservedExpansion` # @return [Boolean] attr_accessor :fully_decode_reserved_expansion alias_method :fully_decode_reserved_expansion?, :fully_decode_reserved_expansion # A list of HTTP configuration rules that apply to individual API methods. ** # NOTE:** All service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fully_decode_reserved_expansion = args[:fully_decode_reserved_expansion] if args.key?(:fully_decode_reserved_expansion) @rules = args[:rules] if args.key?(:rules) end end # # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC # method and one or more HTTP REST endpoints. It allows developers to build a # single API service that supports both gRPC APIs and REST APIs. Many systems, # including [Google APIs](https://github.com/googleapis/googleapis), [Cloud # Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github. # com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/ # envoy) proxy support this feature and use it for large scale production # services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping # specifies how different portions of the gRPC request message are mapped to the # URL path, URL query parameters, and HTTP request body. It also controls how # the gRPC response message is mapped to the HTTP response body. `HttpRule` is # typically specified as an `google.api.http` annotation on the gRPC method. # Each mapping specifies a URL path template and an HTTP method. The path # template may refer to one or more fields in the gRPC request message, as long # as each field is a non-repeated field with a primitive (non-message) type. The # path template controls how fields of the request message are mapped to the URL # path. Example: service Messaging ` rpc GetMessage(GetMessageRequest) returns ( # Message) ` option (google.api.http) = ` get: "/v1/`name=messages/*`" `; ` ` # message GetMessageRequest ` string name = 1; // Mapped to URL path. ` message # Message ` string text = 1; // The resource content. ` This enables an HTTP # REST to gRPC mapping as below: HTTP | gRPC -----|----- `GET /v1/messages/ # 123456` | `GetMessage(name: "messages/123456")` Any fields in the request # message which are not bound by the path template automatically become HTTP # query parameters if there is no HTTP request body. For example: service # Messaging ` rpc GetMessage(GetMessageRequest) returns (Message) ` option ( # google.api.http) = ` get:"/v1/messages/`message_id`" `; ` ` message # GetMessageRequest ` message SubMessage ` string subfield = 1; ` string # message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL # query parameter `revision`. SubMessage sub = 3; // Mapped to URL query # parameter `sub.subfield`. ` This enables a HTTP JSON to RPC mapping as below: # HTTP | gRPC -----|----- `GET /v1/messages/123456?revision=2&sub.subfield=foo` | # `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo")) # ` Note that fields which are mapped to URL query parameters must have a # primitive type or a repeated primitive type or a non-repeated message type. In # the case of a repeated type, the parameter can be repeated in the URL as `...? # param=A¶m=B`. In the case of a message type, each field of the message is # mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For # HTTP methods that allow a request body, the `body` field specifies the mapping. # Consider a REST update method on the message resource collection: service # Messaging ` rpc UpdateMessage(UpdateMessageRequest) returns (Message) ` option # (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "message" `; ` ` # message UpdateMessageRequest ` string message_id = 1; // mapped to the URL # Message message = 2; // mapped to the body ` The following HTTP JSON to RPC # mapping is enabled, where the representation of the JSON in the request body # is determined by protos JSON encoding: HTTP | gRPC -----|----- `PATCH /v1/ # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" # message ` text: "Hi!" `)` The special name `*` can be used in the body mapping # to define that every field not bound by the path template should be mapped to # the request body. This enables the following alternative definition of the # update method: service Messaging ` rpc UpdateMessage(Message) returns (Message) # ` option (google.api.http) = ` patch: "/v1/messages/`message_id`" body: "*" `; # ` ` message Message ` string message_id = 1; string text = 2; ` The following # HTTP JSON to RPC mapping is enabled: HTTP | gRPC -----|----- `PATCH /v1/ # messages/123456 ` "text": "Hi!" `` | `UpdateMessage(message_id: "123456" text: # "Hi!")` Note that when using `*` in the body mapping, it is not possible to # have HTTP parameters, as all fields not bound by the path end in the body. # This makes this option more rarely used in practice when defining REST APIs. # The common usage of `*` is in custom methods which don't use the URL at all # for transferring data. It is possible to define multiple HTTP methods for one # RPC by using the `additional_bindings` option. Example: service Messaging ` # rpc GetMessage(GetMessageRequest) returns (Message) ` option (google.api.http) # = ` get: "/v1/messages/`message_id`" additional_bindings ` get: "/v1/users/` # user_id`/messages/`message_id`" ` `; ` ` message GetMessageRequest ` string # message_id = 1; string user_id = 2; ` This enables the following two # alternative HTTP JSON to RPC mappings: HTTP | gRPC -----|----- `GET /v1/ # messages/123456` | `GetMessage(message_id: "123456")` `GET /v1/users/me/ # messages/123456` | `GetMessage(user_id: "me" message_id: "123456")` ## Rules # for HTTP mapping 1. Leaf request fields (recursive expansion nested messages # in the request message) are classified into three categories: - Fields # referred by the path template. They are passed via the URL path. - Fields # referred by the HttpRule.body. They are passed via the HTTP request body. - # All other fields are passed via the URL query parameters, and the parameter # name is the field path in the request message. A repeated field can be # represented as multiple query parameters under the same name. 2. If HttpRule. # body is "*", there is no URL query parameter, all fields are passed via URL # path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP # request body, all fields are passed via URL path and URL query parameters. ### # Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment ` "/ # " Segment ` ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "`" # FieldPath [ "=" Segments ] "`" ; FieldPath = IDENT ` "." IDENT ` ; Verb = ":" # LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` # matches zero or more URL path segments, which must be the last part of the URL # path except the `Verb`. The syntax `Variable` matches part of the URL path as # specified by its template. A variable template must not contain other # variables. If a variable matches a single path segment, its template may be # omitted, e.g. ``var`` is equivalent to ``var=*``. The syntax `LITERAL` matches # literal text in the URL path. If the `LITERAL` contains any reserved character, # such characters should be percent-encoded before the matching. If a variable # contains exactly one path segment, such as `"`var`"` or `"`var=*`"`, when such # a variable is expanded into a URL path on the client side, all characters # except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse # decoding. Such variables show up in the [Discovery Document](https:// # developers.google.com/discovery/v1/reference/apis) as ``var``. If a variable # contains multiple path segments, such as `"`var=foo/*`"` or `"`var=**`"`, when # such a variable is expanded into a URL path on the client side, all characters # except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the # reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables # show up in the [Discovery Document](https://developers.google.com/discovery/v1/ # reference/apis) as ``+var``. ## Using gRPC API Service Configuration gRPC API # Service Configuration (service config) is a configuration language for # configuring a gRPC service to become a user-facing product. The service config # is simply the YAML representation of the `google.api.Service` proto message. # As an alternative to annotating your proto file, you can configure gRPC # transcoding in your service config YAML files. You do this by specifying a ` # HttpRule` that maps the gRPC method to a REST endpoint, achieving the same # effect as the proto annotation. This can be particularly useful if you have a # proto that is reused in multiple services. Note that any transcoding specified # in the service config will override any matching transcoding configuration in # the proto. Example: http: rules: # Selects a gRPC method and applies HttpRule # to it. - selector: example.v1.Messaging.GetMessage get: /v1/messages/` # message_id`/`sub.subfield` ## Special notes When gRPC Transcoding is used to # map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow # the [proto3 specification](https://developers.google.com/protocol-buffers/docs/ # proto3#json). While the single segment variable follows the semantics of [RFC # 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String # Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2. # 3 Reserved Expansion. The reason is that the Reserved Expansion does not # expand special characters like `?` and `#`, which would lead to invalid URLs. # As the result, gRPC Transcoding uses a custom encoding for multi segment # variables. The path variables **must not** refer to any repeated or mapped # field, because client libraries are not capable of handling such variable # expansion. The path variables **must not** capture the leading "/" character. # The reason is that the most common use case "`var`" does not capture the # leading "/" character. For consistency, all path variables must share the same # behavior. Repeated message fields must not be mapped to URL query parameters, # because no client library can support such complicated mapping. If an API # needs to use a JSON array for request or response body, it can map the request # or response body to a repeated field. However, some gRPC Transcoding # implementations may not support this feature. class HttpRule include Google::Apis::Core::Hashable # 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). # Corresponds to the JSON property `additionalBindings` # @return [Array] attr_accessor :additional_bindings # The name of the request field whose value is mapped to the HTTP request body, # or `*` for mapping all request fields not captured by the path pattern to the # HTTP body, or omitted for not having any HTTP request body. NOTE: the referred # field must be present at the top-level of the request message type. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body # A custom pattern is used for defining custom HTTP verb. # Corresponds to the JSON property `custom` # @return [Google::Apis::ServiceusageV1::CustomHttpPattern] attr_accessor :custom # Maps to HTTP DELETE. Used for deleting a resource. # Corresponds to the JSON property `delete` # @return [String] attr_accessor :delete # Maps to HTTP GET. Used for listing and getting information about resources. # Corresponds to the JSON property `get` # @return [String] attr_accessor :get # Maps to HTTP PATCH. Used for updating a resource. # Corresponds to the JSON property `patch` # @return [String] attr_accessor :patch # Maps to HTTP POST. Used for creating a resource or performing an action. # Corresponds to the JSON property `post` # @return [String] attr_accessor :post # Maps to HTTP PUT. Used for replacing a resource. # Corresponds to the JSON property `put` # @return [String] attr_accessor :put # Optional. The name of the response field whose value is mapped to the HTTP # response body. When omitted, the entire response message will be used as the # HTTP response body. NOTE: The referred field must be present at the top-level # of the response message type. # Corresponds to the JSON property `responseBody` # @return [String] attr_accessor :response_body # Selects a method to which this rule applies. Refer to selector for syntax # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @additional_bindings = args[:additional_bindings] if args.key?(:additional_bindings) @body = args[:body] if args.key?(:body) @custom = args[:custom] if args.key?(:custom) @delete = args[:delete] if args.key?(:delete) @get = args[:get] if args.key?(:get) @patch = args[:patch] if args.key?(:patch) @post = args[:post] if args.key?(:post) @put = args[:put] if args.key?(:put) @response_body = args[:response_body] if args.key?(:response_body) @selector = args[:selector] if args.key?(:selector) end end # Metadata message that provides information such as progress, partial failures, # and similar information on each GetOperation call of LRO returned by # ImportAdminOverrides. class ImportAdminOverridesMetadata include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Response message for ImportAdminOverrides class ImportAdminOverridesResponse include Google::Apis::Core::Hashable # The overrides that were created from the imported data. # Corresponds to the JSON property `overrides` # @return [Array] attr_accessor :overrides def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @overrides = args[:overrides] if args.key?(:overrides) end end # Metadata message that provides information such as progress, partial failures, # and similar information on each GetOperation call of LRO returned by # ImportAdminQuotaPolicies. class ImportAdminQuotaPoliciesMetadata include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Response message for ImportAdminQuotaPolicies class ImportAdminQuotaPoliciesResponse include Google::Apis::Core::Hashable # The policies that were created from the imported data. # Corresponds to the JSON property `policies` # @return [Array] attr_accessor :policies def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @policies = args[:policies] if args.key?(:policies) end end # Metadata message that provides information such as progress, partial failures, # and similar information on each GetOperation call of LRO returned by # ImportConsumerOverrides. class ImportConsumerOverridesMetadata include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Response message for ImportConsumerOverrides class ImportConsumerOverridesResponse include Google::Apis::Core::Hashable # The overrides that were created from the imported data. # Corresponds to the JSON property `overrides` # @return [Array] attr_accessor :overrides def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @overrides = args[:overrides] if args.key?(:overrides) end end # Settings for Java client libraries. class JavaSettings include Google::Apis::Core::Hashable # Required information for every language. # Corresponds to the JSON property `common` # @return [Google::Apis::ServiceusageV1::CommonLanguageSettings] attr_accessor :common # The package name to use in Java. Clobbers the java_package option set in the # protobuf. This should be used **only** by APIs who have already set the # language_settings.java.package_name" field in gapic.yaml. API teams should use # the protobuf java_package option where possible. Example of a YAML # configuration:: publishing: java_settings: library_package: com.google.cloud. # pubsub.v1 # Corresponds to the JSON property `libraryPackage` # @return [String] attr_accessor :library_package # Configure the Java class name to use instead of the service's for its # corresponding generated GAPIC client. Keys are fully-qualified service names # as they appear in the protobuf (including the full the language_settings.java. # interface_names" field in gapic.yaml. API teams should otherwise use the # service name as it appears in the protobuf. Example of a YAML configuration:: # publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: # TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin # Corresponds to the JSON property `serviceClassNames` # @return [Hash] attr_accessor :service_class_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @library_package = args[:library_package] if args.key?(:library_package) @service_class_names = args[:service_class_names] if args.key?(:service_class_names) end end # Specifies a location to extract JWT from an API request. class JwtLocation include Google::Apis::Core::Hashable # Specifies cookie name to extract JWT token. # Corresponds to the JSON property `cookie` # @return [String] attr_accessor :cookie # Specifies HTTP header name to extract JWT token. # Corresponds to the JSON property `header` # @return [String] attr_accessor :header # Specifies URL query parameter name to extract JWT token. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query # The value prefix. The value format is "value_prefix`token`" Only applies to " # in" header type. Must be empty for "in" query type. If not empty, the header # value has to match (case sensitive) this prefix. If not matched, JWT will not # be extracted. If matched, JWT will be extracted after the prefix is removed. # For example, for "Authorization: Bearer `JWT`", value_prefix="Bearer " with a # space at the end. # Corresponds to the JSON property `valuePrefix` # @return [String] attr_accessor :value_prefix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cookie = args[:cookie] if args.key?(:cookie) @header = args[:header] if args.key?(:header) @query = args[:query] if args.key?(:query) @value_prefix = args[:value_prefix] if args.key?(:value_prefix) end end # A description of a label. class LabelDescriptor include Google::Apis::Core::Hashable # A human-readable description for the label. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The label key. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key # The type of data that can be assigned to the label. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @key = args[:key] if args.key?(:key) @value_type = args[:value_type] if args.key?(:value_type) end end # The response message for Operations.ListOperations. class ListOperationsResponse include Google::Apis::Core::Hashable # The standard List next-page token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of operations that matches the specified filter in the request. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @operations = args[:operations] if args.key?(:operations) end end # Response message for the `ListServices` method. class ListServicesResponse include Google::Apis::Core::Hashable # Token that can be passed to `ListServices` to resume a paginated query. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The available services for the requested project. # Corresponds to the JSON property `services` # @return [Array] attr_accessor :services def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @services = args[:services] if args.key?(:services) end end # A description of a log type. Example in YAML format: - name: library. # googleapis.com/activity_history description: The history of borrowing and # returning library items. display_name: Activity labels: - key: /customer_id # description: Identifier of a library customer class LogDescriptor include Google::Apis::Core::Hashable # A human-readable description of this log. This information appears in the # documentation and can contain details. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # The human-readable name for this log. This information appears on the user # interface and should be concise. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The set of labels that are available to describe a specific log entry. Runtime # requests that contain labels not specified here are considered invalid. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # The name of the log. It must be less than 512 characters long and can include # the following characters: upper- and lower-case alphanumeric characters [A-Za- # z0-9], and punctuation characters including slash, underscore, hyphen, period [ # /_-.]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) end end # Logging configuration of the service. The following example shows how to # configure logs to be sent to the producer and consumer projects. In the # example, the `activity_history` log is sent to both the producer and consumer # projects, whereas the `purchase_history` log is only sent to the producer # project. monitored_resources: - type: library.googleapis.com/branch labels: - # key: /city description: The city where the library branch is located in. - key: # /name description: The name of the branch. logs: - name: activity_history # labels: - key: /customer_id - name: purchase_history logging: # producer_destinations: - monitored_resource: library.googleapis.com/branch # logs: - activity_history - purchase_history consumer_destinations: - # monitored_resource: library.googleapis.com/branch logs: - activity_history class Logging include Google::Apis::Core::Hashable # 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. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations # 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. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) @producer_destinations = args[:producer_destinations] if args.key?(:producer_destinations) end end # Configuration of a specific logging destination (the producer project or the # consumer project). class LoggingDestination include Google::Apis::Core::Hashable # Names of the logs to be sent to this destination. Each name must be defined in # the Service.logs section. If the log name is not a domain scoped name, it will # be automatically prefixed with the service name followed by "/". # Corresponds to the JSON property `logs` # @return [Array] attr_accessor :logs # The monitored resource type. The type must be defined in the Service. # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @logs = args[:logs] if args.key?(:logs) @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) end end # Describes settings to use when generating API methods that use the long- # running operation pattern. All default values below are from those used in the # client library generators (e.g. [Java](https://github.com/googleapis/gapic- # generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/ # google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). class LongRunning include Google::Apis::Core::Hashable # Initial delay after which the first poll request will be made. Default value: # 5 seconds. # Corresponds to the JSON property `initialPollDelay` # @return [String] attr_accessor :initial_poll_delay # Maximum time between two subsequent poll requests. Default value: 45 seconds. # Corresponds to the JSON property `maxPollDelay` # @return [String] attr_accessor :max_poll_delay # Multiplier to gradually increase delay between subsequent polls until it # reaches max_poll_delay. Default value: 1.5. # Corresponds to the JSON property `pollDelayMultiplier` # @return [Float] attr_accessor :poll_delay_multiplier # Total polling timeout. Default value: 5 minutes. # Corresponds to the JSON property `totalPollTimeout` # @return [String] attr_accessor :total_poll_timeout def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @initial_poll_delay = args[:initial_poll_delay] if args.key?(:initial_poll_delay) @max_poll_delay = args[:max_poll_delay] if args.key?(:max_poll_delay) @poll_delay_multiplier = args[:poll_delay_multiplier] if args.key?(:poll_delay_multiplier) @total_poll_timeout = args[:total_poll_timeout] if args.key?(:total_poll_timeout) end end # Method represents a method of an API interface. class MethodProp include Google::Apis::Core::Hashable # The simple name of this method. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Any metadata attached to the method. # Corresponds to the JSON property `options` # @return [Array] attr_accessor :options # If true, the request is streamed. # Corresponds to the JSON property `requestStreaming` # @return [Boolean] attr_accessor :request_streaming alias_method :request_streaming?, :request_streaming # A URL of the input message type. # Corresponds to the JSON property `requestTypeUrl` # @return [String] attr_accessor :request_type_url # If true, the response is streamed. # Corresponds to the JSON property `responseStreaming` # @return [Boolean] attr_accessor :response_streaming alias_method :response_streaming?, :response_streaming # The URL of the output message type. # Corresponds to the JSON property `responseTypeUrl` # @return [String] attr_accessor :response_type_url # The source syntax of this method. # Corresponds to the JSON property `syntax` # @return [String] attr_accessor :syntax def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @options = args[:options] if args.key?(:options) @request_streaming = args[:request_streaming] if args.key?(:request_streaming) @request_type_url = args[:request_type_url] if args.key?(:request_type_url) @response_streaming = args[:response_streaming] if args.key?(:response_streaming) @response_type_url = args[:response_type_url] if args.key?(:response_type_url) @syntax = args[:syntax] if args.key?(:syntax) end end # Describes the generator configuration for a method. class MethodSettings include Google::Apis::Core::Hashable # Describes settings to use when generating API methods that use the long- # running operation pattern. All default values below are from those used in the # client library generators (e.g. [Java](https://github.com/googleapis/gapic- # generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/ # google/api/generator/gapic/composer/common/RetrySettingsComposer.java)). # Corresponds to the JSON property `longRunning` # @return [Google::Apis::ServiceusageV1::LongRunning] attr_accessor :long_running # The fully qualified name of the method, for which the options below apply. # This is used to find the method to apply the options. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @long_running = args[:long_running] if args.key?(:long_running) @selector = args[:selector] if args.key?(:selector) end end # Defines a metric type and its schema. Once a metric descriptor is created, # deleting or altering it stops data collection and makes the metric type's # existing data unusable. class MetricDescriptor include Google::Apis::Core::Hashable # A detailed description of the metric, which can be used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # A concise name for the metric, which can be displayed in user interfaces. Use # sentence case without an ending period, for example "Request count". This # field is optional but it is recommended to be set for any metrics associated # with user-visible concepts, such as Quota. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # The set of labels that can be used to describe a specific instance of this # metric type. For example, the `appengine.googleapis.com/http/server/ # response_latencies` metric type has a label for the HTTP response code, ` # response_code`, so you can look at latencies for successful responses or just # for responses that failed. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Optional. The launch stage of the metric definition. # Corresponds to the JSON property `launchStage` # @return [String] attr_accessor :launch_stage # Additional annotations that can be used to guide the usage of a metric. # Corresponds to the JSON property `metadata` # @return [Google::Apis::ServiceusageV1::MetricDescriptorMetadata] attr_accessor :metadata # Whether the metric records instantaneous values, changes to a value, etc. Some # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `metricKind` # @return [String] attr_accessor :metric_kind # Read-only. If present, then a time series, which is identified partially by a # metric type and a MonitoredResourceDescriptor, that is associated with this # metric type can only be associated with one of the monitored resource types # listed here. # Corresponds to the JSON property `monitoredResourceTypes` # @return [Array] attr_accessor :monitored_resource_types # The resource name of the metric descriptor. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The metric type, including its DNS name prefix. The type is not URL-encoded. # All user-defined metric types have the DNS name `custom.googleapis.com` or ` # external.googleapis.com`. Metric types should use a natural hierarchical # grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external. # googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/ # response_latencies" # Corresponds to the JSON property `type` # @return [String] attr_accessor :type # The units in which the metric value is reported. It is only applicable if the ` # value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the # representation of the stored metric values. Different systems might scale the # values to be more easily displayed (so a value of `0.02kBy` _might_ be # displayed as `20By`, and a value of `3523kBy` _might_ be displayed as `3.5MBy`) # . However, if the `unit` is `kBy`, then the value of the metric is always in # thousands of bytes, no matter how it might be displayed. If you want a custom # metric to record the exact number of CPU-seconds used by a job, you can create # an `INT64 CUMULATIVE` metric whose `unit` is `s`CPU`` (or equivalently `1s`CPU` # ` or just `s`). If the job uses 12,005 CPU-seconds, then the value is written # as `12005`. Alternatively, if you want a custom metric to record data in a # more granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is # `ks`CPU``, and then write the value `12.005` (which is `12005/1000`), or use ` # Kis`CPU`` and write `11.723` (which is `12005/1024`). The supported units are # a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ # ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` # second * `min` minute * `h` hour * `d` day * `1` dimensionless **Prefixes ( # PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^ # 12) * `P` peta (10^15) * `E` exa (10^18) * `Z` zetta (10^21) * `Y` yotta (10^ # 24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^- # 12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) * `y` yocto ( # 10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi ( # 2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these # connectors: * `/` division or ratio (as an infix operator). For examples, `kBy/ # `email`` or `MiBy/10ms` (although you should almost never have `/s` in a # metric `unit`; rates should always be computed at query time from the # underlying cumulative or delta value). * `.` multiplication or composition (as # an infix operator). For examples, `GBy.d` or `k`watt`.h`. The grammar for a # unit is as follows: Expression = Component ` "." Component ` ` "/" Component ` # ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; # Annotation = "`" NAME "`" ; Notes: * `Annotation` is just a comment if it # follows a `UNIT`. If the annotation is used alone, then the unit is equivalent # to `1`. For examples, ``request`/s == 1/s`, `By`transmitted`/s == By/s`. * ` # NAME` is a sequence of non-blank printable ASCII characters not containing ``` # or ```. * `1` represents a unitary [dimensionless unit](https://en.wikipedia. # org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used # when none of the basic units are appropriate. For example, "new users per day" # can be represented as `1/d` or ``new-users`/d` (and a metric value `5` would # mean "5 new users). Alternatively, "thousands of page views per day" would be # represented as `1000/d` or `k1/d` or `k`page_views`/d` (and a metric value of ` # 5.3` would mean "5300 page views per day"). * `%` represents dimensionless # value of 1/100, and annotates values giving a percentage (so the metric values # are typically in the range of 0..100, and a metric value `3` means "3 percent") # . * `10^2.%` indicates a metric contains a ratio, typically in the range 0..1, # that will be multiplied by 100 and displayed as a percentage (so a metric # value `0.03` means "3 percent"). # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Whether the measurement is an integer, a floating-point number, etc. Some # combinations of `metric_kind` and `value_type` might not be supported. # Corresponds to the JSON property `valueType` # @return [String] attr_accessor :value_type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @labels = args[:labels] if args.key?(:labels) @launch_stage = args[:launch_stage] if args.key?(:launch_stage) @metadata = args[:metadata] if args.key?(:metadata) @metric_kind = args[:metric_kind] if args.key?(:metric_kind) @monitored_resource_types = args[:monitored_resource_types] if args.key?(:monitored_resource_types) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) @unit = args[:unit] if args.key?(:unit) @value_type = args[:value_type] if args.key?(:value_type) end end # Additional annotations that can be used to guide the usage of a metric. class MetricDescriptorMetadata include Google::Apis::Core::Hashable # The delay of data points caused by ingestion. Data points older than this age # are guaranteed to be ingested and available to be read, excluding data loss # due to errors. # Corresponds to the JSON property `ingestDelay` # @return [String] attr_accessor :ingest_delay # Deprecated. Must use the MetricDescriptor.launch_stage instead. # Corresponds to the JSON property `launchStage` # @return [String] attr_accessor :launch_stage # The sampling period of metric data points. For metrics which are written # periodically, consecutive data points are stored at this time interval, # excluding data loss due to errors. Metrics with a higher granularity have a # smaller sampling period. # Corresponds to the JSON property `samplePeriod` # @return [String] attr_accessor :sample_period def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ingest_delay = args[:ingest_delay] if args.key?(:ingest_delay) @launch_stage = args[:launch_stage] if args.key?(:launch_stage) @sample_period = args[:sample_period] if args.key?(:sample_period) end end # Bind API methods to metrics. Binding a method to a metric causes that metric's # configured quota behaviors to apply to the method call. class MetricRule include Google::Apis::Core::Hashable # Metrics to update when the selected methods are called, and the associated # cost applied to each metric. The key of the map is the metric name, and the # values are the amount increased for the metric against which the quota limits # are defined. The value must not be negative. # Corresponds to the JSON property `metricCosts` # @return [Hash] attr_accessor :metric_costs # Selects the methods to which this rule applies. Refer to selector for syntax # details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @metric_costs = args[:metric_costs] if args.key?(:metric_costs) @selector = args[:selector] if args.key?(:selector) end end # Declares an API Interface to be included in this interface. The including # interface must redeclare all the methods from the included interface, but # documentation and options are inherited as follows: - If after comment and # whitespace stripping, the documentation string of the redeclared method is # empty, it will be inherited from the original method. - Each annotation # belonging to the service config (http, visibility) which is not set in the # redeclared method will be inherited. - If an http annotation is inherited, the # path pattern will be modified as follows. Any version prefix will be replaced # by the version of the including interface plus the root path if specified. # Example of a simple mixin: package google.acl.v1; service AccessControl ` // # Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) ` # option (google.api.http).get = "/v1/`resource=**`:getAcl"; ` ` package google. # storage.v2; service Storage ` // rpc GetAcl(GetAclRequest) returns (Acl); // # Get a data record. rpc GetData(GetDataRequest) returns (Data) ` option (google. # api.http).get = "/v2/`resource=**`"; ` ` Example of a mixin configuration: # apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1. # AccessControl The mixin construct implies that all methods in `AccessControl` # are also declared with same name and request/response types in `Storage`. A # documentation generator or annotation processor will see the effective ` # Storage.GetAcl` method after inheriting documentation and annotations as # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` # to `v2`. If the `root` field in the mixin is specified, it should be a # relative path under which inherited HTTP paths are placed. Example: apis: - # name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl # root: acls This implies the following inherited HTTP annotation: service # Storage ` // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns ( # Acl) ` option (google.api.http).get = "/v2/acls/`resource=**`:getAcl"; ` ... ` class Mixin include Google::Apis::Core::Hashable # The fully qualified name of the interface which is included. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # If non-empty specifies a path under which inherited HTTP paths are rooted. # Corresponds to the JSON property `root` # @return [String] attr_accessor :root def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @root = args[:root] if args.key?(:root) end end # An object that describes the schema of a MonitoredResource object using a type # name and a set of labels. For example, the monitored resource descriptor for # Google Compute Engine VM instances has a type of `"gce_instance"` and # specifies the use of the labels `"instance_id"` and `"zone"` to identify # particular VM instances. Different APIs can support different monitored # resource types. APIs generally provide a `list` method that returns the # monitored resource descriptors used by the API. class MonitoredResourceDescriptor include Google::Apis::Core::Hashable # Optional. A detailed description of the monitored resource type that might be # used in documentation. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # Optional. A concise name for the monitored resource type that might be # displayed in user interfaces. It should be a Title Cased Noun Phrase, without # any article or other determiners. For example, `"Google Cloud SQL Database"`. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # 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"`. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels # Optional. The launch stage of the monitored resource definition. # Corresponds to the JSON property `launchStage` # @return [String] attr_accessor :launch_stage # 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`"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Required. The monitored resource type. For example, the type `" # cloudsql_database"` represents databases in Google Cloud SQL. For a list of # types, see [Monitoring resource types](https://cloud.google.com/monitoring/api/ # resources) and [Logging resource types](https://cloud.google.com/logging/docs/ # api/v2/resource-list). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @labels = args[:labels] if args.key?(:labels) @launch_stage = args[:launch_stage] if args.key?(:launch_stage) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) end end # Monitoring configuration of the service. The example below shows how to # configure monitored resources and metrics for monitoring. In the example, a # monitored resource and two metrics are defined. The `library.googleapis.com/ # book/returned_count` metric is sent to both producer and consumer projects, # whereas the `library.googleapis.com/book/num_overdue` metric is only sent to # the consumer project. monitored_resources: - type: library.googleapis.com/ # Branch display_name: "Library Branch" description: "A branch of a library." # launch_stage: GA labels: - key: resource_container description: "The Cloud # container (ie. project id) for the Branch." - key: location description: "The # location of the library branch." - key: branch_id description: "The id of the # branch." metrics: - name: library.googleapis.com/book/returned_count # display_name: "Books Returned" description: "The count of books that have been # returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" # labels: - key: customer_id description: "The id of the customer." - name: # library.googleapis.com/book/num_overdue display_name: "Books Overdue" # description: "The current number of overdue books." launch_stage: GA # metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id # description: "The id of the customer." monitoring: producer_destinations: - # monitored_resource: library.googleapis.com/Branch metrics: - library. # googleapis.com/book/returned_count consumer_destinations: - monitored_resource: # library.googleapis.com/Branch metrics: - library.googleapis.com/book/ # returned_count - library.googleapis.com/book/num_overdue class Monitoring include Google::Apis::Core::Hashable # Monitoring configurations for sending metrics to the consumer project. There # can be multiple consumer destinations. A monitored resource type may appear in # multiple monitoring destinations if different aggregations are needed for # different sets of metrics associated with that monitored resource type. A # monitored resource and metric pair may only be used once in the Monitoring # configuration. # Corresponds to the JSON property `consumerDestinations` # @return [Array] attr_accessor :consumer_destinations # Monitoring configurations for sending metrics to the producer project. There # can be multiple producer destinations. A monitored resource type may appear in # multiple monitoring destinations if different aggregations are needed for # different sets of metrics associated with that monitored resource type. A # monitored resource and metric pair may only be used once in the Monitoring # configuration. # Corresponds to the JSON property `producerDestinations` # @return [Array] attr_accessor :producer_destinations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @consumer_destinations = args[:consumer_destinations] if args.key?(:consumer_destinations) @producer_destinations = args[:producer_destinations] if args.key?(:producer_destinations) end end # Configuration of a specific monitoring destination (the producer project or # the consumer project). class MonitoringDestination include Google::Apis::Core::Hashable # Types of the metrics to report to this monitoring destination. Each type must # be defined in Service.metrics section. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics # The monitored resource type. The type must be defined in Service. # monitored_resources section. # Corresponds to the JSON property `monitoredResource` # @return [String] attr_accessor :monitored_resource def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @metrics = args[:metrics] if args.key?(:metrics) @monitored_resource = args[:monitored_resource] if args.key?(:monitored_resource) end end # Settings for Node client libraries. class NodeSettings include Google::Apis::Core::Hashable # Required information for every language. # Corresponds to the JSON property `common` # @return [Google::Apis::ServiceusageV1::CommonLanguageSettings] attr_accessor :common def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) end end # OAuth scopes are a way to define data and permissions on data. For example, # there are scopes defined for "Read-only access to Google Calendar" and "Access # to Cloud Platform". Users can consent to a scope for an application, giving it # permission to access that data on their behalf. OAuth scope specifications # should be fairly coarse grained; a user will need to see and understand the # text description of what your scope means. In most cases: use one or at most # two OAuth scopes for an entire family of products. If your product has # multiple APIs, you should probably be sharing the OAuth scope across all of # those APIs. When you need finer grained OAuth consent screens: talk with your # product management about how developers will use them in practice. Please note # that even though each of the canonical scopes is enough for a request to be # accepted and passed to the backend, a request can still fail due to the # backend requiring additional scopes or permissions. class OAuthRequirements include Google::Apis::Core::Hashable # 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 # Corresponds to the JSON property `canonicalScopes` # @return [String] attr_accessor :canonical_scopes def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @canonical_scopes = args[:canonical_scopes] if args.key?(:canonical_scopes) end end # This resource represents a long-running operation that is the result of a # network API call. class Operation include Google::Apis::Core::Hashable # 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. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by [ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of # data: error code, error message, and error details. You can find out more # about this error model and how to work with it in the [API Design Guide](https: # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::ServiceusageV1::Status] attr_accessor :error # Service-specific metadata associated with the operation. It typically contains # progress information and common metadata such as create time. Some services # might not provide such metadata. Any method that returns a long-running # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the `name` should # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The normal response of the operation in case of success. If the original # method returns no data on success, such as `Delete`, the response is `google. # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, # the response should be the resource. For other methods, the response should # have the type `XxxResponse`, where `Xxx` is the original method name. For # example, if the original method name is `TakeSnapshot()`, the inferred # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @done = args[:done] if args.key?(:done) @error = args[:error] if args.key?(:error) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @response = args[:response] if args.key?(:response) end end # The operation metadata returned for the batchend services operation. class OperationMetadata include Google::Apis::Core::Hashable # The full name of the resources that this operation is directly associated with. # Corresponds to the JSON property `resourceNames` # @return [Array] attr_accessor :resource_names def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @resource_names = args[:resource_names] if args.key?(:resource_names) end end # A protocol buffer option, which can be attached to a message, field, # enumeration, etc. class Option include Google::Apis::Core::Hashable # The option's name. For protobuf built-in options (options defined in # descriptor.proto), this is the short name. For example, `"map_entry"`. For # custom options, it should be the fully-qualified name. For example, `"google. # api.http"`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The option's value packed in an Any message. If the value is a primitive, the # corresponding wrapper type defined in google/protobuf/wrappers.proto should be # used. If the value is an enum, it should be stored as an int32 value using the # google.protobuf.Int32Value type. # Corresponds to the JSON property `value` # @return [Hash] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) @value = args[:value] if args.key?(:value) end end # Represents a documentation page. A page can contain subpages to represent # nested documentation set structure. class Page include Google::Apis::Core::Hashable # The Markdown content of the page. You can use (== include `path` ==) to # include content from a Markdown file. The content can be used to produce the # documentation page such as HTML format page. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content # The name of the page. It will be used as an identity of the page to generate # URI of the page, text of the link to this page in navigation, etc. The full # page name (start from the root page name to this page concatenated with `.`) # can be used as reference to the page in your documentation. For example: pages: # - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java # content: (== include tutorial_java.md ==) You can reference `Java` page using # Markdown reference link syntax: `Java`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Subpages of this page. The order of subpages specified here will be honored in # the generated docset. # Corresponds to the JSON property `subpages` # @return [Array] attr_accessor :subpages def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @content = args[:content] if args.key?(:content) @name = args[:name] if args.key?(:name) @subpages = args[:subpages] if args.key?(:subpages) end end # Settings for Php client libraries. class PhpSettings include Google::Apis::Core::Hashable # Required information for every language. # Corresponds to the JSON property `common` # @return [Google::Apis::ServiceusageV1::CommonLanguageSettings] attr_accessor :common def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) end end # This message configures the settings for publishing [Google Cloud Client # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) # generated from the service config. class Publishing include Google::Apis::Core::Hashable # Used as a tracking tag when collecting data about the APIs developer relations # artifacts like docs, packages delivered to package managers, etc. Example: " # speech". # Corresponds to the JSON property `apiShortName` # @return [String] attr_accessor :api_short_name # GitHub teams to be added to CODEOWNERS in the directory in GitHub containing # source code for the client libraries for this API. # Corresponds to the JSON property `codeownerGithubTeams` # @return [Array] attr_accessor :codeowner_github_teams # A prefix used in sample code when demarking regions to be included in # documentation. # Corresponds to the JSON property `docTagPrefix` # @return [String] attr_accessor :doc_tag_prefix # Link to product home page. Example: https://cloud.google.com/asset-inventory/ # docs/overview # Corresponds to the JSON property `documentationUri` # @return [String] attr_accessor :documentation_uri # GitHub label to apply to issues and pull requests opened for this API. # Corresponds to the JSON property `githubLabel` # @return [String] attr_accessor :github_label # Client library settings. If the same version string appears multiple times in # this list, then the last one wins. Settings from earlier settings with the # same version string are discarded. # Corresponds to the JSON property `librarySettings` # @return [Array] attr_accessor :library_settings # A list of API method settings, e.g. the behavior for methods that use the long- # running operation pattern. # Corresponds to the JSON property `methodSettings` # @return [Array] attr_accessor :method_settings # Link to a place that API users can report issues. Example: https:// # issuetracker.google.com/issues/new?component=190865&template=1161103 # Corresponds to the JSON property `newIssueUri` # @return [String] attr_accessor :new_issue_uri # For whom the client library is being published. # Corresponds to the JSON property `organization` # @return [String] attr_accessor :organization def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @api_short_name = args[:api_short_name] if args.key?(:api_short_name) @codeowner_github_teams = args[:codeowner_github_teams] if args.key?(:codeowner_github_teams) @doc_tag_prefix = args[:doc_tag_prefix] if args.key?(:doc_tag_prefix) @documentation_uri = args[:documentation_uri] if args.key?(:documentation_uri) @github_label = args[:github_label] if args.key?(:github_label) @library_settings = args[:library_settings] if args.key?(:library_settings) @method_settings = args[:method_settings] if args.key?(:method_settings) @new_issue_uri = args[:new_issue_uri] if args.key?(:new_issue_uri) @organization = args[:organization] if args.key?(:organization) end end # Settings for Python client libraries. class PythonSettings include Google::Apis::Core::Hashable # Required information for every language. # Corresponds to the JSON property `common` # @return [Google::Apis::ServiceusageV1::CommonLanguageSettings] attr_accessor :common def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) end end # Quota configuration helps to achieve fairness and budgeting in service usage. # The metric based quota configuration works this way: - The service # configuration defines a set of metrics. - For API calls, the quota. # metric_rules maps methods to metrics with corresponding costs. - The quota. # limits defines limits on the metrics, which will be used for quota checks at # runtime. An example quota configuration in yaml format: quota: limits: - name: # apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/` # project`" # rate limit for consumer projects values: STANDARD: 10000 (The # metric rules bind all methods to the read_calls metric, except for the # UpdateBook and DeleteBook methods. These two methods are mapped to the # write_calls metric, with the UpdateBook method consuming at twice rate as the # DeleteBook method.) metric_rules: - selector: "*" metric_costs: library. # googleapis.com/read_calls: 1 - selector: google.example.library.v1. # LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - # selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: # library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: # - name: library.googleapis.com/read_calls display_name: Read requests # metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/ # write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 class Quota include Google::Apis::Core::Hashable # List of QuotaLimit definitions for the service. # Corresponds to the JSON property `limits` # @return [Array] attr_accessor :limits # List of MetricRule definitions, each one mapping a selected method to one or # more metrics. # Corresponds to the JSON property `metricRules` # @return [Array] attr_accessor :metric_rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @limits = args[:limits] if args.key?(:limits) @metric_rules = args[:metric_rules] if args.key?(:metric_rules) end end # `QuotaLimit` defines a specific limit that applies over a specified duration # for a limit type. There can be at most one limit for a duration and limit type # combination defined within a `QuotaGroup`. class QuotaLimit include Google::Apis::Core::Hashable # Default number of tokens that can be consumed during the specified duration. # This is the number of tokens assigned when a client application developer # activates the service for his/her project. Specifying a value of 0 will block # all requests. This can be used if you are provisioning quota to selected # consumers and blocking others. Similarly, a value of -1 will indicate an # unlimited quota. No other negative values are allowed. Used by group-based # quotas only. # Corresponds to the JSON property `defaultLimit` # @return [Fixnum] attr_accessor :default_limit # 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`). # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # User-visible display name for this limit. Optional. If not set, the UI will # provide a default display name based on the quota configuration. This field # can be used to override the default display name generated from the # configuration. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # Duration of this limit in textual notation. Must be "100s" or "1d". Used by # group-based quotas only. # Corresponds to the JSON property `duration` # @return [String] attr_accessor :duration # Free tier value displayed in the Developers Console for this limit. The free # tier is the number of tokens that will be subtracted from the billed amount # when billing is enabled. This field can only be set on a limit with duration " # 1d", in a billable group; it is invalid on any other limit. If this field is # not set, it defaults to 0, indicating that there is no free tier for this # service. Used by group-based quotas only. # Corresponds to the JSON property `freeTier` # @return [Fixnum] attr_accessor :free_tier # Maximum number of tokens that can be consumed during the specified duration. # Client application developers can override the default limit up to this # maximum. If specified, this value cannot be set to a value less than the # default limit. If not specified, it is set to the default limit. To allow # clients to apply overrides with no upper bound, set this to -1, indicating # unlimited maximum quota. Used by group-based quotas only. # Corresponds to the JSON property `maxLimit` # @return [Fixnum] attr_accessor :max_limit # The name of the metric this quota limit applies to. The quota limits with the # same metric will be checked together during runtime. The metric must be # defined within the service config. # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric # Name of the quota limit. The name must be provided, and it must be unique # within the service. The name can only include alphanumeric characters as well # as '-'. The maximum length of the limit name is 64 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Specify the unit of the quota limit. It uses the same syntax as Metric.unit. # The supported unit kinds are determined by the quota backend system. Here are # some examples: * "1/min/`project`" for quota per minute per project. Note: the # order of unit components is insignificant. The "1" at the beginning is # required to follow the metric unit syntax. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit # Tiered limit values. You must specify this as a key:value pair, with an # integer value that is the maximum number of requests allowed for the specified # unit. Currently only STANDARD is supported. # Corresponds to the JSON property `values` # @return [Hash] attr_accessor :values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @default_limit = args[:default_limit] if args.key?(:default_limit) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @duration = args[:duration] if args.key?(:duration) @free_tier = args[:free_tier] if args.key?(:free_tier) @max_limit = args[:max_limit] if args.key?(:max_limit) @metric = args[:metric] if args.key?(:metric) @name = args[:name] if args.key?(:name) @unit = args[:unit] if args.key?(:unit) @values = args[:values] if args.key?(:values) end end # A quota override class QuotaOverride include Google::Apis::Core::Hashable # The resource name of the ancestor that requested the override. For example: ` # organizations/12345` or `folders/67890`. Used by admin overrides only. # Corresponds to the JSON property `adminOverrideAncestor` # @return [String] attr_accessor :admin_override_ancestor # If this map is nonempty, then this override applies only to specific values # for dimensions defined in the limit unit. For example, an override on a limit # with the unit `1/`project`/`region`` could contain an entry with the key ` # region` and the value `us-east-1`; the override is only applied to quota # consumed in that region. This map has the following restrictions: * Keys that # are not defined in the limit's unit are not valid keys. Any string appearing # in ``brackets`` in the unit (besides ``project`` or ``user``) is a defined key. # * `project` is not a valid key; the project is already specified in the # parent resource name. * `user` is not a valid key; the API does not support # quota overrides that apply only to a specific user. * If `region` appears as a # key, its value must be a valid Cloud region. * If `zone` appears as a key, its # value must be a valid Cloud zone. * If any valid key other than `region` or ` # zone` appears in the map, then all valid keys other than `region` or `zone` # must also appear in the map. # Corresponds to the JSON property `dimensions` # @return [Hash] attr_accessor :dimensions # The name of the metric to which this override applies. An example name would # be: `compute.googleapis.com/cpus` # Corresponds to the JSON property `metric` # @return [String] attr_accessor :metric # The resource name of the override. This name is generated by the server when # the override is created. Example names would be: `projects/123/services/ # compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/ # limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `projects/123/services/ # compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/ # limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` The resource name is # intended to be opaque and should not be parsed for its component strings, # since its representation could change in the future. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The overriding quota limit value. Can be any nonnegative integer, or -1 ( # unlimited quota). # Corresponds to the JSON property `overrideValue` # @return [Fixnum] attr_accessor :override_value # The limit unit of the limit to which this override applies. An example unit # would be: `1/`project`/`region`` Note that ``project`` and ``region`` are not # placeholders in this example; the literal characters ``` and ``` occur in the # string. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @admin_override_ancestor = args[:admin_override_ancestor] if args.key?(:admin_override_ancestor) @dimensions = args[:dimensions] if args.key?(:dimensions) @metric = args[:metric] if args.key?(:metric) @name = args[:name] if args.key?(:name) @override_value = args[:override_value] if args.key?(:override_value) @unit = args[:unit] if args.key?(:unit) end end # Settings for Ruby client libraries. class RubySettings include Google::Apis::Core::Hashable # Required information for every language. # Corresponds to the JSON property `common` # @return [Google::Apis::ServiceusageV1::CommonLanguageSettings] attr_accessor :common def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) end end # Service identity for a service. This is the identity that service producer # should use to access consumer resources. class ServiceIdentity include Google::Apis::Core::Hashable # The email address of the service account that a service producer would use to # access consumer resources. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email # The unique and stable id of the service account. https://cloud.google.com/iam/ # reference/rest/v1/projects.serviceAccounts#ServiceAccount # Corresponds to the JSON property `uniqueId` # @return [String] attr_accessor :unique_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @email = args[:email] if args.key?(:email) @unique_id = args[:unique_id] if args.key?(:unique_id) end end # `SourceContext` represents information about the source of a protobuf element, # like the file in which it is defined. class SourceContext include Google::Apis::Core::Hashable # The path-qualified name of the .proto file that contained the associated # protobuf element. For example: `"google/protobuf/source_context.proto"`. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @file_name = args[:file_name] if args.key?(:file_name) end end # Source information used to create a Service Config class SourceInfo include Google::Apis::Core::Hashable # All files used during config generation. # Corresponds to the JSON property `sourceFiles` # @return [Array>] attr_accessor :source_files def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @source_files = args[:source_files] if args.key?(:source_files) end end # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by [ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of # data: error code, error message, and error details. You can find out more # about this error model and how to work with it in the [API Design Guide](https: # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable # The status code, which should be an enum value of google.rpc.Code. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details # A developer-facing error message, which should be in English. Any user-facing # error message should be localized and sent in the google.rpc.Status.details # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @details = args[:details] if args.key?(:details) @message = args[:message] if args.key?(:message) end end # Define a parameter's name and location. The parameter may be passed as either # an HTTP header or a URL query parameter, and if both are passed the behavior # is implementation-dependent. class SystemParameter include Google::Apis::Core::Hashable # Define the HTTP header name to use for the parameter. It is case insensitive. # Corresponds to the JSON property `httpHeader` # @return [String] attr_accessor :http_header # Define the name of the parameter, such as "api_key" . It is case sensitive. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Define the URL query parameter name to use for the parameter. It is case # sensitive. # Corresponds to the JSON property `urlQueryParameter` # @return [String] attr_accessor :url_query_parameter def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @http_header = args[:http_header] if args.key?(:http_header) @name = args[:name] if args.key?(:name) @url_query_parameter = args[:url_query_parameter] if args.key?(:url_query_parameter) end end # Define a system parameter rule mapping system parameter definitions to methods. class SystemParameterRule include Google::Apis::Core::Hashable # 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. # Corresponds to the JSON property `parameters` # @return [Array] attr_accessor :parameters # Selects the methods to which this rule applies. Use '*' to indicate all # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @parameters = args[:parameters] if args.key?(:parameters) @selector = args[:selector] if args.key?(:selector) end end # ### System parameter configuration A system parameter is a special kind of # parameter defined by the API system, not by an individual API. It is typically # mapped to an HTTP header and/or a URL query parameter. This configuration # specifies which methods change the names of the system parameters. class SystemParameters include Google::Apis::Core::Hashable # Define system parameters. The parameters defined here will override the # default parameters implemented by the system. If this field is missing from # the service config, default system parameters will be used. Default system # parameters and names is implementation-dependent. Example: define api key for # all methods system_parameters rules: - selector: "*" parameters: - name: # api_key url_query_parameter: api_key Example: define 2 api key names for a # specific method. system_parameters rules: - selector: "/ListShelves" # parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: # Api-Key2 **NOTE:** All service configuration rules follow "last one wins" # order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @rules = args[:rules] if args.key?(:rules) end end # A protocol buffer message type. class Type include Google::Apis::Core::Hashable # The list of fields. # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields # The fully qualified message name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The list of types appearing in `oneof` definitions in this type. # Corresponds to the JSON property `oneofs` # @return [Array] attr_accessor :oneofs # The protocol buffer options. # Corresponds to the JSON property `options` # @return [Array] attr_accessor :options # `SourceContext` represents information about the source of a protobuf element, # like the file in which it is defined. # Corresponds to the JSON property `sourceContext` # @return [Google::Apis::ServiceusageV1::SourceContext] attr_accessor :source_context # The source syntax. # Corresponds to the JSON property `syntax` # @return [String] attr_accessor :syntax def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @fields = args[:fields] if args.key?(:fields) @name = args[:name] if args.key?(:name) @oneofs = args[:oneofs] if args.key?(:oneofs) @options = args[:options] if args.key?(:options) @source_context = args[:source_context] if args.key?(:source_context) @syntax = args[:syntax] if args.key?(:syntax) end end # Metadata message that provides information such as progress, partial failures, # and similar information on each GetOperation call of LRO returned by # UpdateAdminQuotaPolicy. class UpdateAdminQuotaPolicyMetadata include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # Configuration controlling usage of a service. class Usage include Google::Apis::Core::Hashable # The full resource name of a channel used for sending notifications to the # service producer. Google Service Management currently only supports [Google # Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To # use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/ # Sub topic that uses the Cloud Pub/Sub topic name format documented in https:// # cloud.google.com/pubsub/docs/overview. # Corresponds to the JSON property `producerNotificationChannel` # @return [String] attr_accessor :producer_notification_channel # Requirements that must be satisfied before a consumer project can use the # service. Each requirement is of the form /; for example 'serviceusage. # googleapis.com/billing-enabled'. For Google APIs, a Terms of Service # requirement must be included here. Google Cloud APIs must include " # serviceusage.googleapis.com/tos/cloud". Other Google APIs should include " # serviceusage.googleapis.com/tos/universal". Additional ToS can be included # based on the business needs. # Corresponds to the JSON property `requirements` # @return [Array] attr_accessor :requirements # A list of usage rules that apply to individual API methods. **NOTE:** All # service configuration rules follow "last one wins" order. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @producer_notification_channel = args[:producer_notification_channel] if args.key?(:producer_notification_channel) @requirements = args[:requirements] if args.key?(:requirements) @rules = args[:rules] if args.key?(:rules) end end # Usage configuration rules for the service. NOTE: Under development. Use this # rule to configure unregistered calls for the service. Unregistered calls are # calls that do not contain consumer project identity. (Example: calls that do # not contain an API key). By default, API methods do not allow unregistered # calls, and each method call must be identified by a consumer project identity. # Use this rule to allow/disallow unregistered calls. Example of an API that # wants to allow unregistered calls for entire service. usage: rules: - selector: # "*" allow_unregistered_calls: true Example of a method that wants to allow # unregistered calls. usage: rules: - selector: "google.example.library.v1. # LibraryService.CreateBook" allow_unregistered_calls: true class UsageRule include Google::Apis::Core::Hashable # If true, the selected method allows unregistered calls, e.g. calls that don't # identify any user or application. # Corresponds to the JSON property `allowUnregisteredCalls` # @return [Boolean] attr_accessor :allow_unregistered_calls alias_method :allow_unregistered_calls?, :allow_unregistered_calls # Selects the methods to which this rule applies. Use '*' to indicate all # methods in all APIs. Refer to selector for syntax details. # Corresponds to the JSON property `selector` # @return [String] attr_accessor :selector # If true, the selected method should skip service control and the control plane # features, such as quota and billing, will not be available. This flag is used # by Google Cloud Endpoints to bypass checks for internal methods, such as # service health check methods. # Corresponds to the JSON property `skipServiceControl` # @return [Boolean] attr_accessor :skip_service_control alias_method :skip_service_control?, :skip_service_control def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_unregistered_calls = args[:allow_unregistered_calls] if args.key?(:allow_unregistered_calls) @selector = args[:selector] if args.key?(:selector) @skip_service_control = args[:skip_service_control] if args.key?(:skip_service_control) end end end end end google-apis-serviceusage-v1-0.28.0/lib/google/apis/serviceusage_v1.rb0000644000175000017500000000340314410110425024070 0ustar raviravi# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'google/apis/serviceusage_v1/service.rb' require 'google/apis/serviceusage_v1/classes.rb' require 'google/apis/serviceusage_v1/representations.rb' require 'google/apis/serviceusage_v1/gem_version.rb' module Google module Apis # Service Usage API # # Enables services that service consumers want to use on Google Cloud Platform, # lists the available or enabled services, or disables services that service # consumers no longer use. # # @see https://cloud.google.com/service-usage/ module ServiceusageV1 # Version of the Service Usage API this client connects to. # This is NOT the gem version. VERSION = 'V1' # See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account. AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' # View your data across Google Cloud services and see the email address of your Google Account AUTH_CLOUD_PLATFORM_READ_ONLY = 'https://www.googleapis.com/auth/cloud-platform.read-only' # Manage your Google API service configuration AUTH_SERVICE_MANAGEMENT = 'https://www.googleapis.com/auth/service.management' end end end google-apis-serviceusage-v1-0.28.0/lib/google-apis-serviceusage_v1.rb0000644000175000017500000000114614410110425024066 0ustar raviravi# Copyright 2020 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require "google/apis/serviceusage_v1" google-apis-serviceusage-v1-0.28.0/OVERVIEW.md0000644000175000017500000001374614410110425017275 0ustar raviravi# Simple REST client for version V1 of the Service Usage API This is a simple client library for version V1 of the Service Usage API. It provides: * A client object that connects to the HTTP/JSON REST endpoint for the service. * Ruby objects for data structures related to the service. * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts. * Control of retry, pagination, and timeouts. Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information. ## Getting started ### Before you begin There are a few setup steps you need to complete before you can use this library: 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts). 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/). 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/serviceusage.googleapis.com) in the console. ### Installation Add this line to your application's Gemfile: ```ruby gem 'google-apis-serviceusage_v1', '~> 0.1' ``` And then execute: ``` $ bundle ``` Or install it yourself as: ``` $ gem install google-apis-serviceusage_v1 ``` ### Creating a client object Once the gem is installed, you can load the client code and instantiate a client. ```ruby # Load the client require "google/apis/serviceusage_v1" # Create a client object client = Google::Apis::ServiceusageV1::ServiceUsageService.new # Authenticate calls client.authorization = # ... use the googleauth gem to create credentials ``` See the class reference docs for information on the methods you can call from a client. ## Documentation More detailed descriptions of the Google simple REST clients are available in two documents. * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging. * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/main/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables. (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Serviceusage service in particular.) For reference information on specific calls in the Service Usage API, see the {Google::Apis::ServiceusageV1::ServiceUsageService class reference docs}. ## Which client should I use? Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**. This library, `google-apis-serviceusage_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-_`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward. Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients. Gem names for modern clients are often of the form `google-cloud-`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud--`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended. **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure. The [product documentation](https://cloud.google.com/service-usage/) may provide guidance regarding the preferred client library to use. ## Supported Ruby versions This library is supported on Ruby 2.5+. Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule. ## License This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}. ## Support Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com). google-apis-serviceusage-v1-0.28.0/LICENSE.md0000644000175000017500000002636114410110425017106 0ustar raviravi Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. google-apis-serviceusage-v1-0.28.0/CHANGELOG.md0000644000175000017500000000466014410110425017311 0ustar raviravi# Release history for google-apis-serviceusage_v1 ### v0.28.0 (2022-11-18) * Regenerated from discovery document revision 20221115 ### v0.27.0 (2022-10-28) * Regenerated using generator version 0.11.0 ### v0.26.0 (2022-09-20) * Regenerated using generator version 0.10.0 ### v0.25.0 (2022-09-10) * Regenerated from discovery document revision 20220907 ### v0.24.0 (2022-08-25) * Regenerated from discovery document revision 20220823 ### v0.23.0 (2022-08-18) * Regenerated from discovery document revision 20220816 * Regenerated using generator version 0.9.0 ### v0.22.0 (2022-06-30) * Regenerated using generator version 0.8.0 ### v0.21.0 (2022-06-19) * Regenerated from discovery document revision 20220615 * Regenerated using generator version 0.7.0 ### v0.20.0 (2022-06-04) * Regenerated using generator version 0.5.0 ### v0.19.0 (2022-05-17) * Regenerated from discovery document revision 20220513 ### v0.18.0 (2022-04-07) * Regenerated from discovery document revision 20220405 ### v0.17.0 (2022-03-22) * Regenerated from discovery document revision 20220319 * Regenerated using generator version 0.4.1 ### v0.16.0 (2021-12-17) * Regenerated from discovery document revision 20211214 * Unspecified changes ### v0.15.0 (2021-10-20) * Unspecified changes ### v0.14.0 (2021-09-01) * Regenerated from discovery document revision 20210806 ### v0.13.0 (2021-08-05) * Regenerated from discovery document revision 20210803 ### v0.12.0 (2021-07-09) * Regenerated from discovery document revision 20210707 ### v0.11.0 (2021-06-29) * Regenerated using generator version 0.4.0 ### v0.10.0 (2021-06-24) * Regenerated using generator version 0.3.0 ### v0.9.0 (2021-05-27) * Regenerated from discovery document revision 20210525 ### v0.8.0 (2021-05-20) * Unspecified changes ### v0.7.0 (2021-05-08) * Regenerated from discovery document revision 20210501 ### v0.6.0 (2021-03-30) * Regenerated from discovery document revision 20210326 ### v0.5.0 (2021-03-23) * Regenerated from discovery document revision 20210319 * Regenerated using generator version 0.2.0 ### v0.4.0 (2021-03-04) * Unspecified changes ### v0.3.0 (2021-02-19) * Regenerated from discovery document revision 20210217 ### v0.2.0 (2021-01-26) * Regenerated from discovery document revision 20210124 * Regenerated using generator version 0.1.2 ### v0.1.0 (2021-01-07) * Regenerated using generator version 0.1.1 * Regenerated from discovery document revision 20201208 google-apis-serviceusage-v1-0.28.0/.yardopts0000644000175000017500000000037514410110425017345 0ustar raviravi--hide-void-return --no-private --verbose --title=google-apis-serviceusage_v1 --markup-provider=redcarpet --markup=markdown --main OVERVIEW.md lib/google/apis/serviceusage_v1/*.rb lib/google/apis/serviceusage_v1.rb - OVERVIEW.md CHANGELOG.md LICENSE.md