pulumi-google-native-kotlin/com.pulumi.googlenative.servicemanagement.v1.kotlin.outputs

Package-level declarations

Types

data class ApiResponse(val methods: List<MethodResponse>, val mixins: List<MixinResponse>, val name: String, val options: List<OptionResponse>, val sourceContext: SourceContextResponse, val syntax: String, val version: String)

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.

AuditConfigResponse

data class AuditConfigResponse(val auditLogConfigs: List<AuditLogConfigResponse>, val service: String)

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

AuditLogConfigResponse

data class AuditLogConfigResponse(val exemptedMembers: List<String>, val logType: String)

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

AuthenticationResponse

data class AuthenticationResponse(val providers: List<AuthProviderResponse>, val rules: List<AuthenticationRuleResponse>)

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

AuthenticationRuleResponse

data class AuthenticationRuleResponse(val allowWithoutCredential: Boolean, val oauth: OAuthRequirementsResponse, val requirements: List<AuthRequirementResponse>, val selector: String)

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.

AuthProviderResponse

data class AuthProviderResponse(val audiences: String, val authorizationUrl: String, val issuer: String, val jwksUri: String, val jwtLocations: List<JwtLocationResponse>)

Configuration for an authentication provider, including support for JSON Web Token (JWT).

AuthRequirementResponse

data class AuthRequirementResponse(val audiences: String, val providerId: String)

User-defined authentication requirements, including support for JSON Web Token (JWT).

BackendResponse

data class BackendResponse(val rules: List<BackendRuleResponse>)

Backend defines the backend configuration for a service.

BackendRuleResponse

data class BackendRuleResponse(val address: String, val deadline: Double, val disableAuth: Boolean, val jwtAudience: String, val minDeadline: Double, val operationDeadline: Double, val overridesByRequestProtocol: Map<String, String>, val pathTranslation: String, val protocol: String, val selector: String)

A backend rule provides configuration for an individual API element.

BillingDestinationResponse

data class BillingDestinationResponse(val metrics: List<String>, val monitoredResource: String)

Configuration of a specific billing destination (Currently only support bill against consumer project).

BillingResponse

data class BillingResponse(val consumerDestinations: List<BillingDestinationResponse>)

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

BindingResponse

data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

ClientLibrarySettingsResponse

data class ClientLibrarySettingsResponse(val cppSettings: CppSettingsResponse, val dotnetSettings: DotnetSettingsResponse, val goSettings: GoSettingsResponse, val javaSettings: JavaSettingsResponse, val launchStage: String, val nodeSettings: NodeSettingsResponse, val phpSettings: PhpSettingsResponse, val pythonSettings: PythonSettingsResponse, val restNumericEnums: Boolean, val rubySettings: RubySettingsResponse, val version: String)

Details about how and where to publish client libraries.

CommonLanguageSettingsResponse

data class CommonLanguageSettingsResponse(val destinations: List<String>, val referenceDocsUri: String)

Required information for every language.

ContextResponse

data class ContextResponse(val rules: List<ContextRuleResponse>)

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.

ContextRuleResponse

data class ContextRuleResponse(val allowedRequestExtensions: List<String>, val allowedResponseExtensions: List<String>, val provided: List<String>, val requested: List<String>, val selector: String)

A context rule provides information about the context for an individual API element.

ControlResponse

data class ControlResponse(val environment: String)

Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com

CppSettingsResponse

data class CppSettingsResponse(val common: CommonLanguageSettingsResponse)

Settings for C++ client libraries.

CustomErrorResponse

data class CustomErrorResponse(val rules: List<CustomErrorRuleResponse>, val types: List<String>)

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

CustomErrorRuleResponse

data class CustomErrorRuleResponse(val isErrorType: Boolean, val selector: String)

A custom error rule.

CustomHttpPatternResponse

data class CustomHttpPatternResponse(val kind: String, val path: String)

A custom pattern is used for defining custom HTTP verb.

DeleteServiceStrategyResponse

class DeleteServiceStrategyResponse

Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.

DocumentationResponse

data class DocumentationResponse(val documentationRootUrl: String, val overview: String, val pages: List<PageResponse>, val rules: List<DocumentationRuleResponse>, val serviceRootUrl: String, val summary: String)

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: 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.

DocumentationRuleResponse

data class DocumentationRuleResponse(val deprecationDescription: String, val description: String, val disableReplacementWords: String, val selector: String)

A documentation rule provides information about individual API elements.

DotnetSettingsResponse

data class DotnetSettingsResponse(val common: CommonLanguageSettingsResponse, val forcedNamespaceAliases: List<String>, val handwrittenSignatures: List<String>, val ignoredResources: List<String>, val renamedResources: Map<String, String>, val renamedServices: Map<String, String>)

