Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call CreateServiceRollout. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.
Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist
on Google Cloud even though it will be deleted from Pulumi state.
Create Config Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def Config(resource_name: str,
args: ConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Config(resource_name: str,
opts: Optional[ResourceOptions] = None,
service_name: Optional[str] = None,
logs: Optional[Sequence[LogDescriptorArgs]] = None,
title: Optional[str] = None,
billing: Optional[BillingArgs] = None,
config_version: Optional[int] = None,
context: Optional[ContextArgs] = None,
control: Optional[ControlArgs] = None,
custom_error: Optional[CustomErrorArgs] = None,
documentation: Optional[DocumentationArgs] = None,
endpoints: Optional[Sequence[EndpointArgs]] = None,
enums: Optional[Sequence[EnumArgs]] = None,
http: Optional[HttpArgs] = None,
metrics: Optional[Sequence[MetricDescriptorArgs]] = None,
backend: Optional[BackendArgs] = None,
logging: Optional[LoggingArgs] = None,
id: Optional[str] = None,
monitored_resources: Optional[Sequence[MonitoredResourceDescriptorArgs]] = None,
monitoring: Optional[MonitoringArgs] = None,
name: Optional[str] = None,
producer_project_id: Optional[str] = None,
publishing: Optional[PublishingArgs] = None,
quota: Optional[QuotaArgs] = None,
authentication: Optional[AuthenticationArgs] = None,
system_parameters: Optional[SystemParametersArgs] = None,
system_types: Optional[Sequence[TypeArgs]] = None,
apis: Optional[Sequence[ApiArgs]] = None,
types: Optional[Sequence[TypeArgs]] = None,
usage: Optional[UsageArgs] = None)
public Config(String name, ConfigArgs args)
public Config(String name, ConfigArgs args, CustomResourceOptions options)
type: google-native:servicemanagement/v1:Config
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_servicemanagement_v1_config" "name" {
# resource properties
}
Parameters
- name
string
- The unique name of the resource.
- args
ConfigArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resource.
- args
ConfigArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
ConfigArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resource.
- args
ConfigArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
ConfigArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Config Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Config resource accepts the following input properties:
- ServiceName
string
- Apis
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Api>
- A list of API interfaces exported by this service. Only the
name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Authentication
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Authentication
- Auth configuration.
- Backend
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Backend
- API backend configuration.
- Billing
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Billing
- Billing configuration.
- ConfigVersion
int
- Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3. - Context
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Context
- Context configuration.
- Control
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Control
- Configuration for the service control plane.
- CustomError
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CustomError
- Custom error configuration.
- Documentation
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Documentation
- Additional API documentation.
- Endpoints
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Endpoint>
- 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.
- Enums
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Enum>
- 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 - Http
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Http
- HTTP configuration.
- Id
string
- 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.
- Logging
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Logging
- Logging configuration.
- Logs
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LogDescriptor>
- Defines the logs used by this service.
- Metrics
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MetricDescriptor>
- Defines the metrics used by this service.
- MonitoredResources
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MonitoredResourceDescriptor>
- Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- Monitoring
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Monitoring
- Monitoring configuration.
- Name
string
- 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. - ProducerProjectId
string
- The Google project that owns this service.
- Publishing
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Publishing
- Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- Quota
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Quota
- Quota configuration.
- SystemParameters
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SystemParameters
- System parameter configuration.
- SystemTypes
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Type>
- A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- Title
string
- The product title for this service, it is the name displayed in Google Cloud Console.
- Types
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Type>
- 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 - Usage
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Usage
- Configuration controlling usage of this service.
- ServiceName
string
- Apis
[]ApiArgs
- A list of API interfaces exported by this service. Only the
name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Authentication
AuthenticationArgs
- Auth configuration.
- Backend
BackendArgs
- API backend configuration.
- Billing
BillingArgs
- Billing configuration.
- ConfigVersion
int
- Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3. - Context
ContextArgs
- Context configuration.
- Control
ControlArgs
- Configuration for the service control plane.
- CustomError
CustomErrorArgs
- Custom error configuration.
- Documentation
DocumentationArgs
- Additional API documentation.
- Endpoints
[]EndpointArgs
- 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.
- Enums
[]EnumArgs
- 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 - Http
HttpArgs
- HTTP configuration.
- Id
string
- 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.
- Logging
LoggingArgs
- Logging configuration.
- Logs
[]LogDescriptorArgs
- Defines the logs used by this service.
- Metrics
[]MetricDescriptorArgs
- Defines the metrics used by this service.
- MonitoredResources
[]MonitoredResourceDescriptorArgs
- Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- Monitoring
MonitoringArgs
- Monitoring configuration.
- Name
string
- 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. - ProducerProjectId
string
- The Google project that owns this service.
- Publishing
PublishingArgs
- Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- Quota
QuotaArgs
- Quota configuration.
- SystemParameters
SystemParametersArgs
- System parameter configuration.
- SystemTypes
[]TypeArgs
- A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- Title
string
- The product title for this service, it is the name displayed in Google Cloud Console.
- Types
[]TypeArgs
- 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 - Usage
UsageArgs
- Configuration controlling usage of this service.
- service_name
string
- apis
list(object)
- A list of API interfaces exported by this service. Only the
name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication
object
- Auth configuration.
- backend
object
- API backend configuration.
- billing
object
- Billing configuration.
- config_version
number
- Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3. - context
object
- Context configuration.
- control
object
- Configuration for the service control plane.
- custom_error
object
- Custom error configuration.
- documentation
object
- Additional API documentation.
- endpoints
list(object)
- 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.
- enums
list(object)
- 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 - http
object
- HTTP configuration.
- id
string
- 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.
- logging
object
- Logging configuration.
- logs
list(object)
- Defines the logs used by this service.
- metrics
list(object)
- Defines the metrics used by this service.
- monitored_resources
list(object)
- Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
object
- Monitoring configuration.
- name
string
- 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. - producer_project_id
string
- The Google project that owns this service.
- publishing
object
- Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota
object
- Quota configuration.
- system_parameters
object
- System parameter configuration.
- system_types
list(object)
- A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title
string
- The product title for this service, it is the name displayed in Google Cloud Console.
- types
list(object)
- 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 - usage
object
- Configuration controlling usage of this service.
- serviceName
String
- apis
List<Api>
- A list of API interfaces exported by this service. Only the
name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication
Authentication
- Auth configuration.
- backend
Backend
- API backend configuration.
- billing
Billing
- Billing configuration.
- configVersion
Integer
- Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3. - context
Context
- Context configuration.
- control
Control
- Configuration for the service control plane.
- customError
CustomError
- Custom error configuration.
- documentation
Documentation
- Additional API documentation.
- endpoints
List<Endpoint>
- 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.
- enums
List<Enum>
- 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 - http
Http
- HTTP configuration.
- id
String
- 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.
- logging
Logging
- Logging configuration.
- logs
List<LogDescriptor>
- Defines the logs used by this service.
- metrics
List<MetricDescriptor>
- Defines the metrics used by this service.
- monitoredResources
List<MonitoredResourceDescriptor>
- Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Monitoring
- Monitoring configuration.
- name
String
- 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. - producerProjectId
String
- The Google project that owns this service.
- publishing
Publishing
- Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota
Quota
- Quota configuration.
- systemParameters
SystemParameters
- System parameter configuration.
- systemTypes
List<Type>
- A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title
String
- The product title for this service, it is the name displayed in Google Cloud Console.
- types
List<Type>
- 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 - usage
Usage
- Configuration controlling usage of this service.
- serviceName
string
- apis
Api[]
- A list of API interfaces exported by this service. Only the
name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication
Authentication
- Auth configuration.
- backend
Backend
- API backend configuration.
- billing
Billing
- Billing configuration.
- configVersion
number
- Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3. - context
Context
- Context configuration.
- control
Control
- Configuration for the service control plane.
- customError
CustomError
- Custom error configuration.
- documentation
Documentation
- Additional API documentation.
- endpoints
Endpoint[]
- 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.
- enums
Enum[]
- 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 - http
Http
- HTTP configuration.
- id
string
- 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.
- logging
Logging
- Logging configuration.
- logs
LogDescriptor[]
- Defines the logs used by this service.
- metrics
MetricDescriptor[]
- Defines the metrics used by this service.
- monitoredResources
MonitoredResourceDescriptor[]
- Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Monitoring
- Monitoring configuration.
- name
string
- 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. - producerProjectId
string
- The Google project that owns this service.
- publishing
Publishing
- Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota
Quota
- Quota configuration.
- systemParameters
SystemParameters
- System parameter configuration.
- systemTypes
Type[]
- A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title
string
- The product title for this service, it is the name displayed in Google Cloud Console.
- types
Type[]
- 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 - usage
Usage
- Configuration controlling usage of this service.
- service_name
str
- apis
Sequence[ApiArgs]
- A list of API interfaces exported by this service. Only the
name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication
AuthenticationArgs
- Auth configuration.
- backend
BackendArgs
- API backend configuration.
- billing
BillingArgs
- Billing configuration.
- config_version
int
- Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3. - context
ContextArgs
- Context configuration.
- control
ControlArgs
- Configuration for the service control plane.
- custom_error
CustomErrorArgs
- Custom error configuration.
- documentation
DocumentationArgs
- Additional API documentation.
- endpoints
Sequence[EndpointArgs]
- 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.
- enums
Sequence[EnumArgs]
- 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 - http
HttpArgs
- HTTP configuration.
- id
str
- 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.
- logging
LoggingArgs
- Logging configuration.
- logs
Sequence[LogDescriptorArgs]
- Defines the logs used by this service.
- metrics
Sequence[MetricDescriptorArgs]
- Defines the metrics used by this service.
- monitored_resources
Sequence[MonitoredResourceDescriptorArgs]
- Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
MonitoringArgs
- Monitoring configuration.
- name
str
- 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. - producer_project_id
str
- The Google project that owns this service.
- publishing
PublishingArgs
- Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota
QuotaArgs
- Quota configuration.
- system_parameters
SystemParametersArgs
- System parameter configuration.
- system_types
Sequence[TypeArgs]
- A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title
str
- The product title for this service, it is the name displayed in Google Cloud Console.
- types
Sequence[TypeArgs]
- 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 - usage
UsageArgs
- Configuration controlling usage of this service.
- serviceName
String
- apis
List<Property Map>
- A list of API interfaces exported by this service. Only the
name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication
Property Map
- Auth configuration.
- backend
Property Map
- API backend configuration.
- billing
Property Map
- Billing configuration.
- configVersion
Number
- Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3. - context
Property Map
- Context configuration.
- control
Property Map
- Configuration for the service control plane.
- customError
Property Map
- Custom error configuration.
- documentation
Property Map
- Additional API documentation.
- endpoints
List<Property Map>
- 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.
- enums
List<Property Map>
- 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 - http
Property Map
- HTTP configuration.
- id
String
- 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.
- logging
Property Map
- Logging configuration.
- logs
List<Property Map>
- Defines the logs used by this service.
- metrics
List<Property Map>
- Defines the metrics used by this service.
- monitoredResources
List<Property Map>
- Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Property Map
- Monitoring configuration.
- name
String
- 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. - producerProjectId
String
- The Google project that owns this service.
- publishing
Property Map
- Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota
Property Map
- Quota configuration.
- systemParameters
Property Map
- System parameter configuration.
- systemTypes
List<Property Map>
- A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title
String
- The product title for this service, it is the name displayed in Google Cloud Console.
- types
List<Property Map>
- 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 - usage
Property Map
- Configuration controlling usage of this service.
Outputs
All input properties are implicitly available as output properties. Additionally, the Config resource produces the following output properties:
- Id
string
- The provider-assigned unique ID for this managed resource.
- SourceInfo
SourceInfoResponse
- The source information for this configuration if available.
- id
string
- The provider-assigned unique ID for this managed resource.
- source_info
object
- The source information for this configuration if available.
- id
String
- The provider-assigned unique ID for this managed resource.
- sourceInfo
SourceInfoResponse
- The source information for this configuration if available.
- id
string
- The provider-assigned unique ID for this managed resource.
- sourceInfo
SourceInfoResponse
- The source information for this configuration if available.
- id
String
- The provider-assigned unique ID for this managed resource.
- sourceInfo
Property Map
- The source information for this configuration if available.
Look up Existing Config Resource
Get an existing Config resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static Config get(String name, Output<String> id, CustomResourceOptions options)
resources: existingConfig: type: google-native:servicemanagement/v1:Config get: id: ${id}
import {
to = google-native_servicemanagement_v1_config.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
ConfigState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
Api, ApiArgs
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.- Methods
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Method>
- The methods of this interface, in unspecified order.
- Mixins
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Mixin>
- Included interfaces. See Mixin.
- Name
string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- Options
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Option>
- Any metadata attached to the interface.
- SourceContext
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SourceContext
- Source context for the protocol buffer service represented by this message.
- Syntax
Pulumi.GoogleNative.ServiceManagement.V1.ApiSyntax
- The source syntax of the service.
- Version
string
- 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 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.
- Methods
[]Method
- The methods of this interface, in unspecified order.
- Mixins
[]Mixin
- Included interfaces. See Mixin.
- Name
string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- Options
[]Option
- Any metadata attached to the interface.
- SourceContext
SourceContext
- Source context for the protocol buffer service represented by this message.
- Syntax
ApiSyntax
- The source syntax of the service.
- Version
string
- 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 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.
- methods
list(object)
- The methods of this interface, in unspecified order.
- mixins
list(object)
- Included interfaces. See Mixin.
- name
string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
list(object)
- Any metadata attached to the interface.
- source_context
object
- Source context for the protocol buffer service represented by this message.
- syntax
"SYNTAX_PROTO2" | "SYNTAX_PROTO3" | "SYNTAX_EDITIONS"
- The source syntax of the service.
- version
string
- 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 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.
- methods
List<Method>
- The methods of this interface, in unspecified order.
- mixins
List<Mixin>
- Included interfaces. See Mixin.
- name
String
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
List<Option>
- Any metadata attached to the interface.
- sourceContext
SourceContext
- Source context for the protocol buffer service represented by this message.
- syntax
ApiSyntax
- The source syntax of the service.
- version
String
- 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 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.
- methods
Method[]
- The methods of this interface, in unspecified order.
- mixins
Mixin[]
- Included interfaces. See Mixin.
- name
string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
Option[]
- Any metadata attached to the interface.
- sourceContext
SourceContext
- Source context for the protocol buffer service represented by this message.
- syntax
ApiSyntax
- The source syntax of the service.
- version
string
- 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 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.
- methods
Sequence[Method]
- The methods of this interface, in unspecified order.
- mixins
Sequence[Mixin]
- Included interfaces. See Mixin.
- name
str
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
Sequence[Option]
- Any metadata attached to the interface.
- source_context
SourceContext
- Source context for the protocol buffer service represented by this message.
- syntax
ApiSyntax
- The source syntax of the service.
- version
str
- 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 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.
- methods
List<Property Map>
- The methods of this interface, in unspecified order.
- mixins
List<Property Map>
- Included interfaces. See Mixin.
- name
String
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
List<Property Map>
- Any metadata attached to the interface.
- sourceContext
Property Map
- Source context for the protocol buffer service represented by this message.
- syntax
"SYNTAX_PROTO2" | "SYNTAX_PROTO3" | "SYNTAX_EDITIONS"
- The source syntax of the service.
- version
String
- 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 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.
ApiResponse, ApiResponseArgs
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.- Methods
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MethodResponse>
- The methods of this interface, in unspecified order.
- Mixins
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MixinResponse>
- Included interfaces. See Mixin.
- Name
string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- Options
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.OptionResponse>
- Any metadata attached to the interface.
- SourceContext
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SourceContextResponse
- Source context for the protocol buffer service represented by this message.
- Syntax
string
- The source syntax of the service.
- Version
string
- 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 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.
- Methods
[]MethodResponse
- The methods of this interface, in unspecified order.
- Mixins
[]MixinResponse
- Included interfaces. See Mixin.
- Name
string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- Options
[]OptionResponse
- Any metadata attached to the interface.
- SourceContext
SourceContextResponse
- Source context for the protocol buffer service represented by this message.
- Syntax
string
- The source syntax of the service.
- Version
string
- 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 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.
- methods
list(object)
- The methods of this interface, in unspecified order.
- mixins
list(object)
- Included interfaces. See Mixin.
- name
string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
list(object)
- Any metadata attached to the interface.
- source_context
object
- Source context for the protocol buffer service represented by this message.
- syntax
string
- The source syntax of the service.
- version
string
- 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 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.
- methods
List<MethodResponse>
- The methods of this interface, in unspecified order.
- mixins
List<MixinResponse>
- Included interfaces. See Mixin.
- name
String
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
List<OptionResponse>
- Any metadata attached to the interface.
- sourceContext
SourceContextResponse
- Source context for the protocol buffer service represented by this message.
- syntax
String
- The source syntax of the service.
- version
String
- 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 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.
- methods
MethodResponse[]
- The methods of this interface, in unspecified order.
- mixins
MixinResponse[]
- Included interfaces. See Mixin.
- name
string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
OptionResponse[]
- Any metadata attached to the interface.
- sourceContext
SourceContextResponse
- Source context for the protocol buffer service represented by this message.
- syntax
string
- The source syntax of the service.
- version
string
- 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 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.
- methods
Sequence[MethodResponse]
- The methods of this interface, in unspecified order.
- mixins
Sequence[MixinResponse]
- Included interfaces. See Mixin.
- name
str
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
Sequence[OptionResponse]
- Any metadata attached to the interface.
- source_context
SourceContextResponse
- Source context for the protocol buffer service represented by this message.
- syntax
str
- The source syntax of the service.
- version
str
- 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 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.
- methods
List<Property Map>
- The methods of this interface, in unspecified order.
- mixins
List<Property Map>
- Included interfaces. See Mixin.
- name
String
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
List<Property Map>
- Any metadata attached to the interface.
- sourceContext
Property Map
- Source context for the protocol buffer service represented by this message.
- syntax
String
- The source syntax of the service.
- version
String
- 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 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.
ApiSyntax, ApiSyntaxArgs
The source syntax of the service.| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| ApiSyntaxSyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| ApiSyntaxSyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| ApiSyntaxSyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Value | Description |
|---|
SYNTAX_PROTO2 | Syntax proto2. |
SYNTAX_PROTO3 | Syntax proto3. |
SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SYNTAX_PROTO2 | SYNTAX_PROTO2 | Syntax proto2. |
| SYNTAX_PROTO3 | SYNTAX_PROTO3 | Syntax proto3. |
| SYNTAX_EDITIONS | SYNTAX_EDITIONS | Syntax editions. |
| Value | Description |
|---|
SYNTAX_PROTO2 | Syntax proto2. |
SYNTAX_PROTO3 | Syntax proto3. |
SYNTAX_EDITIONS | Syntax editions. |
AuthProvider, AuthProviderArgs
Configuration for an authentication provider, including support for JSON Web Token (JWT).- Audiences
string
- The list of JWT audiences. 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
- AuthorizationUrl
string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- Id
string
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. Example: "bookstore_auth". - Issuer
string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- JwksUri
string
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- JwtLocations
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.JwtLocation>
- 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
- Audiences
string
- The list of JWT audiences. 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
- AuthorizationUrl
string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- Id
string
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. Example: "bookstore_auth". - Issuer
string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- JwksUri
string
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- JwtLocations
[]JwtLocation
- 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
- audiences
string
- The list of JWT audiences. 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
- authorization_url
string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- id
string
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. Example: "bookstore_auth". - issuer
string
- 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
- jwks_uri
string
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwt_locations
list(object)
- 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
- audiences
String
- The list of JWT audiences. 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
- authorizationUrl
String
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- id
String
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. Example: "bookstore_auth". - issuer
String
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwksUri
String
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwtLocations
List<JwtLocation>
- 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
- audiences
string
- The list of JWT audiences. 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
- authorizationUrl
string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- id
string
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. Example: "bookstore_auth". - issuer
string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwksUri
string
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwtLocations
JwtLocation[]
- 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
- audiences
str
- The list of JWT audiences. 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
- authorization_url
str
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- id
str
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. Example: "bookstore_auth". - issuer
str
- 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
- jwks_uri
str
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwt_locations
Sequence[JwtLocation]
- 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
- audiences
String
- The list of JWT audiences. 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
- authorizationUrl
String
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- id
String
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. Example: "bookstore_auth". - issuer
String
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwksUri
String
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwtLocations
List<Property Map>
- 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
AuthProviderResponse, AuthProviderResponseArgs
Configuration for an authentication provider, including support for JSON Web Token (JWT).- Audiences
string
- The list of JWT audiences. 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
- AuthorizationUrl
string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- Issuer
string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- JwksUri
string
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- JwtLocations
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.JwtLocationResponse>
- 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
- Audiences
string
- The list of JWT audiences. 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
- AuthorizationUrl
string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- Issuer
string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- JwksUri
string
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- JwtLocations
[]JwtLocationResponse
- 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
- audiences
string
- The list of JWT audiences. 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
- authorization_url
string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer
string
- 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
- jwks_uri
string
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwt_locations
list(object)
- 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
- audiences
String
- The list of JWT audiences. 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
- authorizationUrl
String
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer
String
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwksUri
String
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwtLocations
List<JwtLocationResponse>
- 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
- audiences
string
- The list of JWT audiences. 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
- authorizationUrl
string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer
string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwksUri
string
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwtLocations
JwtLocationResponse[]
- 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
- audiences
str
- The list of JWT audiences. 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
- authorization_url
str
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer
str
- 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
- jwks_uri
str
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwt_locations
Sequence[JwtLocationResponse]
- 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
- audiences
String
- The list of JWT audiences. 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
- authorizationUrl
String
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer
String
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwksUri
String
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery 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
- jwtLocations
List<Property Map>
- 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
AuthRequirement, AuthRequirementArgs
User-defined authentication requirements, including support for JSON Web Token (JWT).- Audiences
string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- ProviderId
string
- id from authentication provider. Example: provider_id: bookstore_auth
- Audiences
string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- ProviderId
string
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. 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
- provider_id
string
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
String
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- providerId
String
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- providerId
string
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
str
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. 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
- provider_id
str
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
String
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- providerId
String
- id from authentication provider. Example: provider_id: bookstore_auth
AuthRequirementResponse, AuthRequirementResponseArgs
User-defined authentication requirements, including support for JSON Web Token (JWT).- Audiences
string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- ProviderId
string
- id from authentication provider. Example: provider_id: bookstore_auth
- Audiences
string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- ProviderId
string
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. 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
- provider_id
string
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
String
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- providerId
String
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- providerId
string
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
str
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. 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
- provider_id
str
- id from authentication provider. Example: provider_id: bookstore_auth
- audiences
String
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- providerId
String
- id from authentication provider. Example: provider_id: bookstore_auth
Authentication, AuthenticationArgs
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- Providers
[]AuthProvider
- Defines a set of authentication providers that a service supports.
- Rules
[]AuthenticationRule
- A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
list(object)
- Defines a set of authentication providers that a service supports.
- rules
list(object)
- A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
AuthProvider[]
- Defines a set of authentication providers that a service supports.
- rules
AuthenticationRule[]
- A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
List<Property Map>
- Defines a set of authentication providers that a service supports.
- rules
List<Property Map>
- A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
AuthenticationResponse, AuthenticationResponseArgs
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- providers
list(object)
- Defines a set of authentication providers that a service supports.
- rules
list(object)
- A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
List<Property Map>
- Defines a set of authentication providers that a service supports.
- rules
List<Property Map>
- A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
AuthenticationRule, AuthenticationRuleArgs
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.- allow_without_credential
bool
- If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
object
- The requirements for OAuth credentials.
- requirements
list(object)
- Requirements for additional authentication providers.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowWithoutCredential
Boolean
- If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
Property Map
- The requirements for OAuth credentials.
- requirements
List<Property Map>
- Requirements for additional authentication providers.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
AuthenticationRuleResponse, AuthenticationRuleResponseArgs
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.- allow_without_credential
bool
- If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
object
- The requirements for OAuth credentials.
- requirements
list(object)
- Requirements for additional authentication providers.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowWithoutCredential
Boolean
- If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
Property Map
- The requirements for OAuth credentials.
- requirements
List<Property Map>
- Requirements for additional authentication providers.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
Backend, BackendArgs
Backend defines the backend configuration for a service.- Rules
[]BackendRule
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
list(object)
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<BackendRule>
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
BackendRule[]
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[BackendRule]
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Property Map>
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
BackendResponse, BackendResponseArgs
Backend defines the backend configuration for a service.- Rules
[]BackendRuleResponse
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
list(object)
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<BackendRuleResponse>
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
BackendRuleResponse[]
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Property Map>
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
BackendRule, BackendRuleArgs
A backend rule provides configuration for an individual API element.- Address
string
- 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.
- Deadline
double
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- DisableAuth
bool
- 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.
- JwtAudience
string
- 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.
- MinDeadline
double
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- OperationDeadline
double
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- OverridesByRequestProtocol
Dictionary<string, string>
- The map between request protocol and the backend address.
- PathTranslation
Pulumi.GoogleNative.ServiceManagement.V1.BackendRulePathTranslation
- Protocol
string
- 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.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- Address
string
- 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.
- Deadline
float64
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- DisableAuth
bool
- 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.
- JwtAudience
string
- 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.
- MinDeadline
float64
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- OperationDeadline
float64
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- OverridesByRequestProtocol
map[string]string
- The map between request protocol and the backend address.
- PathTranslation
BackendRulePathTranslation
- Protocol
string
- 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.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
string
- 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.
- deadline
number
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disable_auth
bool
- 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.
- jwt_audience
string
- 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.
- min_deadline
number
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operation_deadline
number
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overrides_by_request_protocol
map(string)
- The map between request protocol and the backend address.
- path_translation
"PATH_TRANSLATION_UNSPECIFIED" | "CONSTANT_ADDRESS" | "APPEND_PATH_TO_ADDRESS"
- protocol
string
- 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.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
String
- 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.
- deadline
Double
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disableAuth
Boolean
- 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.
- jwtAudience
String
- 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.
- minDeadline
Double
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operationDeadline
Double
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overridesByRequestProtocol
Map<String,String>
- The map between request protocol and the backend address.
- pathTranslation
BackendRulePathTranslation
- protocol
String
- 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.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
string
- 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.
- deadline
number
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disableAuth
boolean
- 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.
- jwtAudience
string
- 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.
- minDeadline
number
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operationDeadline
number
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overridesByRequestProtocol
{[key: string]: string}
- The map between request protocol and the backend address.
- pathTranslation
BackendRulePathTranslation
- protocol
string
- 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.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
str
- 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.
- deadline
float
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disable_auth
bool
- 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.
- jwt_audience
str
- 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.
- min_deadline
float
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operation_deadline
float
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overrides_by_request_protocol
Mapping[str, str]
- The map between request protocol and the backend address.
- path_translation
BackendRulePathTranslation
- protocol
str
- 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.
- selector
str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
String
- 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.
- deadline
Number
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disableAuth
Boolean
- 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.
- jwtAudience
String
- 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.
- minDeadline
Number
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operationDeadline
Number
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overridesByRequestProtocol
Map<String>
- The map between request protocol and the backend address.
- pathTranslation
"PATH_TRANSLATION_UNSPECIFIED" | "CONSTANT_ADDRESS" | "APPEND_PATH_TO_ADDRESS"
- protocol
String
- 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.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
BackendRulePathTranslation, BackendRulePathTranslationArgs
| Name | Value | Description |
|---|
| PathTranslationUnspecified | PATH_TRANSLATION_UNSPECIFIED | |
| ConstantAddress | CONSTANT_ADDRESS | Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
| AppendPathToAddress | APPEND_PATH_TO_ADDRESS | The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| Name | Value | Description |
|---|
| BackendRulePathTranslationPathTranslationUnspecified | PATH_TRANSLATION_UNSPECIFIED | |
| BackendRulePathTranslationConstantAddress | CONSTANT_ADDRESS | Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
| BackendRulePathTranslationAppendPathToAddress | APPEND_PATH_TO_ADDRESS | The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| Value | Description |
|---|
PATH_TRANSLATION_UNSPECIFIED | |
CONSTANT_ADDRESS | Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
APPEND_PATH_TO_ADDRESS | The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| Name | Value | Description |
|---|
| PathTranslationUnspecified | PATH_TRANSLATION_UNSPECIFIED | |
| ConstantAddress | CONSTANT_ADDRESS | Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
| AppendPathToAddress | APPEND_PATH_TO_ADDRESS | The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| Name | Value | Description |
|---|
| PathTranslationUnspecified | PATH_TRANSLATION_UNSPECIFIED | |
| ConstantAddress | CONSTANT_ADDRESS | Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
| AppendPathToAddress | APPEND_PATH_TO_ADDRESS | The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| Name | Value | Description |
|---|
| PATH_TRANSLATION_UNSPECIFIED | PATH_TRANSLATION_UNSPECIFIED | |
| CONSTANT_ADDRESS | CONSTANT_ADDRESS | Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
| APPEND_PATH_TO_ADDRESS | APPEND_PATH_TO_ADDRESS | The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
| Value | Description |
|---|
PATH_TRANSLATION_UNSPECIFIED | |
CONSTANT_ADDRESS | Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe |
APPEND_PATH_TO_ADDRESS | The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST |
BackendRuleResponse, BackendRuleResponseArgs
A backend rule provides configuration for an individual API element.- Address
string
- 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.
- Deadline
double
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- DisableAuth
bool
- 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.
- JwtAudience
string
- 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.
- MinDeadline
double
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- OperationDeadline
double
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- OverridesByRequestProtocol
Dictionary<string, string>
- The map between request protocol and the backend address.
- PathTranslation
string
- Protocol
string
- 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.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- Address
string
- 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.
- Deadline
float64
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- DisableAuth
bool
- 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.
- JwtAudience
string
- 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.
- MinDeadline
float64
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- OperationDeadline
float64
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- OverridesByRequestProtocol
map[string]string
- The map between request protocol and the backend address.
- PathTranslation
string
- Protocol
string
- 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.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
string
- 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.
- deadline
number
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disable_auth
bool
- 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.
- jwt_audience
string
- 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.
- min_deadline
number
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operation_deadline
number
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overrides_by_request_protocol
map(string)
- The map between request protocol and the backend address.
- path_translation
string
- protocol
string
- 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.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
String
- 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.
- deadline
Double
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disableAuth
Boolean
- 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.
- jwtAudience
String
- 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.
- minDeadline
Double
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operationDeadline
Double
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overridesByRequestProtocol
Map<String,String>
- The map between request protocol and the backend address.
- pathTranslation
String
- protocol
String
- 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.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
string
- 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.
- deadline
number
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disableAuth
boolean
- 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.
- jwtAudience
string
- 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.
- minDeadline
number
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operationDeadline
number
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overridesByRequestProtocol
{[key: string]: string}
- The map between request protocol and the backend address.
- pathTranslation
string
- protocol
string
- 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.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
str
- 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.
- deadline
float
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disable_auth
bool
- 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.
- jwt_audience
str
- 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.
- min_deadline
float
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operation_deadline
float
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overrides_by_request_protocol
Mapping[str, str]
- The map between request protocol and the backend address.
- path_translation
str
- protocol
str
- 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.
- selector
str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address
String
- 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.
- deadline
Number
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disableAuth
Boolean
- 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.
- jwtAudience
String
- 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.
- minDeadline
Number
- Deprecated, do not use.
Deprecated: Deprecated, do not use.
- operationDeadline
Number
- The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overridesByRequestProtocol
Map<String>
- The map between request protocol and the backend address.
- pathTranslation
String
- protocol
String
- 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.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
Billing, BillingArgs
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- ConsumerDestinations
[]BillingDestination
- 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.
- consumer_destinations
list(object)
- 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.
- consumerDestinations
List<BillingDestination>
- 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.
- consumerDestinations
BillingDestination[]
- 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.
- consumer_destinations
Sequence[BillingDestination]
- 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.
- consumerDestinations
List<Property Map>
- 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.
BillingDestination, BillingDestinationArgs
Configuration of a specific billing destination (Currently only support bill against consumer project).- Metrics
List<string>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- MonitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- Metrics
[]string
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- MonitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
list(string)
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitored_resource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
List<String>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitoredResource
String
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
string[]
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
Sequence[str]
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitored_resource
str
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
List<String>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitoredResource
String
- The monitored resource type. The type must be defined in Service.monitored_resources section.
BillingDestinationResponse, BillingDestinationResponseArgs
Configuration of a specific billing destination (Currently only support bill against consumer project).- Metrics
List<string>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- MonitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- Metrics
[]string
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- MonitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
list(string)
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitored_resource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
List<String>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitoredResource
String
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
string[]
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
Sequence[str]
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitored_resource
str
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
List<String>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitoredResource
String
- The monitored resource type. The type must be defined in Service.monitored_resources section.
BillingResponse, BillingResponseArgs
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- ConsumerDestinations
[]BillingDestinationResponse
- 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.
- consumer_destinations
list(object)
- 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.
- consumerDestinations
List<BillingDestinationResponse>
- 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.
- consumerDestinations
BillingDestinationResponse[]
- 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.
- consumer_destinations
Sequence[BillingDestinationResponse]
- 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.
- consumerDestinations
List<Property Map>
- 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.
ClientLibrarySettings, ClientLibrarySettingsArgs
Details about how and where to publish client libraries.ClientLibrarySettingsLaunchStage, ClientLibrarySettingsLaunchStageArgs
Launch stage of this version of the API.| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| ClientLibrarySettingsLaunchStageLaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| ClientLibrarySettingsLaunchStageUnimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| ClientLibrarySettingsLaunchStagePrelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| ClientLibrarySettingsLaunchStageEarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| ClientLibrarySettingsLaunchStageAlpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| ClientLibrarySettingsLaunchStageBeta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| ClientLibrarySettingsLaunchStageGa | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| ClientLibrarySettingsLaunchStageDeprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Value | Description |
|---|
LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LAUNCH_STAGE_UNSPECIFIED | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| UNIMPLEMENTED | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| PRELAUNCH | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EARLY_ACCESS | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| ALPHA | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| BETA | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| GA | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| DEPRECATED | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Value | Description |
|---|
LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
ClientLibrarySettingsResponse, ClientLibrarySettingsResponseArgs
Details about how and where to publish client libraries.CommonLanguageSettings, CommonLanguageSettingsArgs
Required information for every language.CommonLanguageSettingsDestinationsItem, CommonLanguageSettingsDestinationsItemArgs
| Name | Value | Description |
|---|
| ClientLibraryDestinationUnspecified | CLIENT_LIBRARY_DESTINATION_UNSPECIFIED | Client libraries will neither be generated nor published to package managers. |
| Github | GITHUB | Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers. |
| PackageManager | PACKAGE_MANAGER | Publish the library to package managers like nuget.org and npmjs.com. |
| Name | Value | Description |
|---|
| CommonLanguageSettingsDestinationsItemClientLibraryDestinationUnspecified | CLIENT_LIBRARY_DESTINATION_UNSPECIFIED | Client libraries will neither be generated nor published to package managers. |
| CommonLanguageSettingsDestinationsItemGithub | GITHUB | Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers. |
| CommonLanguageSettingsDestinationsItemPackageManager | PACKAGE_MANAGER | Publish the library to package managers like nuget.org and npmjs.com. |
| Value | Description |
|---|
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED | Client libraries will neither be generated nor published to package managers. |
GITHUB | Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers. |
PACKAGE_MANAGER | Publish the library to package managers like nuget.org and npmjs.com. |
| Name | Value | Description |
|---|
| ClientLibraryDestinationUnspecified | CLIENT_LIBRARY_DESTINATION_UNSPECIFIED | Client libraries will neither be generated nor published to package managers. |
| Github | GITHUB | Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers. |
| PackageManager | PACKAGE_MANAGER | Publish the library to package managers like nuget.org and npmjs.com. |
| Name | Value | Description |
|---|
| ClientLibraryDestinationUnspecified | CLIENT_LIBRARY_DESTINATION_UNSPECIFIED | Client libraries will neither be generated nor published to package managers. |
| Github | GITHUB | Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers. |
| PackageManager | PACKAGE_MANAGER | Publish the library to package managers like nuget.org and npmjs.com. |
| Name | Value | Description |
|---|
| CLIENT_LIBRARY_DESTINATION_UNSPECIFIED | CLIENT_LIBRARY_DESTINATION_UNSPECIFIED | Client libraries will neither be generated nor published to package managers. |
| GITHUB | GITHUB | Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers. |
| PACKAGE_MANAGER | PACKAGE_MANAGER | Publish the library to package managers like nuget.org and npmjs.com. |
| Value | Description |
|---|
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED | Client libraries will neither be generated nor published to package managers. |
GITHUB | Generate the client library in a repo under github.com/googleapis, but don't publish it to package managers. |
PACKAGE_MANAGER | Publish the library to package managers like nuget.org and npmjs.com. |
CommonLanguageSettingsResponse, CommonLanguageSettingsResponseArgs
Required information for every language.- Destinations
List<string>
- The destination where API teams want this client library to be published.
- ReferenceDocsUri
string
- Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- Destinations
[]string
- The destination where API teams want this client library to be published.
- ReferenceDocsUri
string
- Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations
list(string)
- The destination where API teams want this client library to be published.
- reference_docs_uri
string
- Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations
List<String>
- The destination where API teams want this client library to be published.
- referenceDocsUri
String
- Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations
string[]
- The destination where API teams want this client library to be published.
- referenceDocsUri
string
- Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations
Sequence[str]
- The destination where API teams want this client library to be published.
- reference_docs_uri
str
- Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations
List<String>
- The destination where API teams want this client library to be published.
- referenceDocsUri
String
- Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
Context, ContextArgs
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.- Rules
[]ContextRule
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
list(object)
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<ContextRule>
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
ContextRule[]
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[ContextRule]
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Property Map>
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
ContextResponse, ContextResponseArgs
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.- Rules
[]ContextRuleResponse
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
list(object)
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<ContextRuleResponse>
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
ContextRuleResponse[]
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Property Map>
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
ContextRule, ContextRuleArgs
A context rule provides information about the context for an individual API element.- AllowedRequestExtensions
List<string>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- AllowedResponseExtensions
List<string>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- Provided
List<string>
- A list of full type names of provided contexts.
- Requested
List<string>
- A list of full type names of requested contexts.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- AllowedRequestExtensions
[]string
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- AllowedResponseExtensions
[]string
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- Provided
[]string
- A list of full type names of provided contexts.
- Requested
[]string
- A list of full type names of requested contexts.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowed_request_extensions
list(string)
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed_response_extensions
list(string)
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
list(string)
- A list of full type names of provided contexts.
- requested
list(string)
- A list of full type names of requested contexts.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowedRequestExtensions
List<String>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowedResponseExtensions
List<String>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
List<String>
- A list of full type names of provided contexts.
- requested
List<String>
- A list of full type names of requested contexts.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowedRequestExtensions
string[]
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowedResponseExtensions
string[]
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
string[]
- A list of full type names of provided contexts.
- requested
string[]
- A list of full type names of requested contexts.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowed_request_extensions
Sequence[str]
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed_response_extensions
Sequence[str]
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
Sequence[str]
- A list of full type names of provided contexts.
- requested
Sequence[str]
- A list of full type names of requested contexts.
- selector
str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowedRequestExtensions
List<String>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowedResponseExtensions
List<String>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
List<String>
- A list of full type names of provided contexts.
- requested
List<String>
- A list of full type names of requested contexts.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
ContextRuleResponse, ContextRuleResponseArgs
A context rule provides information about the context for an individual API element.- AllowedRequestExtensions
List<string>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- AllowedResponseExtensions
List<string>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- Provided
List<string>
- A list of full type names of provided contexts.
- Requested
List<string>
- A list of full type names of requested contexts.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- AllowedRequestExtensions
[]string
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- AllowedResponseExtensions
[]string
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- Provided
[]string
- A list of full type names of provided contexts.
- Requested
[]string
- A list of full type names of requested contexts.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowed_request_extensions
list(string)
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed_response_extensions
list(string)
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
list(string)
- A list of full type names of provided contexts.
- requested
list(string)
- A list of full type names of requested contexts.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowedRequestExtensions
List<String>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowedResponseExtensions
List<String>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
List<String>
- A list of full type names of provided contexts.
- requested
List<String>
- A list of full type names of requested contexts.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowedRequestExtensions
string[]
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowedResponseExtensions
string[]
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
string[]
- A list of full type names of provided contexts.
- requested
string[]
- A list of full type names of requested contexts.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowed_request_extensions
Sequence[str]
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed_response_extensions
Sequence[str]
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
Sequence[str]
- A list of full type names of provided contexts.
- requested
Sequence[str]
- A list of full type names of requested contexts.
- selector
str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowedRequestExtensions
List<String>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowedResponseExtensions
List<String>
- A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided
List<String>
- A list of full type names of provided contexts.
- requested
List<String>
- A list of full type names of requested contexts.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
Control, ControlArgs
Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com- Environment
string
- 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
- MethodPolicies
[]MethodPolicy
- Defines policies applying to the API methods of the service.
- environment
string
- 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
- method_policies
list(object)
- Defines policies applying to the API methods of the service.
- environment
String
- 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
- methodPolicies
List<MethodPolicy>
- Defines policies applying to the API methods of the service.
- environment
string
- 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
- methodPolicies
MethodPolicy[]
- Defines policies applying to the API methods of the service.
- environment
str
- 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
- method_policies
Sequence[MethodPolicy]
- Defines policies applying to the API methods of the service.
- environment
String
- 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
- methodPolicies
List<Property Map>
- Defines policies applying to the API methods of the service.
ControlResponse, ControlResponseArgs
Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com- Environment
string
- 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
- MethodPolicies
[]MethodPolicyResponse
- Defines policies applying to the API methods of the service.
- environment
string
- 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
- method_policies
list(object)
- Defines policies applying to the API methods of the service.
- environment
String
- 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
- methodPolicies
List<MethodPolicyResponse>
- Defines policies applying to the API methods of the service.
- environment
string
- 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
- methodPolicies
MethodPolicyResponse[]
- Defines policies applying to the API methods of the service.
- environment
str
- 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
- method_policies
Sequence[MethodPolicyResponse]
- Defines policies applying to the API methods of the service.
- environment
String
- 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
- methodPolicies
List<Property Map>
- Defines policies applying to the API methods of the service.
CppSettings, CppSettingsArgs
Settings for C++ client libraries.CppSettingsResponse, CppSettingsResponseArgs
Settings for C++ client libraries.CustomError, CustomErrorArgs
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- Rules
[]CustomErrorRule
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- Types
[]string
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
list(object)
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
list(string)
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
List<CustomErrorRule>
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
List<String>
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
CustomErrorRule[]
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
string[]
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
Sequence[CustomErrorRule]
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
Sequence[str]
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
List<Property Map>
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
List<String>
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
CustomErrorResponse, CustomErrorResponseArgs
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- Rules
[]CustomErrorRuleResponse
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- Types
[]string
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
list(object)
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
list(string)
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
List<CustomErrorRuleResponse>
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
List<String>
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
CustomErrorRuleResponse[]
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
string[]
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
Sequence[CustomErrorRuleResponse]
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
Sequence[str]
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
List<Property Map>
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types
List<String>
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
CustomErrorRule, CustomErrorRuleArgs
A custom error rule.- IsErrorType
bool
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- Selector
string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- IsErrorType
bool
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- Selector
string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- is_error_type
bool
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- isErrorType
Boolean
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
String
- Selects messages to which this rule applies. Refer to selector for syntax details.
- isErrorType
boolean
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- is_error_type
bool
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
str
- Selects messages to which this rule applies. Refer to selector for syntax details.
- isErrorType
Boolean
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
String
- Selects messages to which this rule applies. Refer to selector for syntax details.
CustomErrorRuleResponse, CustomErrorRuleResponseArgs
A custom error rule.- IsErrorType
bool
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- Selector
string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- IsErrorType
bool
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- Selector
string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- is_error_type
bool
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- isErrorType
Boolean
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
String
- Selects messages to which this rule applies. Refer to selector for syntax details.
- isErrorType
boolean
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- is_error_type
bool
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
str
- Selects messages to which this rule applies. Refer to selector for syntax details.
- isErrorType
Boolean
- Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector
String
- Selects messages to which this rule applies. Refer to selector for syntax details.
CustomHttpPattern, CustomHttpPatternArgs
A custom pattern is used for defining custom HTTP verb.- Kind
string
- The name of this custom HTTP verb.
- Path
string
- The path matched by this custom verb.
- Kind
string
- The name of this custom HTTP verb.
- Path
string
- The path matched by this custom verb.
- kind
string
- The name of this custom HTTP verb.
- path
string
- The path matched by this custom verb.
- kind
String
- The name of this custom HTTP verb.
- path
String
- The path matched by this custom verb.
- kind
string
- The name of this custom HTTP verb.
- path
string
- The path matched by this custom verb.
- kind
str
- The name of this custom HTTP verb.
- path
str
- The path matched by this custom verb.
- kind
String
- The name of this custom HTTP verb.
- path
String
- The path matched by this custom verb.
CustomHttpPatternResponse, CustomHttpPatternResponseArgs
A custom pattern is used for defining custom HTTP verb.- Kind
string
- The name of this custom HTTP verb.
- Path
string
- The path matched by this custom verb.
- Kind
string
- The name of this custom HTTP verb.
- Path
string
- The path matched by this custom verb.
- kind
string
- The name of this custom HTTP verb.
- path
string
- The path matched by this custom verb.
- kind
String
- The name of this custom HTTP verb.
- path
String
- The path matched by this custom verb.
- kind
string
- The name of this custom HTTP verb.
- path
string
- The path matched by this custom verb.
- kind
str
- The name of this custom HTTP verb.
- path
str
- The path matched by this custom verb.
- kind
String
- The name of this custom HTTP verb.
- path
String
- The path matched by this custom verb.
Documentation, DocumentationArgs
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.- DocumentationRootUrl
string
- The URL to the root of documentation.
- Overview
string
- 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. - Pages
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Page>
- The top level pages for the documentation set.
- Rules
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.DocumentationRule>
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- SectionOverrides
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Page>
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- ServiceRootUrl
string
- 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.
- Summary
string
- 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.
- DocumentationRootUrl
string
- The URL to the root of documentation.
- Overview
string
- 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. - Pages
[]Page
- The top level pages for the documentation set.
- Rules
[]DocumentationRule
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- SectionOverrides
[]Page
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- ServiceRootUrl
string
- 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.
- Summary
string
- 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.
- documentation_root_url
string
- The URL to the root of documentation.
- overview
string
- 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. - pages
list(object)
- The top level pages for the documentation set.
- rules
list(object)
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- section_overrides
list(object)
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- service_root_url
string
- 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.
- summary
string
- 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.
- documentationRootUrl
String
- The URL to the root of documentation.
- overview
String
- 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. - pages
List<Page>
- The top level pages for the documentation set.
- rules
List<DocumentationRule>
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- sectionOverrides
List<Page>
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- serviceRootUrl
String
- 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.
- summary
String
- 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.
- documentationRootUrl
string
- The URL to the root of documentation.
- overview
string
- 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. - pages
Page[]
- The top level pages for the documentation set.
- rules
DocumentationRule[]
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- sectionOverrides
Page[]
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- serviceRootUrl
string
- 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.
- summary
string
- 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.
- documentation_root_url
str
- The URL to the root of documentation.
- overview
str
- 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. - pages
Sequence[Page]
- The top level pages for the documentation set.
- rules
Sequence[DocumentationRule]
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- section_overrides
Sequence[Page]
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- service_root_url
str
- 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.
- summary
str
- 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.
- documentationRootUrl
String
- The URL to the root of documentation.
- overview
String
- 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. - pages
List<Property Map>
- The top level pages for the documentation set.
- rules
List<Property Map>
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- sectionOverrides
List<Property Map>
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- serviceRootUrl
String
- 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.
- summary
String
- 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.
DocumentationResponse, DocumentationResponseArgs
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.- DocumentationRootUrl
string
- The URL to the root of documentation.
- Overview
string
- 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. - Pages
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.PageResponse>
- The top level pages for the documentation set.
- Rules
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.DocumentationRuleResponse>
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- SectionOverrides
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.PageResponse>
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- ServiceRootUrl
string
- 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.
- Summary
string
- 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.
- DocumentationRootUrl
string
- The URL to the root of documentation.
- Overview
string
- 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. - Pages
[]PageResponse
- The top level pages for the documentation set.
- Rules
[]DocumentationRuleResponse
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- SectionOverrides
[]PageResponse
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- ServiceRootUrl
string
- 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.
- Summary
string
- 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.
- documentation_root_url
string
- The URL to the root of documentation.
- overview
string
- 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. - pages
list(object)
- The top level pages for the documentation set.
- rules
list(object)
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- section_overrides
list(object)
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- service_root_url
string
- 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.
- summary
string
- 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.
- documentationRootUrl
String
- The URL to the root of documentation.
- overview
String
- 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. - pages
List<PageResponse>
- The top level pages for the documentation set.
- rules
List<DocumentationRuleResponse>
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- sectionOverrides
List<PageResponse>
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- serviceRootUrl
String
- 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.
- summary
String
- 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.
- documentationRootUrl
string
- The URL to the root of documentation.
- overview
string
- 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. - pages
PageResponse[]
- The top level pages for the documentation set.
- rules
DocumentationRuleResponse[]
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- sectionOverrides
PageResponse[]
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- serviceRootUrl
string
- 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.
- summary
string
- 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.
- documentation_root_url
str
- The URL to the root of documentation.
- overview
str
- 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. - pages
Sequence[PageResponse]
- The top level pages for the documentation set.
- rules
Sequence[DocumentationRuleResponse]
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- section_overrides
Sequence[PageResponse]
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- service_root_url
str
- 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.
- summary
str
- 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.
- documentationRootUrl
String
- The URL to the root of documentation.
- overview
String
- 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. - pages
List<Property Map>
- The top level pages for the documentation set.
- rules
List<Property Map>
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- sectionOverrides
List<Property Map>
- Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- serviceRootUrl
String
- 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.
- summary
String
- 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.
DocumentationRule, DocumentationRuleArgs
A documentation rule provides information about individual API elements.- DeprecationDescription
string
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - Description
string
- 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.
- DisableReplacementWords
string
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- Selector
string
- 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.
- DeprecationDescription
string
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - Description
string
- 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.
- DisableReplacementWords
string
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- Selector
string
- 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.
- deprecation_description
string
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
string
- 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.
- disable_replacement_words
string
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
string
- 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.
- deprecationDescription
String
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
String
- 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.
- disableReplacementWords
String
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
String
- 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.
- deprecationDescription
string
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
string
- 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.
- disableReplacementWords
string
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
string
- 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.
- deprecation_description
str
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
str
- 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.
- disable_replacement_words
str
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
str
- 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.
- deprecationDescription
String
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
String
- 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.
- disableReplacementWords
String
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
String
- 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.
DocumentationRuleResponse, DocumentationRuleResponseArgs
A documentation rule provides information about individual API elements.- DeprecationDescription
string
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - Description
string
- 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.
- DisableReplacementWords
string
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- Selector
string
- 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.
- DeprecationDescription
string
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - Description
string
- 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.
- DisableReplacementWords
string
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- Selector
string
- 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.
- deprecation_description
string
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
string
- 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.
- disable_replacement_words
string
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
string
- 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.
- deprecationDescription
String
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
String
- 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.
- disableReplacementWords
String
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
String
- 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.
- deprecationDescription
string
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
string
- 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.
- disableReplacementWords
string
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
string
- 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.
- deprecation_description
str
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
str
- 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.
- disable_replacement_words
str
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
str
- 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.
- deprecationDescription
String
- Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated. - description
String
- 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.
- disableReplacementWords
String
- String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector
String
- 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.
DotnetSettings, DotnetSettingsArgs
Settings for Dotnet client libraries.- Common
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CommonLanguageSettings
- Some settings.
- ForcedNamespaceAliases
List<string>
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- HandwrittenSignatures
List<string>
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- IgnoredResources
List<string>
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- RenamedResources
Dictionary<string, string>
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- RenamedServices
Dictionary<string, string>
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- Common
CommonLanguageSettings
- Some settings.
- ForcedNamespaceAliases
[]string
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- HandwrittenSignatures
[]string
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- IgnoredResources
[]string
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- RenamedResources
map[string]string
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- RenamedServices
map[string]string
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
object
- Some settings.
- forced_namespace_aliases
list(string)
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwritten_signatures
list(string)
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignored_resources
list(string)
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamed_resources
map(string)
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamed_services
map(string)
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
CommonLanguageSettings
- Some settings.
- forcedNamespaceAliases
List<String>
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwrittenSignatures
List<String>
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignoredResources
List<String>
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamedResources
Map<String,String>
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamedServices
Map<String,String>
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
CommonLanguageSettings
- Some settings.
- forcedNamespaceAliases
string[]
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwrittenSignatures
string[]
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignoredResources
string[]
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamedResources
{[key: string]: string}
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamedServices
{[key: string]: string}
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
CommonLanguageSettings
- Some settings.
- forced_namespace_aliases
Sequence[str]
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwritten_signatures
Sequence[str]
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignored_resources
Sequence[str]
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamed_resources
Mapping[str, str]
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamed_services
Mapping[str, str]
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
Property Map
- Some settings.
- forcedNamespaceAliases
List<String>
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwrittenSignatures
List<String>
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignoredResources
List<String>
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamedResources
Map<String>
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamedServices
Map<String>
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
DotnetSettingsResponse, DotnetSettingsResponseArgs
Settings for Dotnet client libraries.- Common
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CommonLanguageSettingsResponse
- Some settings.
- ForcedNamespaceAliases
List<string>
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- HandwrittenSignatures
List<string>
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- IgnoredResources
List<string>
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- RenamedResources
Dictionary<string, string>
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- RenamedServices
Dictionary<string, string>
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- Common
CommonLanguageSettingsResponse
- Some settings.
- ForcedNamespaceAliases
[]string
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- HandwrittenSignatures
[]string
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- IgnoredResources
[]string
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- RenamedResources
map[string]string
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- RenamedServices
map[string]string
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
object
- Some settings.
- forced_namespace_aliases
list(string)
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwritten_signatures
list(string)
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignored_resources
list(string)
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamed_resources
map(string)
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamed_services
map(string)
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
CommonLanguageSettingsResponse
- Some settings.
- forcedNamespaceAliases
List<String>
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwrittenSignatures
List<String>
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignoredResources
List<String>
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamedResources
Map<String,String>
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamedServices
Map<String,String>
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
CommonLanguageSettingsResponse
- Some settings.
- forcedNamespaceAliases
string[]
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwrittenSignatures
string[]
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignoredResources
string[]
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamedResources
{[key: string]: string}
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamedServices
{[key: string]: string}
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
CommonLanguageSettingsResponse
- Some settings.
- forced_namespace_aliases
Sequence[str]
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwritten_signatures
Sequence[str]
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignored_resources
Sequence[str]
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamed_resources
Mapping[str, str]
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamed_services
Mapping[str, str]
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
Property Map
- Some settings.
- forcedNamespaceAliases
List<String>
- Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwrittenSignatures
List<String>
- Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignoredResources
List<String>
- List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamedResources
Map<String>
- Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamedServices
Map<String>
- Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
Endpoint, EndpointArgs
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- Aliases
List<string>
- 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.
Deprecated: 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.
- AllowCors
bool
- Allowing CORS, 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.
- Name
string
- The canonical name of this endpoint.
- Target
string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- Aliases
[]string
- 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.
Deprecated: 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.
- AllowCors
bool
- Allowing CORS, 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.
- Name
string
- The canonical name of this endpoint.
- Target
string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
list(string)
- 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.
Deprecated: 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.
- allow_cors
bool
- Allowing CORS, 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.
- name
string
- The canonical name of this endpoint.
- target
string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
List<String>
- 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.
Deprecated: 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.
- allowCors
Boolean
- Allowing CORS, 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.
- name
String
- The canonical name of this endpoint.
- target
String
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
string[]
- 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.
Deprecated: 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.
- allowCors
boolean
- Allowing CORS, 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.
- name
string
- The canonical name of this endpoint.
- target
string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
Sequence[str]
- 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.
Deprecated: 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.
- allow_cors
bool
- Allowing CORS, 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.
- name
str
- The canonical name of this endpoint.
- target
str
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
List<String>
- 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.
Deprecated: 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.
- allowCors
Boolean
- Allowing CORS, 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.
- name
String
- The canonical name of this endpoint.
- target
String
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
EndpointResponse, EndpointResponseArgs
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- Aliases
List<string>
- 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.
Deprecated: 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.
- AllowCors
bool
- Allowing CORS, 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.
- Name
string
- The canonical name of this endpoint.
- Target
string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- Aliases
[]string
- 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.
Deprecated: 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.
- AllowCors
bool
- Allowing CORS, 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.
- Name
string
- The canonical name of this endpoint.
- Target
string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
list(string)
- 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.
Deprecated: 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.
- allow_cors
bool
- Allowing CORS, 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.
- name
string
- The canonical name of this endpoint.
- target
string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
List<String>
- 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.
Deprecated: 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.
- allowCors
Boolean
- Allowing CORS, 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.
- name
String
- The canonical name of this endpoint.
- target
String
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
string[]
- 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.
Deprecated: 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.
- allowCors
boolean
- Allowing CORS, 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.
- name
string
- The canonical name of this endpoint.
- target
string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
Sequence[str]
- 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.
Deprecated: 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.
- allow_cors
bool
- Allowing CORS, 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.
- name
str
- The canonical name of this endpoint.
- target
str
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases
List<String>
- 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.
Deprecated: 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.
- allowCors
Boolean
- Allowing CORS, 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.
- name
String
- The canonical name of this endpoint.
- target
String
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
Enum, EnumArgs
Enum type definition.EnumResponse, EnumResponseArgs
Enum type definition.EnumSyntax, EnumSyntaxArgs
The source syntax.| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| EnumSyntaxSyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| EnumSyntaxSyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| EnumSyntaxSyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Value | Description |
|---|
SYNTAX_PROTO2 | Syntax proto2. |
SYNTAX_PROTO3 | Syntax proto3. |
SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SYNTAX_PROTO2 | SYNTAX_PROTO2 | Syntax proto2. |
| SYNTAX_PROTO3 | SYNTAX_PROTO3 | Syntax proto3. |
| SYNTAX_EDITIONS | SYNTAX_EDITIONS | Syntax editions. |
| Value | Description |
|---|
SYNTAX_PROTO2 | Syntax proto2. |
SYNTAX_PROTO3 | Syntax proto3. |
SYNTAX_EDITIONS | Syntax editions. |
EnumValue, EnumValueArgs
Enum value definition.EnumValueResponse, EnumValueResponseArgs
Enum value definition.Field, FieldArgs
A single field of a message type.- Cardinality
FieldCardinality
- The field cardinality.
- DefaultValue
string
- The string value of the default value of this field. Proto2 syntax only.
- JsonName
string
- The field JSON name.
- Kind
FieldKind
- The field type.
- Name
string
- The field name.
- Number
int
- The field number.
- OneofIndex
int
- The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - Options
[]Option
- The protocol buffer options.
- Packed
bool
- Whether to use alternative packed wire representation.
- TypeUrl
string
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- cardinality
FieldCardinality
- The field cardinality.
- defaultValue
String
- The string value of the default value of this field. Proto2 syntax only.
- jsonName
String
- The field JSON name.
- kind
FieldKind
- The field type.
- name
String
- The field name.
- number
Integer
- The field number.
- oneofIndex
Integer
- The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - options
List<Option>
- The protocol buffer options.
- packed
Boolean
- Whether to use alternative packed wire representation.
- typeUrl
String
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- cardinality
FieldCardinality
- The field cardinality.
- defaultValue
string
- The string value of the default value of this field. Proto2 syntax only.
- jsonName
string
- The field JSON name.
- kind
FieldKind
- The field type.
- name
string
- The field name.
- number
number
- The field number.
- oneofIndex
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. - options
Option[]
- The protocol buffer options.
- packed
boolean
- Whether to use alternative packed wire representation.
- typeUrl
string
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- cardinality
FieldCardinality
- The field cardinality.
- default_value
str
- The string value of the default value of this field. Proto2 syntax only.
- json_name
str
- The field JSON name.
- kind
FieldKind
- The field type.
- name
str
- The field name.
- number
int
- The field number.
- oneof_index
int
- The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - options
Sequence[Option]
- The protocol buffer options.
- packed
bool
- Whether to use alternative packed wire representation.
- type_url
str
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
FieldCardinality, FieldCardinalityArgs
The field cardinality.| Name | Value | Description |
|---|
| CardinalityUnknown | CARDINALITY_UNKNOWN | For fields with unknown cardinality. |
| CardinalityOptional | CARDINALITY_OPTIONAL | For optional fields. |
| CardinalityRequired | CARDINALITY_REQUIRED | For required fields. Proto2 syntax only. |
| CardinalityRepeated | CARDINALITY_REPEATED | For repeated fields. |
| Name | Value | Description |
|---|
| FieldCardinalityCardinalityUnknown | CARDINALITY_UNKNOWN | For fields with unknown cardinality. |
| FieldCardinalityCardinalityOptional | CARDINALITY_OPTIONAL | For optional fields. |
| FieldCardinalityCardinalityRequired | CARDINALITY_REQUIRED | For required fields. Proto2 syntax only. |
| FieldCardinalityCardinalityRepeated | CARDINALITY_REPEATED | For repeated fields. |
| Value | Description |
|---|
CARDINALITY_UNKNOWN | For fields with unknown cardinality. |
CARDINALITY_OPTIONAL | For optional fields. |
CARDINALITY_REQUIRED | For required fields. Proto2 syntax only. |
CARDINALITY_REPEATED | For repeated fields. |
| Name | Value | Description |
|---|
| CardinalityUnknown | CARDINALITY_UNKNOWN | For fields with unknown cardinality. |
| CardinalityOptional | CARDINALITY_OPTIONAL | For optional fields. |
| CardinalityRequired | CARDINALITY_REQUIRED | For required fields. Proto2 syntax only. |
| CardinalityRepeated | CARDINALITY_REPEATED | For repeated fields. |
| Name | Value | Description |
|---|
| CardinalityUnknown | CARDINALITY_UNKNOWN | For fields with unknown cardinality. |
| CardinalityOptional | CARDINALITY_OPTIONAL | For optional fields. |
| CardinalityRequired | CARDINALITY_REQUIRED | For required fields. Proto2 syntax only. |
| CardinalityRepeated | CARDINALITY_REPEATED | For repeated fields. |
| Name | Value | Description |
|---|
| CARDINALITY_UNKNOWN | CARDINALITY_UNKNOWN | For fields with unknown cardinality. |
| CARDINALITY_OPTIONAL | CARDINALITY_OPTIONAL | For optional fields. |
| CARDINALITY_REQUIRED | CARDINALITY_REQUIRED | For required fields. Proto2 syntax only. |
| CARDINALITY_REPEATED | CARDINALITY_REPEATED | For repeated fields. |
| Value | Description |
|---|
CARDINALITY_UNKNOWN | For fields with unknown cardinality. |
CARDINALITY_OPTIONAL | For optional fields. |
CARDINALITY_REQUIRED | For required fields. Proto2 syntax only. |
CARDINALITY_REPEATED | For repeated fields. |
FieldKind, FieldKindArgs
The field type.| Name | Value | Description |
|---|
| TypeUnknown | TYPE_UNKNOWN | Field type unknown. |
| TypeDouble | TYPE_DOUBLE | Field type double. |
| TypeFloat | TYPE_FLOAT | Field type float. |
| TypeInt64 | TYPE_INT64 | Field type int64. |
| TypeUint64 | TYPE_UINT64 | Field type uint64. |
| TypeInt32 | TYPE_INT32 | Field type int32. |
| TypeFixed64 | TYPE_FIXED64 | Field type fixed64. |
| TypeFixed32 | TYPE_FIXED32 | Field type fixed32. |
| TypeBool | TYPE_BOOL | Field type bool. |
| TypeString | TYPE_STRING | Field type string. |
| TypeGroup | TYPE_GROUP | Field type group. Proto2 syntax only, and deprecated. |
| TypeMessage | TYPE_MESSAGE | Field type message. |
| TypeBytes | TYPE_BYTES | Field type bytes. |
| TypeUint32 | TYPE_UINT32 | Field type uint32. |
| TypeEnum | TYPE_ENUM | Field type enum. |
| TypeSfixed32 | TYPE_SFIXED32 | Field type sfixed32. |
| TypeSfixed64 | TYPE_SFIXED64 | Field type sfixed64. |
| TypeSint32 | TYPE_SINT32 | Field type sint32. |
| TypeSint64 | TYPE_SINT64 | Field type sint64. |
| Name | Value | Description |
|---|
| FieldKindTypeUnknown | TYPE_UNKNOWN | Field type unknown. |
| FieldKindTypeDouble | TYPE_DOUBLE | Field type double. |
| FieldKindTypeFloat | TYPE_FLOAT | Field type float. |
| FieldKindTypeInt64 | TYPE_INT64 | Field type int64. |
| FieldKindTypeUint64 | TYPE_UINT64 | Field type uint64. |
| FieldKindTypeInt32 | TYPE_INT32 | Field type int32. |
| FieldKindTypeFixed64 | TYPE_FIXED64 | Field type fixed64. |
| FieldKindTypeFixed32 | TYPE_FIXED32 | Field type fixed32. |
| FieldKindTypeBool | TYPE_BOOL | Field type bool. |
| FieldKindTypeString | TYPE_STRING | Field type string. |
| FieldKindTypeGroup | TYPE_GROUP | Field type group. Proto2 syntax only, and deprecated. |
| FieldKindTypeMessage | TYPE_MESSAGE | Field type message. |
| FieldKindTypeBytes | TYPE_BYTES | Field type bytes. |
| FieldKindTypeUint32 | TYPE_UINT32 | Field type uint32. |
| FieldKindTypeEnum | TYPE_ENUM | Field type enum. |
| FieldKindTypeSfixed32 | TYPE_SFIXED32 | Field type sfixed32. |
| FieldKindTypeSfixed64 | TYPE_SFIXED64 | Field type sfixed64. |
| FieldKindTypeSint32 | TYPE_SINT32 | Field type sint32. |
| FieldKindTypeSint64 | TYPE_SINT64 | Field type sint64. |
| Value | Description |
|---|
TYPE_UNKNOWN | Field type unknown. |
TYPE_DOUBLE | Field type double. |
TYPE_FLOAT | Field type float. |
TYPE_INT64 | Field type int64. |
TYPE_UINT64 | Field type uint64. |
TYPE_INT32 | Field type int32. |
TYPE_FIXED64 | Field type fixed64. |
TYPE_FIXED32 | Field type fixed32. |
TYPE_BOOL | Field type bool. |
TYPE_STRING | Field type string. |
TYPE_GROUP | Field type group. Proto2 syntax only, and deprecated. |
TYPE_MESSAGE | Field type message. |
TYPE_BYTES | Field type bytes. |
TYPE_UINT32 | Field type uint32. |
TYPE_ENUM | Field type enum. |
TYPE_SFIXED32 | Field type sfixed32. |
TYPE_SFIXED64 | Field type sfixed64. |
TYPE_SINT32 | Field type sint32. |
TYPE_SINT64 | Field type sint64. |
| Name | Value | Description |
|---|
| TypeUnknown | TYPE_UNKNOWN | Field type unknown. |
| TypeDouble | TYPE_DOUBLE | Field type double. |
| TypeFloat | TYPE_FLOAT | Field type float. |
| TypeInt64 | TYPE_INT64 | Field type int64. |
| TypeUint64 | TYPE_UINT64 | Field type uint64. |
| TypeInt32 | TYPE_INT32 | Field type int32. |
| TypeFixed64 | TYPE_FIXED64 | Field type fixed64. |
| TypeFixed32 | TYPE_FIXED32 | Field type fixed32. |
| TypeBool | TYPE_BOOL | Field type bool. |
| TypeString | TYPE_STRING | Field type string. |
| TypeGroup | TYPE_GROUP | Field type group. Proto2 syntax only, and deprecated. |
| TypeMessage | TYPE_MESSAGE | Field type message. |
| TypeBytes | TYPE_BYTES | Field type bytes. |
| TypeUint32 | TYPE_UINT32 | Field type uint32. |
| TypeEnum | TYPE_ENUM | Field type enum. |
| TypeSfixed32 | TYPE_SFIXED32 | Field type sfixed32. |
| TypeSfixed64 | TYPE_SFIXED64 | Field type sfixed64. |
| TypeSint32 | TYPE_SINT32 | Field type sint32. |
| TypeSint64 | TYPE_SINT64 | Field type sint64. |
| Name | Value | Description |
|---|
| TypeUnknown | TYPE_UNKNOWN | Field type unknown. |
| TypeDouble | TYPE_DOUBLE | Field type double. |
| TypeFloat | TYPE_FLOAT | Field type float. |
| TypeInt64 | TYPE_INT64 | Field type int64. |
| TypeUint64 | TYPE_UINT64 | Field type uint64. |
| TypeInt32 | TYPE_INT32 | Field type int32. |
| TypeFixed64 | TYPE_FIXED64 | Field type fixed64. |
| TypeFixed32 | TYPE_FIXED32 | Field type fixed32. |
| TypeBool | TYPE_BOOL | Field type bool. |
| TypeString | TYPE_STRING | Field type string. |
| TypeGroup | TYPE_GROUP | Field type group. Proto2 syntax only, and deprecated. |
| TypeMessage | TYPE_MESSAGE | Field type message. |
| TypeBytes | TYPE_BYTES | Field type bytes. |
| TypeUint32 | TYPE_UINT32 | Field type uint32. |
| TypeEnum | TYPE_ENUM | Field type enum. |
| TypeSfixed32 | TYPE_SFIXED32 | Field type sfixed32. |
| TypeSfixed64 | TYPE_SFIXED64 | Field type sfixed64. |
| TypeSint32 | TYPE_SINT32 | Field type sint32. |
| TypeSint64 | TYPE_SINT64 | Field type sint64. |
| Name | Value | Description |
|---|
| TYPE_UNKNOWN | TYPE_UNKNOWN | Field type unknown. |
| TYPE_DOUBLE | TYPE_DOUBLE | Field type double. |
| TYPE_FLOAT | TYPE_FLOAT | Field type float. |
| TYPE_INT64 | TYPE_INT64 | Field type int64. |
| TYPE_UINT64 | TYPE_UINT64 | Field type uint64. |
| TYPE_INT32 | TYPE_INT32 | Field type int32. |
| TYPE_FIXED64 | TYPE_FIXED64 | Field type fixed64. |
| TYPE_FIXED32 | TYPE_FIXED32 | Field type fixed32. |
| TYPE_BOOL | TYPE_BOOL | Field type bool. |
| TYPE_STRING | TYPE_STRING | Field type string. |
| TYPE_GROUP | TYPE_GROUP | Field type group. Proto2 syntax only, and deprecated. |
| TYPE_MESSAGE | TYPE_MESSAGE | Field type message. |
| TYPE_BYTES | TYPE_BYTES | Field type bytes. |
| TYPE_UINT32 | TYPE_UINT32 | Field type uint32. |
| TYPE_ENUM | TYPE_ENUM | Field type enum. |
| TYPE_SFIXED32 | TYPE_SFIXED32 | Field type sfixed32. |
| TYPE_SFIXED64 | TYPE_SFIXED64 | Field type sfixed64. |
| TYPE_SINT32 | TYPE_SINT32 | Field type sint32. |
| TYPE_SINT64 | TYPE_SINT64 | Field type sint64. |
| Value | Description |
|---|
TYPE_UNKNOWN | Field type unknown. |
TYPE_DOUBLE | Field type double. |
TYPE_FLOAT | Field type float. |
TYPE_INT64 | Field type int64. |
TYPE_UINT64 | Field type uint64. |
TYPE_INT32 | Field type int32. |
TYPE_FIXED64 | Field type fixed64. |
TYPE_FIXED32 | Field type fixed32. |
TYPE_BOOL | Field type bool. |
TYPE_STRING | Field type string. |
TYPE_GROUP | Field type group. Proto2 syntax only, and deprecated. |
TYPE_MESSAGE | Field type message. |
TYPE_BYTES | Field type bytes. |
TYPE_UINT32 | Field type uint32. |
TYPE_ENUM | Field type enum. |
TYPE_SFIXED32 | Field type sfixed32. |
TYPE_SFIXED64 | Field type sfixed64. |
TYPE_SINT32 | Field type sint32. |
TYPE_SINT64 | Field type sint64. |
FieldPolicy, FieldPolicyArgs
Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.- ResourcePermission
string
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- ResourceType
string
- Specifies the resource type for the resource referred to by the field.
- Selector
string
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- ResourcePermission
string
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- ResourceType
string
- Specifies the resource type for the resource referred to by the field.
- Selector
string
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resource_permission
string
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resource_type
string
- Specifies the resource type for the resource referred to by the field.
- selector
string
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resourcePermission
String
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resourceType
String
- Specifies the resource type for the resource referred to by the field.
- selector
String
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resourcePermission
string
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resourceType
string
- Specifies the resource type for the resource referred to by the field.
- selector
string
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resource_permission
str
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resource_type
str
- Specifies the resource type for the resource referred to by the field.
- selector
str
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resourcePermission
String
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resourceType
String
- Specifies the resource type for the resource referred to by the field.
- selector
String
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
FieldPolicyResponse, FieldPolicyResponseArgs
Google API Policy Annotation This message defines a simple API policy annotation that can be used to annotate API request and response message fields with applicable policies. One field may have multiple applicable policies that must all be satisfied before a request can be processed. This policy annotation is used to generate the overall policy that will be used for automatic runtime policy enforcement and documentation generation.- ResourcePermission
string
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- ResourceType
string
- Specifies the resource type for the resource referred to by the field.
- Selector
string
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- ResourcePermission
string
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- ResourceType
string
- Specifies the resource type for the resource referred to by the field.
- Selector
string
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resource_permission
string
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resource_type
string
- Specifies the resource type for the resource referred to by the field.
- selector
string
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resourcePermission
String
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resourceType
String
- Specifies the resource type for the resource referred to by the field.
- selector
String
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resourcePermission
string
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resourceType
string
- Specifies the resource type for the resource referred to by the field.
- selector
string
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resource_permission
str
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resource_type
str
- Specifies the resource type for the resource referred to by the field.
- selector
str
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resourcePermission
String
- Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resourceType
String
- Specifies the resource type for the resource referred to by the field.
- selector
String
- Selects one or more request or response message fields to apply this
FieldPolicy. When a FieldPolicy is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When a FieldPolicy is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
FieldResponse, FieldResponseArgs
A single field of a message type.- Cardinality
string
- The field cardinality.
- DefaultValue
string
- The string value of the default value of this field. Proto2 syntax only.
- JsonName
string
- The field JSON name.
- Kind
string
- The field type.
- Name
string
- The field name.
- Number
int
- The field number.
- OneofIndex
int
- The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - Options
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.OptionResponse>
- The protocol buffer options.
- Packed
bool
- Whether to use alternative packed wire representation.
- TypeUrl
string
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- Cardinality
string
- The field cardinality.
- DefaultValue
string
- The string value of the default value of this field. Proto2 syntax only.
- JsonName
string
- The field JSON name.
- Kind
string
- The field type.
- Name
string
- The field name.
- Number
int
- The field number.
- OneofIndex
int
- The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - Options
[]OptionResponse
- The protocol buffer options.
- Packed
bool
- Whether to use alternative packed wire representation.
- TypeUrl
string
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- cardinality
string
- The field cardinality.
- default_value
string
- The string value of the default value of this field. Proto2 syntax only.
- json_name
string
- The field JSON name.
- kind
string
- The field type.
- name
string
- The field name.
- number
number
- The field number.
- oneof_index
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. - options
list(object)
- The protocol buffer options.
- packed
bool
- Whether to use alternative packed wire representation.
- type_url
string
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- cardinality
String
- The field cardinality.
- defaultValue
String
- The string value of the default value of this field. Proto2 syntax only.
- jsonName
String
- The field JSON name.
- kind
String
- The field type.
- name
String
- The field name.
- number
Integer
- The field number.
- oneofIndex
Integer
- The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - options
List<OptionResponse>
- The protocol buffer options.
- packed
Boolean
- Whether to use alternative packed wire representation.
- typeUrl
String
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- cardinality
string
- The field cardinality.
- defaultValue
string
- The string value of the default value of this field. Proto2 syntax only.
- jsonName
string
- The field JSON name.
- kind
string
- The field type.
- name
string
- The field name.
- number
number
- The field number.
- oneofIndex
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. - options
OptionResponse[]
- The protocol buffer options.
- packed
boolean
- Whether to use alternative packed wire representation.
- typeUrl
string
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- cardinality
str
- The field cardinality.
- default_value
str
- The string value of the default value of this field. Proto2 syntax only.
- json_name
str
- The field JSON name.
- kind
str
- The field type.
- name
str
- The field name.
- number
int
- The field number.
- oneof_index
int
- The index of the field type in
Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - options
Sequence[OptionResponse]
- The protocol buffer options.
- packed
bool
- Whether to use alternative packed wire representation.
- type_url
str
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
- cardinality
String
- The field cardinality.
- defaultValue
String
- The string value of the default value of this field. Proto2 syntax only.
- jsonName
String
- The field JSON name.
- kind
String
- The field type.
- name
String
- The field name.
- number
Number
- The field number.
- oneofIndex
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. - options
List<Property Map>
- The protocol buffer options.
- packed
Boolean
- Whether to use alternative packed wire representation.
- typeUrl
String
- The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp".
GoSettings, GoSettingsArgs
Settings for Go client libraries.GoSettingsResponse, GoSettingsResponseArgs
Settings for Go client libraries.Http, HttpArgs
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.- FullyDecodeReservedExpansion
bool
- 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.
- Rules
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.HttpRule>
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- FullyDecodeReservedExpansion
bool
- 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.
- Rules
[]HttpRule
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully_decode_reserved_expansion
bool
- 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.
- rules
list(object)
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fullyDecodeReservedExpansion
Boolean
- 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.
- rules
List<HttpRule>
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fullyDecodeReservedExpansion
boolean
- 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.
- rules
HttpRule[]
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully_decode_reserved_expansion
bool
- 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.
- rules
Sequence[HttpRule]
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fullyDecodeReservedExpansion
Boolean
- 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.
- rules
List<Property Map>
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
HttpResponse, HttpResponseArgs
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.- FullyDecodeReservedExpansion
bool
- 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.
- Rules
[]HttpRuleResponse
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully_decode_reserved_expansion
bool
- 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.
- rules
list(object)
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fullyDecodeReservedExpansion
Boolean
- 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.
- rules
List<HttpRuleResponse>
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fullyDecodeReservedExpansion
boolean
- 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.
- rules
HttpRuleResponse[]
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully_decode_reserved_expansion
bool
- 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.
- rules
Sequence[HttpRuleResponse]
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fullyDecodeReservedExpansion
Boolean
- 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.
- rules
List<Property Map>
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
HttpRule, HttpRuleArgs
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, Cloud Endpoints, gRPC Gateway, and 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 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 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. While the single segment variable follows the semantics of RFC 6570 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.
- AdditionalBindings
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.HttpRule>
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - Body
string
- 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. - Custom
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CustomHttpPattern
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - Delete
string
- Maps to HTTP DELETE. Used for deleting a resource.
- Get
string
- Maps to HTTP GET. Used for listing and getting information about resources.
- Patch
string
- Maps to HTTP PATCH. Used for updating a resource.
- Post
string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- Put
string
- Maps to HTTP PUT. Used for replacing a resource.
- ResponseBody
string
- 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.
- Selector
string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- AdditionalBindings
[]HttpRule
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - Body
string
- 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. - Custom
CustomHttpPattern
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - Delete
string
- Maps to HTTP DELETE. Used for deleting a resource.
- Get
string
- Maps to HTTP GET. Used for listing and getting information about resources.
- Patch
string
- Maps to HTTP PATCH. Used for updating a resource.
- Post
string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- Put
string
- Maps to HTTP PUT. Used for replacing a resource.
- ResponseBody
string
- 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.
- Selector
string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additional_bindings
list(object)
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
string
- 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. - custom
object
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
string
- Maps to HTTP DELETE. Used for deleting a resource.
- get
string
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
string
- Maps to HTTP PATCH. Used for updating a resource.
- post
string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
string
- Maps to HTTP PUT. Used for replacing a resource.
- response_body
string
- 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.
- selector
string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additionalBindings
List<HttpRule>
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
String
- 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. - custom
CustomHttpPattern
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
String
- Maps to HTTP DELETE. Used for deleting a resource.
- get
String
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
String
- Maps to HTTP PATCH. Used for updating a resource.
- post
String
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
String
- Maps to HTTP PUT. Used for replacing a resource.
- responseBody
String
- 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.
- selector
String
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additionalBindings
HttpRule[]
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
string
- 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. - custom
CustomHttpPattern
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
string
- Maps to HTTP DELETE. Used for deleting a resource.
- get
string
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
string
- Maps to HTTP PATCH. Used for updating a resource.
- post
string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
string
- Maps to HTTP PUT. Used for replacing a resource.
- responseBody
string
- 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.
- selector
string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additional_bindings
Sequence[HttpRule]
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
str
- 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. - custom
CustomHttpPattern
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
str
- Maps to HTTP DELETE. Used for deleting a resource.
- get
str
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
str
- Maps to HTTP PATCH. Used for updating a resource.
- post
str
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
str
- Maps to HTTP PUT. Used for replacing a resource.
- response_body
str
- 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.
- selector
str
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additionalBindings
List<Property Map>
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
String
- 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. - custom
Property Map
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
String
- Maps to HTTP DELETE. Used for deleting a resource.
- get
String
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
String
- Maps to HTTP PATCH. Used for updating a resource.
- post
String
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
String
- Maps to HTTP PUT. Used for replacing a resource.
- responseBody
String
- 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.
- selector
String
- Selects a method to which this rule applies. Refer to selector for syntax details.
HttpRuleResponse, HttpRuleResponseArgs
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, Cloud Endpoints, gRPC Gateway, and 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 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 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. While the single segment variable follows the semantics of RFC 6570 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.
- AdditionalBindings
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.HttpRuleResponse>
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - Body
string
- 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. - Custom
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CustomHttpPatternResponse
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - Delete
string
- Maps to HTTP DELETE. Used for deleting a resource.
- Get
string
- Maps to HTTP GET. Used for listing and getting information about resources.
- Patch
string
- Maps to HTTP PATCH. Used for updating a resource.
- Post
string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- Put
string
- Maps to HTTP PUT. Used for replacing a resource.
- ResponseBody
string
- 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.
- Selector
string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- AdditionalBindings
[]HttpRuleResponse
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - Body
string
- 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. - Custom
CustomHttpPatternResponse
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - Delete
string
- Maps to HTTP DELETE. Used for deleting a resource.
- Get
string
- Maps to HTTP GET. Used for listing and getting information about resources.
- Patch
string
- Maps to HTTP PATCH. Used for updating a resource.
- Post
string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- Put
string
- Maps to HTTP PUT. Used for replacing a resource.
- ResponseBody
string
- 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.
- Selector
string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additional_bindings
list(object)
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
string
- 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. - custom
object
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
string
- Maps to HTTP DELETE. Used for deleting a resource.
- get
string
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
string
- Maps to HTTP PATCH. Used for updating a resource.
- post
string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
string
- Maps to HTTP PUT. Used for replacing a resource.
- response_body
string
- 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.
- selector
string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additionalBindings
List<HttpRuleResponse>
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
String
- 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. - custom
CustomHttpPatternResponse
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
String
- Maps to HTTP DELETE. Used for deleting a resource.
- get
String
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
String
- Maps to HTTP PATCH. Used for updating a resource.
- post
String
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
String
- Maps to HTTP PUT. Used for replacing a resource.
- responseBody
String
- 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.
- selector
String
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additionalBindings
HttpRuleResponse[]
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
string
- 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. - custom
CustomHttpPatternResponse
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
string
- Maps to HTTP DELETE. Used for deleting a resource.
- get
string
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
string
- Maps to HTTP PATCH. Used for updating a resource.
- post
string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
string
- Maps to HTTP PUT. Used for replacing a resource.
- responseBody
string
- 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.
- selector
string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additional_bindings
Sequence[HttpRuleResponse]
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
str
- 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. - custom
CustomHttpPatternResponse
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
str
- Maps to HTTP DELETE. Used for deleting a resource.
- get
str
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
str
- Maps to HTTP PATCH. Used for updating a resource.
- post
str
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
str
- Maps to HTTP PUT. Used for replacing a resource.
- response_body
str
- 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.
- selector
str
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additionalBindings
List<Property Map>
- Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings field themselves (that is, the nesting may only be one level deep). - body
String
- 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. - custom
Property Map
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete
String
- Maps to HTTP DELETE. Used for deleting a resource.
- get
String
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch
String
- Maps to HTTP PATCH. Used for updating a resource.
- post
String
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put
String
- Maps to HTTP PUT. Used for replacing a resource.
- responseBody
String
- 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.
- selector
String
- Selects a method to which this rule applies. Refer to selector for syntax details.
JavaSettings, JavaSettingsArgs
Settings for Java client libraries.- Common
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CommonLanguageSettings
- Some settings.
- LibraryPackage
string
- 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
- ServiceClassNames
Dictionary<string, string>
- 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
- Common
CommonLanguageSettings
- Some settings.
- LibraryPackage
string
- 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
- ServiceClassNames
map[string]string
- 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
- common
object
- Some settings.
- library_package
string
- 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
- service_class_names
map(string)
- 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
- common
CommonLanguageSettings
- Some settings.
- libraryPackage
String
- 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
- serviceClassNames
Map<String,String>
- 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
- common
CommonLanguageSettings
- Some settings.
- libraryPackage
string
- 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
- serviceClassNames
{[key: string]: string}
- 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
- common
CommonLanguageSettings
- Some settings.
- library_package
str
- 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
- service_class_names
Mapping[str, str]
- 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
- common
Property Map
- Some settings.
- libraryPackage
String
- 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
- serviceClassNames
Map<String>
- 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
JavaSettingsResponse, JavaSettingsResponseArgs
Settings for Java client libraries.- Common
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CommonLanguageSettingsResponse
- Some settings.
- LibraryPackage
string
- 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
- ServiceClassNames
Dictionary<string, string>
- 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
- Common
CommonLanguageSettingsResponse
- Some settings.
- LibraryPackage
string
- 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
- ServiceClassNames
map[string]string
- 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
- common
object
- Some settings.
- library_package
string
- 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
- service_class_names
map(string)
- 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
- common
CommonLanguageSettingsResponse
- Some settings.
- libraryPackage
String
- 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
- serviceClassNames
Map<String,String>
- 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
- common
CommonLanguageSettingsResponse
- Some settings.
- libraryPackage
string
- 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
- serviceClassNames
{[key: string]: string}
- 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
- common
CommonLanguageSettingsResponse
- Some settings.
- library_package
str
- 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
- service_class_names
Mapping[str, str]
- 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
- common
Property Map
- Some settings.
- libraryPackage
String
- 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
- serviceClassNames
Map<String>
- 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
JwtLocation, JwtLocationArgs
Specifies a location to extract JWT from an API request.- Cookie
string
- Specifies cookie name to extract JWT token.
-
string
- Specifies HTTP header name to extract JWT token.
- Query
string
- Specifies URL query parameter name to extract JWT token.
- ValuePrefix
string
- 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.
- Cookie
string
- Specifies cookie name to extract JWT token.
-
string
- Specifies HTTP header name to extract JWT token.
- Query
string
- Specifies URL query parameter name to extract JWT token.
- ValuePrefix
string
- 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.
- cookie
string
- Specifies cookie name to extract JWT token.
-
string
- Specifies HTTP header name to extract JWT token.
- query
string
- Specifies URL query parameter name to extract JWT token.
- value_prefix
string
- 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.
- cookie
String
- Specifies cookie name to extract JWT token.
-
String
- Specifies HTTP header name to extract JWT token.
- query
String
- Specifies URL query parameter name to extract JWT token.
- valuePrefix
String
- 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.
- cookie
string
- Specifies cookie name to extract JWT token.
-
string
- Specifies HTTP header name to extract JWT token.
- query
string
- Specifies URL query parameter name to extract JWT token.
- valuePrefix
string
- 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.
- cookie
str
- Specifies cookie name to extract JWT token.
-
str
- Specifies HTTP header name to extract JWT token.
- query
str
- Specifies URL query parameter name to extract JWT token.
- value_prefix
str
- 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.
- cookie
String
- Specifies cookie name to extract JWT token.
-
String
- Specifies HTTP header name to extract JWT token.
- query
String
- Specifies URL query parameter name to extract JWT token.
- valuePrefix
String
- 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.
JwtLocationResponse, JwtLocationResponseArgs
Specifies a location to extract JWT from an API request.- Cookie
string
- Specifies cookie name to extract JWT token.
-
string
- Specifies HTTP header name to extract JWT token.
- Query
string
- Specifies URL query parameter name to extract JWT token.
- ValuePrefix
string
- 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.
- Cookie
string
- Specifies cookie name to extract JWT token.
-
string
- Specifies HTTP header name to extract JWT token.
- Query
string
- Specifies URL query parameter name to extract JWT token.
- ValuePrefix
string
- 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.
- cookie
string
- Specifies cookie name to extract JWT token.
-
string
- Specifies HTTP header name to extract JWT token.
- query
string
- Specifies URL query parameter name to extract JWT token.
- value_prefix
string
- 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.
- cookie
String
- Specifies cookie name to extract JWT token.
-
String
- Specifies HTTP header name to extract JWT token.
- query
String
- Specifies URL query parameter name to extract JWT token.
- valuePrefix
String
- 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.
- cookie
string
- Specifies cookie name to extract JWT token.
-
string
- Specifies HTTP header name to extract JWT token.
- query
string
- Specifies URL query parameter name to extract JWT token.
- valuePrefix
string
- 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.
- cookie
str
- Specifies cookie name to extract JWT token.
-
str
- Specifies HTTP header name to extract JWT token.
- query
str
- Specifies URL query parameter name to extract JWT token.
- value_prefix
str
- 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.
- cookie
String
- Specifies cookie name to extract JWT token.
-
String
- Specifies HTTP header name to extract JWT token.
- query
String
- Specifies URL query parameter name to extract JWT token.
- valuePrefix
String
- 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.
LabelDescriptor, LabelDescriptorArgs
A description of a label.LabelDescriptorResponse, LabelDescriptorResponseArgs
A description of a label.- Description
string
- A human-readable description for the label.
- Key
string
- The label key.
- ValueType
string
- The type of data that can be assigned to the label.
- Description
string
- A human-readable description for the label.
- Key
string
- The label key.
- ValueType
string
- The type of data that can be assigned to the label.
- description
string
- A human-readable description for the label.
- key
string
- The label key.
- value_type
string
- The type of data that can be assigned to the label.
- description
String
- A human-readable description for the label.
- key
String
- The label key.
- valueType
String
- The type of data that can be assigned to the label.
- description
string
- A human-readable description for the label.
- key
string
- The label key.
- valueType
string
- The type of data that can be assigned to the label.
- description
str
- A human-readable description for the label.
- key
str
- The label key.
- value_type
str
- The type of data that can be assigned to the label.
- description
String
- A human-readable description for the label.
- key
String
- The label key.
- valueType
String
- The type of data that can be assigned to the label.
LabelDescriptorValueType, LabelDescriptorValueTypeArgs
The type of data that can be assigned to the label.| Name | Value | Description |
|---|
| String | STRING | A variable-length string. This is the default. |
| Bool | BOOL | Boolean; true or false. |
| Int64 | INT64 | A 64-bit signed integer. |
| Name | Value | Description |
|---|
| LabelDescriptorValueTypeString | STRING | A variable-length string. This is the default. |
| LabelDescriptorValueTypeBool | BOOL | Boolean; true or false. |
| LabelDescriptorValueTypeInt64 | INT64 | A 64-bit signed integer. |
| Value | Description |
|---|
STRING | A variable-length string. This is the default. |
BOOL | Boolean; true or false. |
INT64 | A 64-bit signed integer. |
| Name | Value | Description |
|---|
| String | STRING | A variable-length string. This is the default. |
| Bool | BOOL | Boolean; true or false. |
| Int64 | INT64 | A 64-bit signed integer. |
| Name | Value | Description |
|---|
| String | STRING | A variable-length string. This is the default. |
| Bool | BOOL | Boolean; true or false. |
| Int64 | INT64 | A 64-bit signed integer. |
| Name | Value | Description |
|---|
| STRING | STRING | A variable-length string. This is the default. |
| BOOL | BOOL | Boolean; true or false. |
| INT64 | INT64 | A 64-bit signed integer. |
| Value | Description |
|---|
STRING | A variable-length string. This is the default. |
BOOL | Boolean; true or false. |
INT64 | A 64-bit signed integer. |
LogDescriptor, LogDescriptorArgs
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- Description
string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- DisplayName
string
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Labels
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptor>
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- Name
string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- Description
string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- DisplayName
string
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Labels
[]LabelDescriptor
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- Name
string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- display_name
string
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
list(object)
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
String
- A human-readable description of this log. This information appears in the documentation and can contain details.
- displayName
String
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
List<LabelDescriptor>
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
String
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- displayName
string
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
LabelDescriptor[]
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
str
- A human-readable description of this log. This information appears in the documentation and can contain details.
- display_name
str
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
Sequence[LabelDescriptor]
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
str
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
String
- A human-readable description of this log. This information appears in the documentation and can contain details.
- displayName
String
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
List<Property Map>
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
String
- 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 [/_-.].
LogDescriptorResponse, LogDescriptorResponseArgs
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- Description
string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- DisplayName
string
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Labels
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptorResponse>
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- Name
string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- Description
string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- DisplayName
string
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Labels
[]LabelDescriptorResponse
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- Name
string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- display_name
string
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
list(object)
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
String
- A human-readable description of this log. This information appears in the documentation and can contain details.
- displayName
String
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
List<LabelDescriptorResponse>
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
String
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- displayName
string
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
LabelDescriptorResponse[]
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
str
- A human-readable description of this log. This information appears in the documentation and can contain details.
- display_name
str
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
Sequence[LabelDescriptorResponse]
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
str
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description
String
- A human-readable description of this log. This information appears in the documentation and can contain details.
- displayName
String
- The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
List<Property Map>
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name
String
- 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 [/_-.].
Logging, LoggingArgs
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- ConsumerDestinations
[]LoggingDestination
- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- ProducerDestinations
[]LoggingDestination
- 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.
- consumer_destinations
list(object)
- 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.
- producer_destinations
list(object)
- Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumerDestinations
List<LoggingDestination>
- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producerDestinations
List<LoggingDestination>
- Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumerDestinations
LoggingDestination[]
- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producerDestinations
LoggingDestination[]
- 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.
- consumer_destinations
Sequence[LoggingDestination]
- 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.
- producer_destinations
Sequence[LoggingDestination]
- Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumerDestinations
List<Property Map>
- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producerDestinations
List<Property Map>
- 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.
LoggingDestination, LoggingDestinationArgs
Configuration of a specific logging destination (the producer project or the consumer project).- Logs
List<string>
- 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 "/".
- MonitoredResource
string
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- Logs
[]string
- 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 "/".
- MonitoredResource
string
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
list(string)
- 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 "/".
- monitored_resource
string
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
List<String>
- 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 "/".
- monitoredResource
String
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
string[]
- 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 "/".
- monitoredResource
string
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
Sequence[str]
- 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 "/".
- monitored_resource
str
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
List<String>
- 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 "/".
- monitoredResource
String
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
LoggingDestinationResponse, LoggingDestinationResponseArgs
Configuration of a specific logging destination (the producer project or the consumer project).- Logs
List<string>
- 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 "/".
- MonitoredResource
string
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- Logs
[]string
- 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 "/".
- MonitoredResource
string
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
list(string)
- 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 "/".
- monitored_resource
string
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
List<String>
- 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 "/".
- monitoredResource
String
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
string[]
- 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 "/".
- monitoredResource
string
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
Sequence[str]
- 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 "/".
- monitored_resource
str
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs
List<String>
- 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 "/".
- monitoredResource
String
- The monitored resource type. The type must be defined in the Service.monitored_resources section.
LoggingResponse, LoggingResponseArgs
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- ConsumerDestinations
[]LoggingDestinationResponse
- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- ProducerDestinations
[]LoggingDestinationResponse
- 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.
- consumer_destinations
list(object)
- 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.
- producer_destinations
list(object)
- Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumerDestinations
List<LoggingDestinationResponse>
- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producerDestinations
List<LoggingDestinationResponse>
- Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumerDestinations
LoggingDestinationResponse[]
- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producerDestinations
LoggingDestinationResponse[]
- Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumerDestinations
List<Property Map>
- Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producerDestinations
List<Property Map>
- 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.
LongRunning, LongRunningArgs
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).- InitialPollDelay
string
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- MaxPollDelay
string
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- PollDelayMultiplier
double
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- TotalPollTimeout
string
- Total polling timeout. Default value: 5 minutes.
- InitialPollDelay
string
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- MaxPollDelay
string
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- PollDelayMultiplier
float64
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- TotalPollTimeout
string
- Total polling timeout. Default value: 5 minutes.
- initial_poll_delay
string
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- max_poll_delay
string
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- poll_delay_multiplier
number
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- total_poll_timeout
string
- Total polling timeout. Default value: 5 minutes.
- initialPollDelay
String
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- maxPollDelay
String
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- pollDelayMultiplier
Double
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- totalPollTimeout
String
- Total polling timeout. Default value: 5 minutes.
- initialPollDelay
string
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- maxPollDelay
string
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- pollDelayMultiplier
number
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- totalPollTimeout
string
- Total polling timeout. Default value: 5 minutes.
- initial_poll_delay
str
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- max_poll_delay
str
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- poll_delay_multiplier
float
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- total_poll_timeout
str
- Total polling timeout. Default value: 5 minutes.
- initialPollDelay
String
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- maxPollDelay
String
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- pollDelayMultiplier
Number
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- totalPollTimeout
String
- Total polling timeout. Default value: 5 minutes.
LongRunningResponse, LongRunningResponseArgs
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).- InitialPollDelay
string
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- MaxPollDelay
string
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- PollDelayMultiplier
double
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- TotalPollTimeout
string
- Total polling timeout. Default value: 5 minutes.
- InitialPollDelay
string
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- MaxPollDelay
string
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- PollDelayMultiplier
float64
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- TotalPollTimeout
string
- Total polling timeout. Default value: 5 minutes.
- initial_poll_delay
string
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- max_poll_delay
string
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- poll_delay_multiplier
number
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- total_poll_timeout
string
- Total polling timeout. Default value: 5 minutes.
- initialPollDelay
String
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- maxPollDelay
String
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- pollDelayMultiplier
Double
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- totalPollTimeout
String
- Total polling timeout. Default value: 5 minutes.
- initialPollDelay
string
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- maxPollDelay
string
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- pollDelayMultiplier
number
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- totalPollTimeout
string
- Total polling timeout. Default value: 5 minutes.
- initial_poll_delay
str
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- max_poll_delay
str
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- poll_delay_multiplier
float
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- total_poll_timeout
str
- Total polling timeout. Default value: 5 minutes.
- initialPollDelay
String
- Initial delay after which the first poll request will be made. Default value: 5 seconds.
- maxPollDelay
String
- Maximum time between two subsequent poll requests. Default value: 45 seconds.
- pollDelayMultiplier
Number
- Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- totalPollTimeout
String
- Total polling timeout. Default value: 5 minutes.
Method, MethodArgs
Method represents a method of an API interface.MethodPolicy, MethodPolicyArgs
Defines policies applying to an RPC method.- RequestPolicies
[]FieldPolicy
- Policies that are applicable to the request message.
- Selector
string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- request_policies
list(object)
- Policies that are applicable to the request message.
- selector
string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- requestPolicies
List<FieldPolicy>
- Policies that are applicable to the request message.
- selector
String
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- requestPolicies
FieldPolicy[]
- Policies that are applicable to the request message.
- selector
string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- request_policies
Sequence[FieldPolicy]
- Policies that are applicable to the request message.
- selector
str
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- requestPolicies
List<Property Map>
- Policies that are applicable to the request message.
- selector
String
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
MethodPolicyResponse, MethodPolicyResponseArgs
Defines policies applying to an RPC method.- RequestPolicies
[]FieldPolicyResponse
- Policies that are applicable to the request message.
- Selector
string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- request_policies
list(object)
- Policies that are applicable to the request message.
- selector
string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- requestPolicies
List<FieldPolicyResponse>
- Policies that are applicable to the request message.
- selector
String
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- requestPolicies
FieldPolicyResponse[]
- Policies that are applicable to the request message.
- selector
string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- request_policies
Sequence[FieldPolicyResponse]
- Policies that are applicable to the request message.
- selector
str
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- requestPolicies
List<Property Map>
- Policies that are applicable to the request message.
- selector
String
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
MethodResponse, MethodResponseArgs
Method represents a method of an API interface.MethodSettings, MethodSettingsArgs
Describes the generator configuration for a method.- LongRunning
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LongRunning
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- Selector
string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- LongRunning
LongRunning
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- Selector
string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- long_running
object
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- longRunning
LongRunning
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
String
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- longRunning
LongRunning
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- long_running
LongRunning
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
str
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- longRunning
Property Map
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
String
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
MethodSettingsResponse, MethodSettingsResponseArgs
Describes the generator configuration for a method.- LongRunning
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LongRunningResponse
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- Selector
string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- LongRunning
LongRunningResponse
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- Selector
string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- long_running
object
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- longRunning
LongRunningResponse
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
String
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- longRunning
LongRunningResponse
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- long_running
LongRunningResponse
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
str
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- longRunning
Property Map
- Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector
String
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
MethodSyntax, MethodSyntaxArgs
The source syntax of this method.| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| MethodSyntaxSyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| MethodSyntaxSyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| MethodSyntaxSyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Value | Description |
|---|
SYNTAX_PROTO2 | Syntax proto2. |
SYNTAX_PROTO3 | Syntax proto3. |
SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SYNTAX_PROTO2 | SYNTAX_PROTO2 | Syntax proto2. |
| SYNTAX_PROTO3 | SYNTAX_PROTO3 | Syntax proto3. |
| SYNTAX_EDITIONS | SYNTAX_EDITIONS | Syntax editions. |
| Value | Description |
|---|
SYNTAX_PROTO2 | Syntax proto2. |
SYNTAX_PROTO3 | Syntax proto3. |
SYNTAX_EDITIONS | Syntax editions. |
MetricDescriptor, MetricDescriptorArgs
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.- Description
string
- A detailed description of the metric, which can be used in documentation.
- DisplayName
string
- 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.
- Labels
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptor>
- 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. - LaunchStage
Pulumi.GoogleNative.ServiceManagement.V1.MetricDescriptorLaunchStage
- Optional. The launch stage of the metric definition.
- Metadata
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MetricDescriptorMetadata
- Optional. Metadata which can be used to guide usage of the metric.
- MetricKind
Pulumi.GoogleNative.ServiceManagement.V1.MetricDescriptorMetricKind
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - MonitoredResourceTypes
List<string>
- 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.
- Name
string
- The resource name of the metric descriptor.
- Type
string
- 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" - Unit
string
- 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 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 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"). - ValueType
Pulumi.GoogleNative.ServiceManagement.V1.MetricDescriptorValueType
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- Description
string
- A detailed description of the metric, which can be used in documentation.
- DisplayName
string
- 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.
- Labels
[]LabelDescriptor
- 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. - LaunchStage
MetricDescriptorLaunchStage
- Optional. The launch stage of the metric definition.
- Metadata
MetricDescriptorMetadata
- Optional. Metadata which can be used to guide usage of the metric.
- MetricKind
MetricDescriptorMetricKind
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - MonitoredResourceTypes
[]string
- 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.
- Name
string
- The resource name of the metric descriptor.
- Type
string
- 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" - Unit
string
- 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 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 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"). - ValueType
MetricDescriptorValueType
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
string
- A detailed description of the metric, which can be used in documentation.
- display_name
string
- 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.
- labels
list(object)
- 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. - launch_stage
"LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"
- Optional. The launch stage of the metric definition.
- metadata
object
- Optional. Metadata which can be used to guide usage of the metric.
- metric_kind
"METRIC_KIND_UNSPECIFIED" | "GAUGE" | "DELTA" | "CUMULATIVE"
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitored_resource_types
list(string)
- 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.
- name
string
- The resource name of the metric descriptor.
- type
string
- 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" - unit
string
- 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 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 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"). - value_type
"VALUE_TYPE_UNSPECIFIED" | "BOOL" | "INT64" | "DOUBLE" | "STRING" | "DISTRIBUTION" | "MONEY"
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
String
- A detailed description of the metric, which can be used in documentation.
- displayName
String
- 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.
- labels
List<LabelDescriptor>
- 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. - launchStage
MetricDescriptorLaunchStage
- Optional. The launch stage of the metric definition.
- metadata
MetricDescriptorMetadata
- Optional. Metadata which can be used to guide usage of the metric.
- metricKind
MetricDescriptorMetricKind
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitoredResourceTypes
List<String>
- 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.
- name
String
- The resource name of the metric descriptor.
- type
String
- 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" - unit
String
- 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 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 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"). - valueType
MetricDescriptorValueType
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
string
- A detailed description of the metric, which can be used in documentation.
- displayName
string
- 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.
- labels
LabelDescriptor[]
- 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. - launchStage
MetricDescriptorLaunchStage
- Optional. The launch stage of the metric definition.
- metadata
MetricDescriptorMetadata
- Optional. Metadata which can be used to guide usage of the metric.
- metricKind
MetricDescriptorMetricKind
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitoredResourceTypes
string[]
- 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.
- name
string
- The resource name of the metric descriptor.
- type
string
- 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" - unit
string
- 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 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 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"). - valueType
MetricDescriptorValueType
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
str
- A detailed description of the metric, which can be used in documentation.
- display_name
str
- 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.
- labels
Sequence[LabelDescriptor]
- 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. - launch_stage
MetricDescriptorLaunchStage
- Optional. The launch stage of the metric definition.
- metadata
MetricDescriptorMetadata
- Optional. Metadata which can be used to guide usage of the metric.
- metric_kind
MetricDescriptorMetricKind
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitored_resource_types
Sequence[str]
- 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.
- name
str
- The resource name of the metric descriptor.
- type
str
- 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" - unit
str
- 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 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 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"). - value_type
MetricDescriptorValueType
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
String
- A detailed description of the metric, which can be used in documentation.
- displayName
String
- 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.
- labels
List<Property Map>
- 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. - launchStage
"LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"
- Optional. The launch stage of the metric definition.
- metadata
Property Map
- Optional. Metadata which can be used to guide usage of the metric.
- metricKind
"METRIC_KIND_UNSPECIFIED" | "GAUGE" | "DELTA" | "CUMULATIVE"
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitoredResourceTypes
List<String>
- 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.
- name
String
- The resource name of the metric descriptor.
- type
String
- 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" - unit
String
- 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 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 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"). - valueType
"VALUE_TYPE_UNSPECIFIED" | "BOOL" | "INT64" | "DOUBLE" | "STRING" | "DISTRIBUTION" | "MONEY"
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
MetricDescriptorLaunchStage, MetricDescriptorLaunchStageArgs
Optional. The launch stage of the metric definition.| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| MetricDescriptorLaunchStageLaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| MetricDescriptorLaunchStageUnimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| MetricDescriptorLaunchStagePrelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| MetricDescriptorLaunchStageEarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| MetricDescriptorLaunchStageAlpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| MetricDescriptorLaunchStageBeta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| MetricDescriptorLaunchStageGa | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| MetricDescriptorLaunchStageDeprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Value | Description |
|---|
LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LAUNCH_STAGE_UNSPECIFIED | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| UNIMPLEMENTED | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| PRELAUNCH | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EARLY_ACCESS | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| ALPHA | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| BETA | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| GA | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| DEPRECATED | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Value | Description |
|---|
LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
Additional annotations that can be used to guide the usage of a metric.- IngestDelay
string
- 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.
- LaunchStage
Pulumi.GoogleNative.ServiceManagement.V1.MetricDescriptorMetadataLaunchStage
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- SamplePeriod
string
- 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.
- IngestDelay
string
- 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.
- LaunchStage
MetricDescriptorMetadataLaunchStage
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- SamplePeriod
string
- 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.
- ingestDelay
String
- 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.
- launchStage
MetricDescriptorMetadataLaunchStage
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- samplePeriod
String
- 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.
- ingestDelay
string
- 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.
- launchStage
MetricDescriptorMetadataLaunchStage
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- samplePeriod
string
- 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.
- ingest_delay
str
- 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.
- launch_stage
MetricDescriptorMetadataLaunchStage
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample_period
str
- 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.
Deprecated. Must use the MetricDescriptor.launch_stage instead.| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| MetricDescriptorMetadataLaunchStageLaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| MetricDescriptorMetadataLaunchStageUnimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| MetricDescriptorMetadataLaunchStagePrelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| MetricDescriptorMetadataLaunchStageEarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| MetricDescriptorMetadataLaunchStageAlpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| MetricDescriptorMetadataLaunchStageBeta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| MetricDescriptorMetadataLaunchStageGa | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| MetricDescriptorMetadataLaunchStageDeprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Value | Description |
|---|
LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LAUNCH_STAGE_UNSPECIFIED | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| UNIMPLEMENTED | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| PRELAUNCH | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EARLY_ACCESS | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| ALPHA | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| BETA | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| GA | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| DEPRECATED | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Value | Description |
|---|
LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
Additional annotations that can be used to guide the usage of a metric.- IngestDelay
string
- 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.
- LaunchStage
string
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- SamplePeriod
string
- 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.
- IngestDelay
string
- 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.
- LaunchStage
string
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- SamplePeriod
string
- 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.
- ingest_delay
string
- 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.
- launch_stage
string
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample_period
string
- 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.
- ingestDelay
String
- 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.
- launchStage
String
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- samplePeriod
String
- 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.
- ingestDelay
string
- 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.
- launchStage
string
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- samplePeriod
string
- 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.
- ingest_delay
str
- 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.
- launch_stage
str
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample_period
str
- 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.
- ingestDelay
String
- 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.
- launchStage
String
- Deprecated. Must use the MetricDescriptor.launch_stage instead.
Deprecated: Deprecated. Must use the MetricDescriptor.launch_stage instead.
- samplePeriod
String
- 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.
MetricDescriptorMetricKind, MetricDescriptorMetricKindArgs
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.| Name | Value | Description |
|---|
| MetricKindUnspecified | METRIC_KIND_UNSPECIFIED | Do not use this default value. |
| Gauge | GAUGE | An instantaneous measurement of a value. |
| Delta | DELTA | The change in a value during a time interval. |
| Cumulative | CUMULATIVE | A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. |
| Name | Value | Description |
|---|
| MetricDescriptorMetricKindMetricKindUnspecified | METRIC_KIND_UNSPECIFIED | Do not use this default value. |
| MetricDescriptorMetricKindGauge | GAUGE | An instantaneous measurement of a value. |
| MetricDescriptorMetricKindDelta | DELTA | The change in a value during a time interval. |
| MetricDescriptorMetricKindCumulative | CUMULATIVE | A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. |
| Value | Description |
|---|
METRIC_KIND_UNSPECIFIED | Do not use this default value. |
GAUGE | An instantaneous measurement of a value. |
DELTA | The change in a value during a time interval. |
CUMULATIVE | A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. |
| Name | Value | Description |
|---|
| MetricKindUnspecified | METRIC_KIND_UNSPECIFIED | Do not use this default value. |
| Gauge | GAUGE | An instantaneous measurement of a value. |
| Delta | DELTA | The change in a value during a time interval. |
| Cumulative | CUMULATIVE | A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. |
| Name | Value | Description |
|---|
| MetricKindUnspecified | METRIC_KIND_UNSPECIFIED | Do not use this default value. |
| Gauge | GAUGE | An instantaneous measurement of a value. |
| Delta | DELTA | The change in a value during a time interval. |
| Cumulative | CUMULATIVE | A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. |
| Name | Value | Description |
|---|
| METRIC_KIND_UNSPECIFIED | METRIC_KIND_UNSPECIFIED | Do not use this default value. |
| GAUGE | GAUGE | An instantaneous measurement of a value. |
| DELTA | DELTA | The change in a value during a time interval. |
| CUMULATIVE | CUMULATIVE | A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. |
| Value | Description |
|---|
METRIC_KIND_UNSPECIFIED | Do not use this default value. |
GAUGE | An instantaneous measurement of a value. |
DELTA | The change in a value during a time interval. |
CUMULATIVE | A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. |
MetricDescriptorResponse, MetricDescriptorResponseArgs
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.- Description
string
- A detailed description of the metric, which can be used in documentation.
- DisplayName
string
- 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.
- Labels
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptorResponse>
- 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. - LaunchStage
string
- Optional. The launch stage of the metric definition.
- Metadata
Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MetricDescriptorMetadataResponse
- Optional. Metadata which can be used to guide usage of the metric.
- MetricKind
string
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - MonitoredResourceTypes
List<string>
- 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.
- Name
string
- The resource name of the metric descriptor.
- Type
string
- 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" - Unit
string
- 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 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 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"). - ValueType
string
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- Description
string
- A detailed description of the metric, which can be used in documentation.
- DisplayName
string
- 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.
- Labels
[]LabelDescriptorResponse
- 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. - LaunchStage
string
- Optional. The launch stage of the metric definition.
- Metadata
MetricDescriptorMetadataResponse
- Optional. Metadata which can be used to guide usage of the metric.
- MetricKind
string
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - MonitoredResourceTypes
[]string
- 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.
- Name
string
- The resource name of the metric descriptor.
- Type
string
- 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" - Unit
string
- 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 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 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"). - ValueType
string
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
string
- A detailed description of the metric, which can be used in documentation.
- display_name
string
- 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.
- labels
list(object)
- 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. - launch_stage
string
- Optional. The launch stage of the metric definition.
- metadata
object
- Optional. Metadata which can be used to guide usage of the metric.
- metric_kind
string
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitored_resource_types
list(string)
- 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.
- name
string
- The resource name of the metric descriptor.
- type
string
- 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" - unit
string
- 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 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 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"). - value_type
string
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
String
- A detailed description of the metric, which can be used in documentation.
- displayName
String
- 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.
- labels
List<LabelDescriptorResponse>
- 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. - launchStage
String
- Optional. The launch stage of the metric definition.
- metadata
MetricDescriptorMetadataResponse
- Optional. Metadata which can be used to guide usage of the metric.
- metricKind
String
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitoredResourceTypes
List<String>
- 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.
- name
String
- The resource name of the metric descriptor.
- type
String
- 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" - unit
String
- 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 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 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"). - valueType
String
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
string
- A detailed description of the metric, which can be used in documentation.
- displayName
string
- 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.
- labels
LabelDescriptorResponse[]
- 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. - launchStage
string
- Optional. The launch stage of the metric definition.
- metadata
MetricDescriptorMetadataResponse
- Optional. Metadata which can be used to guide usage of the metric.
- metricKind
string
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitoredResourceTypes
string[]
- 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.
- name
string
- The resource name of the metric descriptor.
- type
string
- 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" - unit
string
- 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 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 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"). - valueType
string
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
str
- A detailed description of the metric, which can be used in documentation.
- display_name
str
- 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.
- labels
Sequence[LabelDescriptorResponse]
- 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. - launch_stage
str
- Optional. The launch stage of the metric definition.
- metadata
MetricDescriptorMetadataResponse
- Optional. Metadata which can be used to guide usage of the metric.
- metric_kind
str
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitored_resource_types
Sequence[str]
- 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.
- name
str
- The resource name of the metric descriptor.
- type
str
- 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" - unit
str
- 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 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 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"). - value_type
str
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
- description
String
- A detailed description of the metric, which can be used in documentation.
- displayName
String
- 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.
- labels
List<Property Map>
- 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. - launchStage
String
- Optional. The launch stage of the metric definition.
- metadata
Property Map
- Optional. Metadata which can be used to guide usage of the metric.
- metricKind
String
- Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind and value_type might not be supported. - monitoredResourceTypes
List<String>
- 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.
- name
String
- The resource name of the metric descriptor.
- type
String
- 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" - unit
String
- 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 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 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"). - valueType
String
- Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind and value_type might not be supported.
MetricDescriptorValueType, MetricDescriptorValueTypeArgs
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.| Name | Value | Description |
|---|
| ValueTypeUnspecified | VALUE_TYPE_UNSPECIFIED | Do not use this default value. |
| Bool | BOOL | The value is a boolean. This value type can be used only if the metric kind is GAUGE. |
| Int64 | INT64 | The value is a signed 64-bit integer. |
| Double | DOUBLE | The value is a double precision floating point number. |
| String | STRING | The value is a text string. This value type can be used only if the metric kind is GAUGE. |
| Distribution | DISTRIBUTION | The value is a Distribution. |
| Money | MONEY | The value is money. |
| Name | Value | Description |
|---|
| MetricDescriptorValueTypeValueTypeUnspecified | VALUE_TYPE_UNSPECIFIED | Do not use this default value. |
| MetricDescriptorValueTypeBool | BOOL | The value is a boolean. This value type can be used only if the metric kind is GAUGE. |
| MetricDescriptorValueTypeInt64 | INT64 | The value is a signed 64-bit integer. |
| MetricDescriptorValueTypeDouble | DOUBLE | The value is a double precision floating point number. |
| MetricDescriptorValueTypeString | STRING | The value is a text string. This value type can be used only if the metric kind is GAUGE. |
| MetricDescriptorValueTypeDistribution | DISTRIBUTION | The value is a Distribution. |
| MetricDescriptorValueTypeMoney | MONEY | The value is money. |
| Value | Description |
|---|
VALUE_TYPE_UNSPECIFIED | Do not use this default value. |
BOOL | The value is a boolean. This value type can be used only if the metric kind is GAUGE. |
INT64 | The value is a signed 64-bit integer. |
DOUBLE | The value is a double precision floating point number. |
STRING | The value is a text string. This value type can be used only if the metric kind is GAUGE. |
DISTRIBUTION | The value is a Distribution. |
MONEY | The value is money. |
| Name | Value | Description |
|---|
| ValueTypeUnspecified | VALUE_TYPE_UNSPECIFIED | Do not use this default value. |
| Bool | BOOL | The value is a boolean. This value type can be used only if the metric kind is GAUGE. |
| Int64 | INT64 | The value is a signed 64-bit integer. |
| Double | DOUBLE | The value is a double precision floating point number. |
| String | STRING | The value is a text string. This value type can be used only if the metric kind is GAUGE. |
| Distribution | DISTRIBUTION | The value is a Distribution. |
| Money | MONEY | The value is money. |
| Name | Value | Description |
|---|
| ValueTypeUnspecified | VALUE_TYPE_UNSPECIFIED | Do not use this default value. |
| Bool | BOOL | The value is a boolean. This value type can be used only if the metric kind is GAUGE. |
| Int64 | INT64 | The value is a signed 64-bit integer. |
| Double | DOUBLE | The value is a double precision floating point number. |
| String | STRING | The value is a text string. This value type can be used only if the metric kind is GAUGE. |
| Distribution | DISTRIBUTION | The value is a Distribution. |
| Money | MONEY | The value is money. |
| Name | Value | Description |
|---|
| VALUE_TYPE_UNSPECIFIED | VALUE_TYPE_UNSPECIFIED | Do not use this default value. |
| BOOL | BOOL | The value is a boolean. This value type can be used only if the metric kind is GAUGE. |
| INT64 | INT64 | The value is a signed 64-bit integer. |
| DOUBLE | DOUBLE | The value is a double precision floating point number. |
| STRING | STRING | The value is a text string. This value type can be used only if the metric kind is GAUGE. |
| DISTRIBUTION | DISTRIBUTION | The value is a Distribution. |
| MONEY | MONEY | The value is money. |
| Value | Description |
|---|
VALUE_TYPE_UNSPECIFIED | Do not use this default value. |
BOOL | The value is a boolean. This value type can be used only if the metric kind is GAUGE. |
INT64 | The value is a signed 64-bit integer. |
DOUBLE | The value is a double precision floating point number. |
STRING | The value is a text string. This value type can be used only if the metric kind is GAUGE. |
DISTRIBUTION | The value is a Distribution. |
MONEY | The value is money. |
MetricRule, MetricRuleArgs
Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.- MetricCosts
Dictionary<string, string>
- 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.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- MetricCosts
map[string]string
- 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.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metric_costs
map(string)
- 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.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metricCosts
Map<String,String>
- 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.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metricCosts
{[key: string]: string}
- 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.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metric_costs
Mapping[str, str]
- 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.
- selector
str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metricCosts
Map<String>
- 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.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
MetricRuleResponse, MetricRuleResponseArgs
Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.- MetricCosts
Dictionary<string, string>
- 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.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- MetricCosts
map[string]string
- 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.
- Selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metric_costs
map(string)
- 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.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metricCosts
Map<String,String>
- 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.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metricCosts
{[key: string]: string}
- 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.
- selector
string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metric_costs
Mapping[str, str]
- 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.
- selector
str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metricCosts
Map<String>
- 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.
- selector
String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
Mixin, MixinArgs
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"; } ... }- Name
string
- The fully qualified name of the interface which is included.
- Root
string
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- Name
string
- The fully qualified name of the interface which is included.
- Root
string
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
string
- The fully qualified name of the interface which is included.
- root
string
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
String
- The fully qualified name of the interface which is included.
- root
String
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
string
- The fully qualified name of the interface which is included.
- root
string
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
str
- The fully qualified name of the interface which is included.
- root
str
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
String
- The fully qualified name of the interface which is included.
- root
String
- If non-empty specifies a path under which inherited HTTP paths are rooted.
MixinResponse, MixinResponseArgs
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"; } ... }- Name
string
- The fully qualified name of the interface which is included.
- Root
string
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- Name
string
- The fully qualified name of the interface which is included.
- Root
string
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
string
- The fully qualified name of the interface which is included.
- root
string
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
String
- The fully qualified name of the interface which is included.
- root
String
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
string
- The fully qualified name of the interface which is included.
- root
string
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
str
- The fully qualified name of the interface which is included.
- root
str
- If non-empty specifies a path under which inherited HTTP paths are rooted.
- name
String
- The fully qualified name of the interface which is included.
- root
String
- If non-empty specifies a path under which inherited HTTP paths are rooted.
MonitoredResourceDescriptor, MonitoredResourceDescriptorArgs
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.- Labels
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptor>
- 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". - Type
string
- 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 and Logging resource types. - Description
string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- DisplayName
string
- 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". - LaunchStage
Pulumi.GoogleNative.ServiceManagement.V1.MonitoredResourceDescriptorLaunchStage
- Optional. The launch stage of the monitored resource definition.
- Name
string
- 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}".
- Labels
[]LabelDescriptor
- 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". - Type
string
- 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 and Logging resource types. - Description
string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- DisplayName
string
- 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". - LaunchStage
MonitoredResourceDescriptorLaunchStage
- Optional. The launch stage of the monitored resource definition.
- Name
string
- 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}".
- labels
list(object)
- 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". - type
string
- 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 and Logging resource types. - description
string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- display_name
string
- 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". - launch_stage
"LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"
- Optional. The launch stage of the monitored resource definition.
- name
string
- 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}".
- labels
List<LabelDescriptor>
- 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". - type
String
- 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 and Logging resource types. - description
String
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- displayName
String
- 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". - launchStage
MonitoredResourceDescriptorLaunchStage
- Optional. The launch stage of the monitored resource definition.
- name
String
- 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}".
- labels
LabelDescriptor[]
- 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". - type
string
- 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 and Logging resource types. - description
string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- displayName
string
- 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". - launchStage
MonitoredResourceDescriptorLaunchStage
- Optional. The launch stage of the monitored resource definition.
- name
string
- 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}".
- labels
Sequence[LabelDescriptor]
- 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". - type
str
- 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 and Logging resource types. - description
str
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- display_name
str
- 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". - launch_stage
MonitoredResourceDescriptorLaunchStage
- Optional. The launch stage of the monitored resource definition.
- name
str
- 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}".
- labels
List<Property Map>
- 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". - type
String
- 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 and Logging resource types. - description
String
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- displayName
String
- 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". - launchStage
"LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"
- Optional. The launch stage of the monitored resource definition.
- name
String
- 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}".
MonitoredResourceDescriptorLaunchStage, MonitoredResourceDescriptorLaunchStageArgs
Optional. The launch stage of the monitored resource definition.| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| MonitoredResourceDescriptorLaunchStageLaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| MonitoredResourceDescriptorLaunchStageUnimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| MonitoredResourceDescriptorLaunchStagePrelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| MonitoredResourceDescriptorLaunchStageEarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| MonitoredResourceDescriptorLaunchStageAlpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| MonitoredResourceDescriptorLaunchStageBeta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| MonitoredResourceDescriptorLaunchStageGa | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| MonitoredResourceDescriptorLaunchStageDeprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Value | Description |
|---|
LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LaunchStageUnspecified | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| Unimplemented | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| Prelaunch | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EarlyAccess | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| Alpha | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| Beta | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| Ga | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| Deprecated | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Name | Value | Description |
|---|
| LAUNCH_STAGE_UNSPECIFIED | LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
| UNIMPLEMENTED | UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
| PRELAUNCH | PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
| EARLY_ACCESS | EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
| ALPHA | ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
| BETA | BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
| GA | GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
| DEPRECATED | DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
| Value | Description |
|---|
LAUNCH_STAGE_UNSPECIFIED | Do not use this default value. |
UNIMPLEMENTED | The feature is not yet implemented. Users can not use it. |
PRELAUNCH | Prelaunch features are hidden from users and are only visible internally. |
EARLY_ACCESS | Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. |
ALPHA | Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. |
BETA | Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. |
GA | GA features are open to all developers and are considered stable and fully qualified for production use. |
DEPRECATED | Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation. |
MonitoredResourceDescriptorResponse, MonitoredResourceDescriptorResponseArgs
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.- Description
string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- DisplayName
string
- 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". - Labels
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptorResponse>
- 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". - LaunchStage
string
- Optional. The launch stage of the monitored resource definition.
- Name
string
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". - Type
string
- 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 and Logging resource types.
- Description
string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- DisplayName
string
- 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". - Labels
[]LabelDescriptorResponse
- 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". - LaunchStage
string
- Optional. The launch stage of the monitored resource definition.
- Name
string
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". - Type
string
- 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 and Logging resource types.
- description
string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- display_name
string
- 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". - labels
list(object)
- 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". - launch_stage
string
- Optional. The launch stage of the monitored resource definition.
- name
string
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". - type
string
- 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 and Logging resource types.
- description
String
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- displayName
String
- 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". - labels
List<LabelDescriptorResponse>
- 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". - launchStage
String
- Optional. The launch stage of the monitored resource definition.
- name
String
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". - type
String
- 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 and Logging resource types.
- description
string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- displayName
string
- 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". - labels
LabelDescriptorResponse[]
- 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". - launchStage
string
- Optional. The launch stage of the monitored resource definition.
- name
string
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". - type
string
- 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 and Logging resource types.
- description
str
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- display_name
str
- 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". - labels
Sequence[LabelDescriptorResponse]
- 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". - launch_stage
str
- Optional. The launch stage of the monitored resource definition.
- name
str
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". - type
str
- 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 and Logging resource types.
- description
String
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- displayName
String
- 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". - labels
List<Property Map>
- 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". - launchStage
String
- Optional. The launch stage of the monitored resource definition.
- name
String
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". - type
String
- 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 and Logging resource types.
Monitoring, MonitoringArgs
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- ConsumerDestinations
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MonitoringDestination>
- 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.
- ProducerDestinations
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MonitoringDestination>
- 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.
- ConsumerDestinations
[]MonitoringDestination
- 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.
- ProducerDestinations
[]MonitoringDestination
- 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.
- consumer_destinations
list(object)
- 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.
- producer_destinations
list(object)
- 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.
- consumerDestinations
List<MonitoringDestination>
- 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.
- producerDestinations
List<MonitoringDestination>
- 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.
- consumerDestinations
MonitoringDestination[]
- 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.
- producerDestinations
MonitoringDestination[]
- 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.
- consumer_destinations
Sequence[MonitoringDestination]
- 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.
- producer_destinations
Sequence[MonitoringDestination]
- 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.
- consumerDestinations
List<Property Map>
- 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.
- producerDestinations
List<Property Map>
- 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.
MonitoringDestination, MonitoringDestinationArgs
Configuration of a specific monitoring destination (the producer project or the consumer project).- Metrics
List<string>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- MonitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- Metrics
[]string
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- MonitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
list(string)
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitored_resource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
List<String>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitoredResource
String
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
string[]
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
Sequence[str]
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitored_resource
str
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
List<String>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitoredResource
String
- The monitored resource type. The type must be defined in Service.monitored_resources section.
MonitoringDestinationResponse, MonitoringDestinationResponseArgs
Configuration of a specific monitoring destination (the producer project or the consumer project).- Metrics
List<string>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- MonitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- Metrics
[]string
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- MonitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
list(string)
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitored_resource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
List<String>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitoredResource
String
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
string[]
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitoredResource
string
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
Sequence[str]
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitored_resource
str
- The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics
List<String>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitoredResource
String
- The monitored resource type. The type must be defined in Service.monitored_resources section.
MonitoringResponse, MonitoringResponseArgs
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- ConsumerDestinations
[]MonitoringDestinationResponse
- 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.
- ProducerDestinations
[]MonitoringDestinationResponse
- 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.
- consumer_destinations
list(object)
- 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.
- producer_destinations
list(object)
- 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.
- consumerDestinations
List<MonitoringDestinationResponse>
- 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.
- producerDestinations
List<MonitoringDestinationResponse>
- 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.
- consumerDestinations
MonitoringDestinationResponse[]
- 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.
- producerDestinations
MonitoringDestinationResponse[]
- 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.
- consumer_destinations
Sequence[MonitoringDestinationResponse]
- 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.
- producer_destinations
Sequence[MonitoringDestinationResponse]
- 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.
- consumerDestinations
List<Property Map>
- 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.
- producerDestinations
List<Property Map>
- 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.
NodeSettings, NodeSettingsArgs
Settings for Node client libraries.NodeSettingsResponse, NodeSettingsResponseArgs
Settings for Node client libraries.OAuthRequirements, OAuthRequirementsArgs
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.- CanonicalScopes
string
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- CanonicalScopes
string
- 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
- canonical_scopes
string
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonicalScopes
String
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonicalScopes
string
- 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
- canonical_scopes
str
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonicalScopes
String
- 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
OAuthRequirementsResponse, OAuthRequirementsResponseArgs
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.- CanonicalScopes
string
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- CanonicalScopes
string
- 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
- canonical_scopes
string
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonicalScopes
String
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonicalScopes
string
- 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
- canonical_scopes
str
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonicalScopes
String
- 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
Option, OptionArgs
A protocol buffer option, which can be attached to a message, field, enumeration, etc.- Name
string
- 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". - Value
Dictionary<string, string>
- 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.
- Name
string
- 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". - Value
map[string]string
- 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.
- name
string
- 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". - value
map(string)
- 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.
- name
String
- 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". - value
Map<String,String>
- 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.
- name
string
- 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". - value
{[key: string]: string}
- 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.
- name
str
- 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". - value
Mapping[str, str]
- 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.
- name
String
- 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". - value
Map<String>
- 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.
OptionResponse, OptionResponseArgs
A protocol buffer option, which can be attached to a message, field, enumeration, etc.- Name
string
- 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". - Value
Dictionary<string, string>
- 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.
- Name
string
- 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". - Value
map[string]string
- 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.
- name
string
- 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". - value
map(string)
- 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.
- name
String
- 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". - value
Map<String,String>
- 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.
- name
string
- 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". - value
{[key: string]: string}
- 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.
- name
str
- 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". - value
Mapping[str, str]
- 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.
- name
String
- 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". - value
Map<String>
- 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.
Page, PageArgs
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.- Content
string
- 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.
- Name
string
- 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. - Subpages
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Page>
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- Content
string
- 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.
- Name
string
- 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. - Subpages
[]Page
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
string
- 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.
- name
string
- 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. - subpages
list(object)
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
String
- 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.
- name
String
- 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. - subpages
List<Page>
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
string
- 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.
- name
string
- 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. - subpages
Page[]
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
str
- 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.
- name
str
- 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. - subpages
Sequence[Page]
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
String
- 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.
- name
String
- 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. - subpages
List<Property Map>
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.- Content
string
- 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.
- Name
string
- 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. - Subpages
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.PageResponse>
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- Content
string
- 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.
- Name
string
- 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. - Subpages
[]PageResponse
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
string
- 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.
- name
string
- 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. - subpages
list(object)
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
String
- 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.
- name
String
- 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. - subpages
List<PageResponse>
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
string
- 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.
- name
string
- 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. - subpages
PageResponse[]
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
str
- 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.
- name
str
- 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. - subpages
Sequence[PageResponse]
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content
String
- 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.
- name
String
- 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. - subpages
List<Property Map>
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
PhpSettings, PhpSettingsArgs
Settings for Php client libraries.PhpSettingsResponse, PhpSettingsResponseArgs
Settings for Php client libraries.Publishing, PublishingArgs
This message configures the settings for publishing Google Cloud Client libraries generated from the service config.- ApiShortName
string
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- CodeownerGithubTeams
[]string
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- DocTagPrefix
string
- A prefix used in sample code when demarking regions to be included in documentation.
- DocumentationUri
string
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- GithubLabel
string
- GitHub label to apply to issues and pull requests opened for this API.
- LibrarySettings
[]ClientLibrarySettings
- 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.
- MethodSettings
[]MethodSettings
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- NewIssueUri
string
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- Organization
PublishingOrganization
- For whom the client library is being published.
- ProtoReferenceDocumentationUri
string
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- apiShortName
String
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeownerGithubTeams
List<String>
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- docTagPrefix
String
- A prefix used in sample code when demarking regions to be included in documentation.
- documentationUri
String
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- githubLabel
String
- GitHub label to apply to issues and pull requests opened for this API.
- librarySettings
List<ClientLibrarySettings>
- 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.
- methodSettings
List<MethodSettings>
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- newIssueUri
String
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization
PublishingOrganization
- For whom the client library is being published.
- protoReferenceDocumentationUri
String
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- apiShortName
string
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeownerGithubTeams
string[]
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- docTagPrefix
string
- A prefix used in sample code when demarking regions to be included in documentation.
- documentationUri
string
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- githubLabel
string
- GitHub label to apply to issues and pull requests opened for this API.
- librarySettings
ClientLibrarySettings[]
- 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.
- methodSettings
MethodSettings[]
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- newIssueUri
string
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization
PublishingOrganization
- For whom the client library is being published.
- protoReferenceDocumentationUri
string
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- api_short_name
str
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeowner_github_teams
Sequence[str]
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- doc_tag_prefix
str
- A prefix used in sample code when demarking regions to be included in documentation.
- documentation_uri
str
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- github_label
str
- GitHub label to apply to issues and pull requests opened for this API.
- library_settings
Sequence[ClientLibrarySettings]
- 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.
- method_settings
Sequence[MethodSettings]
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- new_issue_uri
str
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization
PublishingOrganization
- For whom the client library is being published.
- proto_reference_documentation_uri
str
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
PublishingOrganization, PublishingOrganizationArgs
For whom the client library is being published.| Name | Value | Description |
|---|
| ClientLibraryOrganizationUnspecified | CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED | Not useful. |
| Cloud | CLOUD | Google Cloud Platform Org. |
| Ads | ADS | Ads (Advertising) Org. |
| Photos | PHOTOS | Photos Org. |
| StreetView | STREET_VIEW | Street View Org. |
| Shopping | SHOPPING | Shopping Org. |
| Geo | GEO | Geo Org. |
| GenerativeAi | GENERATIVE_AI | Generative AI - https://developers.generativeai.google |
| Name | Value | Description |
|---|
| PublishingOrganizationClientLibraryOrganizationUnspecified | CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED | Not useful. |
| PublishingOrganizationCloud | CLOUD | Google Cloud Platform Org. |
| PublishingOrganizationAds | ADS | Ads (Advertising) Org. |
| PublishingOrganizationPhotos | PHOTOS | Photos Org. |
| PublishingOrganizationStreetView | STREET_VIEW | Street View Org. |
| PublishingOrganizationShopping | SHOPPING | Shopping Org. |
| PublishingOrganizationGeo | GEO | Geo Org. |
| PublishingOrganizationGenerativeAi | GENERATIVE_AI | Generative AI - https://developers.generativeai.google |
| Value | Description |
|---|
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED | Not useful. |
CLOUD | Google Cloud Platform Org. |
ADS | Ads (Advertising) Org. |
PHOTOS | Photos Org. |
STREET_VIEW | Street View Org. |
SHOPPING | Shopping Org. |
GEO | Geo Org. |
GENERATIVE_AI | Generative AI - https://developers.generativeai.google |
| Name | Value | Description |
|---|
| ClientLibraryOrganizationUnspecified | CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED | Not useful. |
| Cloud | CLOUD | Google Cloud Platform Org. |
| Ads | ADS | Ads (Advertising) Org. |
| Photos | PHOTOS | Photos Org. |
| StreetView | STREET_VIEW | Street View Org. |
| Shopping | SHOPPING | Shopping Org. |
| Geo | GEO | Geo Org. |
| GenerativeAi | GENERATIVE_AI | Generative AI - https://developers.generativeai.google |
| Name | Value | Description |
|---|
| ClientLibraryOrganizationUnspecified | CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED | Not useful. |
| Cloud | CLOUD | Google Cloud Platform Org. |
| Ads | ADS | Ads (Advertising) Org. |
| Photos | PHOTOS | Photos Org. |
| StreetView | STREET_VIEW | Street View Org. |
| Shopping | SHOPPING | Shopping Org. |
| Geo | GEO | Geo Org. |
| GenerativeAi | GENERATIVE_AI | Generative AI - https://developers.generativeai.google |
| Name | Value | Description |
|---|
| CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED | CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED | Not useful. |
| CLOUD | CLOUD | Google Cloud Platform Org. |
| ADS | ADS | Ads (Advertising) Org. |
| PHOTOS | PHOTOS | Photos Org. |
| STREET_VIEW | STREET_VIEW | Street View Org. |
| SHOPPING | SHOPPING | Shopping Org. |
| GEO | GEO | Geo Org. |
| GENERATIVE_AI | GENERATIVE_AI | Generative AI - https://developers.generativeai.google |
| Value | Description |
|---|
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED | Not useful. |
CLOUD | Google Cloud Platform Org. |
ADS | Ads (Advertising) Org. |
PHOTOS | Photos Org. |
STREET_VIEW | Street View Org. |
SHOPPING | Shopping Org. |
GEO | Geo Org. |
GENERATIVE_AI | Generative AI - https://developers.generativeai.google |
PublishingResponse, PublishingResponseArgs
This message configures the settings for publishing Google Cloud Client libraries generated from the service config.- ApiShortName
string
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- CodeownerGithubTeams
[]string
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- DocTagPrefix
string
- A prefix used in sample code when demarking regions to be included in documentation.
- DocumentationUri
string
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- GithubLabel
string
- GitHub label to apply to issues and pull requests opened for this API.
- LibrarySettings
[]ClientLibrarySettingsResponse
- 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.
- MethodSettings
[]MethodSettingsResponse
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- NewIssueUri
string
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- Organization
string
- For whom the client library is being published.
- ProtoReferenceDocumentationUri
string
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- api_short_name
string
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeowner_github_teams
list(string)
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- doc_tag_prefix
string
- A prefix used in sample code when demarking regions to be included in documentation.
- documentation_uri
string
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- github_label
string
- GitHub label to apply to issues and pull requests opened for this API.
- library_settings
list(object)
- 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.
- method_settings
list(object)
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- new_issue_uri
string
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization
string
- For whom the client library is being published.
- proto_reference_documentation_uri
string
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- apiShortName
String
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeownerGithubTeams
List<String>
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- docTagPrefix
String
- A prefix used in sample code when demarking regions to be included in documentation.
- documentationUri
String
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- githubLabel
String
- GitHub label to apply to issues and pull requests opened for this API.
- librarySettings
List<ClientLibrarySettingsResponse>
- 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.
- methodSettings
List<MethodSettingsResponse>
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- newIssueUri
String
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization
String
- For whom the client library is being published.
- protoReferenceDocumentationUri
String
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- apiShortName
string
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeownerGithubTeams
string[]
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- docTagPrefix
string
- A prefix used in sample code when demarking regions to be included in documentation.
- documentationUri
string
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- githubLabel
string
- GitHub label to apply to issues and pull requests opened for this API.
- librarySettings
ClientLibrarySettingsResponse[]
- 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.
- methodSettings
MethodSettingsResponse[]
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- newIssueUri
string
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization
string
- For whom the client library is being published.
- protoReferenceDocumentationUri
string
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- api_short_name
str
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeowner_github_teams
Sequence[str]
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- doc_tag_prefix
str
- A prefix used in sample code when demarking regions to be included in documentation.
- documentation_uri
str
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- github_label
str
- GitHub label to apply to issues and pull requests opened for this API.
- library_settings
Sequence[ClientLibrarySettingsResponse]
- 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.
- method_settings
Sequence[MethodSettingsResponse]
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- new_issue_uri
str
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization
str
- For whom the client library is being published.
- proto_reference_documentation_uri
str
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- apiShortName
String
- Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeownerGithubTeams
List<String>
- GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- docTagPrefix
String
- A prefix used in sample code when demarking regions to be included in documentation.
- documentationUri
String
- Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- githubLabel
String
- GitHub label to apply to issues and pull requests opened for this API.
- librarySettings
List<Property Map>
- 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.
- methodSettings
List<Property Map>
- A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- newIssueUri
String
- Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization
String
- For whom the client library is being published.
- protoReferenceDocumentationUri
String
- Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
PythonSettings, PythonSettingsArgs
Settings for Python client libraries.PythonSettingsResponse, PythonSettingsResponseArgs
Settings for Python client libraries.Quota, QuotaArgs
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: INT64QuotaLimit, QuotaLimitArgs
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.- DefaultLimit
string
- 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.
- Description
string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - DisplayName
string
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- Duration
string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- FreeTier
string
- 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.
- MaxLimit
string
- 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.
- Metric
string
- 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.
- Name
string
- 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.
- Unit
string
- 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.
- Values
Dictionary<string, string>
- 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.
- DefaultLimit
string
- 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.
- Description
string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - DisplayName
string
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- Duration
string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- FreeTier
string
- 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.
- MaxLimit
string
- 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.
- Metric
string
- 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.
- Name
string
- 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.
- Unit
string
- 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.
- Values
map[string]string
- 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.
- default_limit
string
- 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.
- description
string
- 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). - display_name
string
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- free_tier
string
- 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.
- max_limit
string
- 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.
- metric
string
- 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.
- name
string
- 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.
- unit
string
- 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.
- values
map(string)
- 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.
- defaultLimit
String
- 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.
- description
String
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - displayName
String
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
String
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- freeTier
String
- 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.
- maxLimit
String
- 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.
- metric
String
- 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.
- name
String
- 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.
- unit
String
- 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.
- values
Map<String,String>
- 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.
- defaultLimit
string
- 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.
- description
string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - displayName
string
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- freeTier
string
- 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.
- maxLimit
string
- 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.
- metric
string
- 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.
- name
string
- 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.
- unit
string
- 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.
- values
{[key: string]: string}
- 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.
- default_limit
str
- 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.
- description
str
- 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). - display_name
str
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
str
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- free_tier
str
- 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.
- max_limit
str
- 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.
- metric
str
- 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.
- name
str
- 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.
- unit
str
- 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.
- values
Mapping[str, str]
- 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.
- defaultLimit
String
- 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.
- description
String
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - displayName
String
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
String
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- freeTier
String
- 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.
- maxLimit
String
- 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.
- metric
String
- 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.
- name
String
- 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.
- unit
String
- 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.
- values
Map<String>
- 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.
QuotaLimitResponse, QuotaLimitResponseArgs
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.- DefaultLimit
string
- 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.
- Description
string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - DisplayName
string
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- Duration
string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- FreeTier
string
- 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.
- MaxLimit
string
- 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.
- Metric
string
- 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.
- Name
string
- 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.
- Unit
string
- 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.
- Values
Dictionary<string, string>
- 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.
- DefaultLimit
string
- 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.
- Description
string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - DisplayName
string
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- Duration
string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- FreeTier
string
- 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.
- MaxLimit
string
- 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.
- Metric
string
- 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.
- Name
string
- 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.
- Unit
string
- 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.
- Values
map[string]string
- 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.
- default_limit
string
- 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.
- description
string
- 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). - display_name
string
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- free_tier
string
- 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.
- max_limit
string
- 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.
- metric
string
- 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.
- name
string
- 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.
- unit
string
- 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.
- values
map(string)
- 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.
- defaultLimit
String
- 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.
- description
String
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - displayName
String
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
String
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- freeTier
String
- 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.
- maxLimit
String
- 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.
- metric
String
- 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.
- name
String
- 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.
- unit
String
- 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.
- values
Map<String,String>
- 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.
- defaultLimit
string
- 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.
- description
string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - displayName
string
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- freeTier
string
- 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.
- maxLimit
string
- 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.
- metric
string
- 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.
- name
string
- 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.
- unit
string
- 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.
- values
{[key: string]: string}
- 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.
- default_limit
str
- 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.
- description
str
- 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). - display_name
str
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
str
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- free_tier
str
- 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.
- max_limit
str
- 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.
- metric
str
- 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.
- name
str
- 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.
- unit
str
- 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.
- values
Mapping[str, str]
- 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.
- defaultLimit
String
- 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.
- description
String
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name). - displayName
String
- User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration
String
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- freeTier
String
- 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.
- maxLimit
String
- 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.
- metric
String
- 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.
- name
String
- 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.
- unit
String
- 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.
- values
Map<String>
- 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.
QuotaResponse, QuotaResponseArgs
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: INT64RubySettings, RubySettingsArgs
Settings for Ruby client libraries.RubySettingsResponse, RubySettingsResponseArgs
Settings for Ruby client libraries.SourceContext, SourceContextArgs
SourceContext represents information about the source of a protobuf element, like the file in which it is defined.- FileName
string
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- FileName
string
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- file_name
string
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- fileName
String
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- fileName
string
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- file_name
str
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- fileName
String
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
SourceContextResponse, SourceContextResponseArgs
SourceContext represents information about the source of a protobuf element, like the file in which it is defined.- FileName
string
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- FileName
string
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- file_name
string
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- fileName
String
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- fileName
string
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- file_name
str
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
- fileName
String
- The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto".
SourceInfoResponse, SourceInfoResponseArgs
Source information used to create a Service Config- SourceFiles
List<ImmutableDictionary<string, string>>
- All files used during config generation.
- SourceFiles
[]map[string]string
- All files used during config generation.
- source_files
list(map(string))
- All files used during config generation.
- sourceFiles
List<Map<String,String>>
- All files used during config generation.
- sourceFiles
{[key: string]: string}[]
- All files used during config generation.
- source_files
Sequence[Mapping[str, str]]
- All files used during config generation.
- sourceFiles
List<Map<String>>
- All files used during config generation.
SystemParameter, SystemParameterArgs
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.-
string
- Define the HTTP header name to use for the parameter. It is case insensitive.
- Name
string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- UrlQueryParameter
string
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
string
- Define the HTTP header name to use for the parameter. It is case insensitive.
- Name
string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- UrlQueryParameter
string
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
string
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- url_query_parameter
string
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
String
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
String
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- urlQueryParameter
String
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
string
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- urlQueryParameter
string
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
str
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
str
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- url_query_parameter
str
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
String
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
String
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- urlQueryParameter
String
- Define the URL query parameter name to use for the parameter. It is case sensitive.
SystemParameterResponse, SystemParameterResponseArgs
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.-
string
- Define the HTTP header name to use for the parameter. It is case insensitive.
- Name
string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- UrlQueryParameter
string
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
string
- Define the HTTP header name to use for the parameter. It is case insensitive.
- Name
string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- UrlQueryParameter
string
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
string
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- url_query_parameter
string
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
String
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
String
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- urlQueryParameter
String
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
string
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- urlQueryParameter
string
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
str
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
str
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- url_query_parameter
str
- Define the URL query parameter name to use for the parameter. It is case sensitive.
-
String
- Define the HTTP header name to use for the parameter. It is case insensitive.
- name
String
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- urlQueryParameter
String
- Define the URL query parameter name to use for the parameter. It is case sensitive.
SystemParameterRule, SystemParameterRuleArgs
Define a system parameter rule mapping system parameter definitions to methods.- Parameters
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SystemParameter>
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- Selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- Parameters
[]SystemParameter
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- Selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
list(object)
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
List<SystemParameter>
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
SystemParameter[]
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
Sequence[SystemParameter]
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
str
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
List<Property Map>
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
SystemParameterRuleResponse, SystemParameterRuleResponseArgs
Define a system parameter rule mapping system parameter definitions to methods.- Parameters
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SystemParameterResponse>
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- Selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- Parameters
[]SystemParameterResponse
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- Selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
list(object)
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
List<SystemParameterResponse>
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
SystemParameterResponse[]
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
Sequence[SystemParameterResponse]
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
str
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
List<Property Map>
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector
String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
SystemParameters, SystemParametersArgs
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.
- Rules
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SystemParameterRule>
- 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.
- Rules
[]SystemParameterRule
- 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.
- rules
list(object)
- 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.
- rules
List<SystemParameterRule>
- 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.
- rules
SystemParameterRule[]
- 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.
- rules
Sequence[SystemParameterRule]
- 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.
- rules
List<Property Map>
- 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.
SystemParametersResponse, SystemParametersResponseArgs
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.
- Rules
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SystemParameterRuleResponse>
- 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.
- Rules
[]SystemParameterRuleResponse
- 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.
- rules
list(object)
- 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.
- rules
List<SystemParameterRuleResponse>
- 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.
- rules
SystemParameterRuleResponse[]
- 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.
- rules
Sequence[SystemParameterRuleResponse]
- 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.
- rules
List<Property Map>
- 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.
Type, TypeArgs
A protocol buffer message type.TypeResponse, TypeResponseArgs
A protocol buffer message type.TypeSyntax, TypeSyntaxArgs
The source syntax.| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| TypeSyntaxSyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| TypeSyntaxSyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| TypeSyntaxSyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Value | Description |
|---|
SYNTAX_PROTO2 | Syntax proto2. |
SYNTAX_PROTO3 | Syntax proto3. |
SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SyntaxProto2 | SYNTAX_PROTO2 | Syntax proto2. |
| SyntaxProto3 | SYNTAX_PROTO3 | Syntax proto3. |
| SyntaxEditions | SYNTAX_EDITIONS | Syntax editions. |
| Name | Value | Description |
|---|
| SYNTAX_PROTO2 | SYNTAX_PROTO2 | Syntax proto2. |
| SYNTAX_PROTO3 | SYNTAX_PROTO3 | Syntax proto3. |
| SYNTAX_EDITIONS | SYNTAX_EDITIONS | Syntax editions. |
| Value | Description |
|---|
SYNTAX_PROTO2 | Syntax proto2. |
SYNTAX_PROTO3 | Syntax proto3. |
SYNTAX_EDITIONS | Syntax editions. |
Usage, UsageArgs
Configuration controlling usage of a service.- ProducerNotificationChannel
string
- 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 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.
- Requirements
List<string>
- 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.
- Rules
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.UsageRule>
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- ProducerNotificationChannel
string
- 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 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.
- Requirements
[]string
- 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.
- Rules
[]UsageRule
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producer_notification_channel
string
- 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 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.
- requirements
list(string)
- 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.
- rules
list(object)
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producerNotificationChannel
String
- 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 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.
- requirements
List<String>
- 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.
- rules
List<UsageRule>
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producerNotificationChannel
string
- 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 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.
- requirements
string[]
- 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.
- rules
UsageRule[]
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producer_notification_channel
str
- 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 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.
- requirements
Sequence[str]
- 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.
- rules
Sequence[UsageRule]
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producerNotificationChannel
String
- 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 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.
- requirements
List<String>
- 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.
- rules
List<Property Map>
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
UsageResponse, UsageResponseArgs
Configuration controlling usage of a service.- ProducerNotificationChannel
string
- 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 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.
- Requirements
List<string>
- 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.
- Rules
List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.UsageRuleResponse>
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- ProducerNotificationChannel
string
- 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 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.
- Requirements
[]string
- 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.
- Rules
[]UsageRuleResponse
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producer_notification_channel
string
- 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 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.
- requirements
list(string)
- 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.
- rules
list(object)
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producerNotificationChannel
String
- 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 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.
- requirements
List<String>
- 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.
- rules
List<UsageRuleResponse>
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producerNotificationChannel
string
- 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 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.
- requirements
string[]
- 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.
- rules
UsageRuleResponse[]
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producer_notification_channel
str
- 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 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.
- requirements
Sequence[str]
- 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.
- rules
Sequence[UsageRuleResponse]
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producerNotificationChannel
String
- 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 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.
- requirements
List<String>
- 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.
- rules
List<Property Map>
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
UsageRule, UsageRuleArgs
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- AllowUnregisteredCalls
bool
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- Selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- SkipServiceControl
bool
- 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.
- AllowUnregisteredCalls
bool
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- Selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- SkipServiceControl
bool
- 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.
- allow_unregistered_calls
bool
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skip_service_control
bool
- 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.
- allowUnregisteredCalls
Boolean
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skipServiceControl
Boolean
- 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.
- allowUnregisteredCalls
boolean
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skipServiceControl
boolean
- 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.
- allow_unregistered_calls
bool
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
str
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skip_service_control
bool
- 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.
- allowUnregisteredCalls
Boolean
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skipServiceControl
Boolean
- 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.
UsageRuleResponse, UsageRuleResponseArgs
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- AllowUnregisteredCalls
bool
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- Selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- SkipServiceControl
bool
- 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.
- AllowUnregisteredCalls
bool
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- Selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- SkipServiceControl
bool
- 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.
- allow_unregistered_calls
bool
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skip_service_control
bool
- 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.
- allowUnregisteredCalls
Boolean
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skipServiceControl
Boolean
- 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.
- allowUnregisteredCalls
boolean
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skipServiceControl
boolean
- 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.
- allow_unregistered_calls
bool
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
str
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skip_service_control
bool
- 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.
- allowUnregisteredCalls
Boolean
- If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector
String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skipServiceControl
Boolean
- 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.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0