Settings for Dotnet client libraries.

EndpointResponse

data class EndpointResponse(val aliases: List<String>, val allowCors: Boolean, val name: String, val target: String)

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

EnumResponse

data class EnumResponse(val edition: String, val enumvalue: List<EnumValueResponse>, val name: String, val options: List<OptionResponse>, val sourceContext: SourceContextResponse, val syntax: String)

Enum type definition.

EnumValueResponse

data class EnumValueResponse(val name: String, val number: Int, val options: List<OptionResponse>)

Enum value definition.

ExprResponse

data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

FieldResponse

data class FieldResponse(val cardinality: String, val defaultValue: String, val jsonName: String, val kind: String, val name: String, val number: Int, val oneofIndex: Int, val options: List<OptionResponse>, val packed: Boolean, val typeUrl: String)

A single field of a message type.

GetConfigResult

data class GetConfigResult(val apis: List<ApiResponse>, val authentication: AuthenticationResponse, val backend: BackendResponse, val billing: BillingResponse, val configVersion: Int, val context: ContextResponse, val control: ControlResponse, val customError: CustomErrorResponse, val documentation: DocumentationResponse, val endpoints: List<EndpointResponse>, val enums: List<EnumResponse>, val http: HttpResponse, val logging: LoggingResponse, val logs: List<LogDescriptorResponse>, val metrics: List<MetricDescriptorResponse>, val monitoredResources: List<MonitoredResourceDescriptorResponse>, val monitoring: MonitoringResponse, val name: String, val producerProjectId: String, val publishing: PublishingResponse, val quota: QuotaResponse, val sourceInfo: SourceInfoResponse, val systemParameters: SystemParametersResponse, val systemTypes: List<TypeResponse>, val title: String, val types: List<TypeResponse>, val usage: UsageResponse)

GetRolloutResult

data class GetRolloutResult(val createTime: String, val createdBy: String, val deleteServiceStrategy: DeleteServiceStrategyResponse, val rolloutId: String, val serviceName: String, val status: String, val trafficPercentStrategy: TrafficPercentStrategyResponse)

GetServiceConsumerIamPolicyResult

data class GetServiceConsumerIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetServiceIamPolicyResult

data class GetServiceIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetServiceResult

data class GetServiceResult(val producerProjectId: String, val serviceName: String)

GoSettingsResponse

data class GoSettingsResponse(val common: CommonLanguageSettingsResponse)

Settings for Go client libraries.

HttpResponse

data class HttpResponse(val fullyDecodeReservedExpansion: Boolean, val rules: List<HttpRuleResponse>)

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.

HttpRuleResponse

data class HttpRuleResponse(val additionalBindings: List<HttpRuleResponse>, val body: String, val custom: CustomHttpPatternResponse, val delete: String, val get: String, val patch: String, val post: String, val put: String, val responseBody: String, val selector: String)

JavaSettingsResponse

data class JavaSettingsResponse(val common: CommonLanguageSettingsResponse, val libraryPackage: String, val serviceClassNames: Map<String, String>)

Settings for Java client libraries.

JwtLocationResponse

data class JwtLocationResponse(val cookie: String, val header: String, val query: String, val valuePrefix: String)

Specifies a location to extract JWT from an API request.

LabelDescriptorResponse

data class LabelDescriptorResponse(val description: String, val key: String, val valueType: String)

A description of a label.

LogDescriptorResponse

data class LogDescriptorResponse(val description: String, val displayName: String, val labels: List<LabelDescriptorResponse>, val name: String)

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

LoggingDestinationResponse

data class LoggingDestinationResponse(val logs: List<String>, val monitoredResource: String)

Configuration of a specific logging destination (the producer project or the consumer project).

LoggingResponse

data class LoggingResponse(val consumerDestinations: List<LoggingDestinationResponse>, val producerDestinations: List<LoggingDestinationResponse>)

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

LongRunningResponse

data class LongRunningResponse(val initialPollDelay: String, val maxPollDelay: String, val pollDelayMultiplier: Double, val totalPollTimeout: String)

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).

MethodResponse

data class MethodResponse(val name: String, val options: List<OptionResponse>, val requestStreaming: Boolean, val requestTypeUrl: String, val responseStreaming: Boolean, val responseTypeUrl: String, val syntax: String)

Method represents a method of an API interface.

MethodSettingsResponse

data class MethodSettingsResponse(val longRunning: LongRunningResponse, val selector: String)

Describes the generator configuration for a method.

MetricDescriptorMetadataResponse

data class MetricDescriptorMetadataResponse(val ingestDelay: String, val launchStage: String, val samplePeriod: String)

Additional annotations that can be used to guide the usage of a metric.

MetricDescriptorResponse

data class MetricDescriptorResponse(val description: String, val displayName: String, val labels: List<LabelDescriptorResponse>, val launchStage: String, val metadata: MetricDescriptorMetadataResponse, val metricKind: String, val monitoredResourceTypes: List<String>, val name: String, val type: String, val unit: String, val valueType: String)

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.

MetricRuleResponse

data class MetricRuleResponse(val metricCosts: Map<String, String>, val selector: String)

Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.

MixinResponse

data class MixinResponse(val name: String, val root: String)

Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=}:getAcl"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=}"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in AccessControl are also declared with same name and request/response types in Storage. A documentation generator or annotation processor will see the effective Storage.GetAcl method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=}:getAcl"; } ... } Note how the version in the path pattern changed from v1 to v2. If the root field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=}:getAcl"; } ... }

MonitoredResourceDescriptorResponse

data class MonitoredResourceDescriptorResponse(val description: String, val displayName: String, val labels: List<LabelDescriptorResponse>, val launchStage: String, val name: String, val type: String)

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.

MonitoringDestinationResponse

data class MonitoringDestinationResponse(val metrics: List<String>, val monitoredResource: String)

Configuration of a specific monitoring destination (the producer project or the consumer project).

MonitoringResponse

data class MonitoringResponse(val consumerDestinations: List<MonitoringDestinationResponse>, val producerDestinations: List<MonitoringDestinationResponse>)

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

NodeSettingsResponse

data class NodeSettingsResponse(val common: CommonLanguageSettingsResponse)

Settings for Node client libraries.

OAuthRequirementsResponse

data class OAuthRequirementsResponse(val canonicalScopes: String)

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.

OptionResponse

data class OptionResponse(val name: String, val value: Map<String, String>)

A protocol buffer option, which can be attached to a message, field, enumeration, etc.

PageResponse

data class PageResponse(val content: String, val name: String, val subpages: List<PageResponse>)

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

PhpSettingsResponse

data class PhpSettingsResponse(val common: CommonLanguageSettingsResponse)

Settings for Php client libraries.

PublishingResponse

data class PublishingResponse(val apiShortName: String, val codeownerGithubTeams: List<String>, val docTagPrefix: String, val documentationUri: String, val githubLabel: String, val librarySettings: List<ClientLibrarySettingsResponse>, val methodSettings: List<MethodSettingsResponse>, val newIssueUri: String, val organization: String, val protoReferenceDocumentationUri: String)

This message configures the settings for publishing Google Cloud Client libraries generated from the service config.

PythonSettingsResponse

data class PythonSettingsResponse(val common: CommonLanguageSettingsResponse)

Settings for Python client libraries.

QuotaLimitResponse

data class QuotaLimitResponse(val defaultLimit: String, val description: String, val displayName: String, val duration: String, val freeTier: String, val maxLimit: String, val metric: String, val name: String, val unit: String, val values: Map<String, String>)

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.

QuotaResponse

data class QuotaResponse(val limits: List<QuotaLimitResponse>, val metricRules: List<MetricRuleResponse>)

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

RubySettingsResponse

data class RubySettingsResponse(val common: CommonLanguageSettingsResponse)

Settings for Ruby client libraries.

SourceContextResponse

data class SourceContextResponse(val fileName: String)

SourceContext represents information about the source of a protobuf element, like the file in which it is defined.

SourceInfoResponse

data class SourceInfoResponse(val sourceFiles: List<Map<String, String>>)

Source information used to create a Service Config

SystemParameterResponse

data class SystemParameterResponse(val httpHeader: String, val name: String, val urlQueryParameter: String)

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.

SystemParameterRuleResponse

data class SystemParameterRuleResponse(val parameters: List<SystemParameterResponse>, val selector: String)

Define a system parameter rule mapping system parameter definitions to methods.

SystemParametersResponse

data class SystemParametersResponse(val rules: List<SystemParameterRuleResponse>)

TrafficPercentStrategyResponse

data class TrafficPercentStrategyResponse(val percentages: Map<String, String>)

Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } }

TypeResponse

data class TypeResponse(val edition: String, val fields: List<FieldResponse>, val name: String, val oneofs: List<String>, val options: List<OptionResponse>, val sourceContext: SourceContextResponse, val syntax: String)

A protocol buffer message type.

UsageResponse

data class UsageResponse(val producerNotificationChannel: String, val requirements: List<String>, val rules: List<UsageRuleResponse>)

Configuration controlling usage of a service.

UsageRuleResponse

data class UsageRuleResponse(val allowUnregisteredCalls: Boolean, val selector: String, val skipServiceControl: Boolean)

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