google-native.servicemanagement/v1.Config
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
new Config(name: string, args: ConfigArgs, opts?: CustomResourceOptions);
@overload
def Config(resource_name: str,
opts: Optional[ResourceOptions] = None,
apis: Optional[Sequence[ApiArgs]] = None,
authentication: Optional[AuthenticationArgs] = None,
backend: Optional[BackendArgs] = 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,
id: Optional[str] = None,
logging: Optional[LoggingArgs] = None,
logs: Optional[Sequence[LogDescriptorArgs]] = None,
metrics: Optional[Sequence[MetricDescriptorArgs]] = None,
monitored_resources: Optional[Sequence[MonitoredResourceDescriptorArgs]] = None,
monitoring: Optional[MonitoringArgs] = None,
name: Optional[str] = None,
producer_project_id: Optional[str] = None,
quota: Optional[QuotaArgs] = None,
service_name: Optional[str] = None,
system_parameters: Optional[SystemParametersArgs] = None,
system_types: Optional[Sequence[TypeArgs]] = None,
title: Optional[str] = None,
types: Optional[Sequence[TypeArgs]] = None,
usage: Optional[UsageArgs] = None)
@overload
def Config(resource_name: str,
args: ConfigArgs,
opts: Optional[ResourceOptions] = None)
func NewConfig(ctx *Context, name string, args ConfigArgs, opts ...ResourceOption) (*Config, error)
public Config(string name, ConfigArgs args, CustomResourceOptions? opts = null)
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.
- 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.
Inputs
The Config resource accepts the following input properties:
- Service
Name string - Apis
List<Pulumi.
Google Native. Service Management. V1. Inputs. Api Args> 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.
Google Native. Service Management. V1. Inputs. Authentication Args Auth configuration.
- Backend
Pulumi.
Google Native. Service Management. V1. Inputs. Backend Args API backend configuration.
- Billing
Pulumi.
Google Native. Service Management. V1. Inputs. Billing Args 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
Pulumi.
Google Native. Service Management. V1. Inputs. Context Args Context configuration.
- Control
Pulumi.
Google Native. Service Management. V1. Inputs. Control Args Configuration for the service control plane.
- Custom
Error Pulumi.Google Native. Service Management. V1. Inputs. Custom Error Args Custom error configuration.
- Documentation
Pulumi.
Google Native. Service Management. V1. Inputs. Documentation Args Additional API documentation.
- Endpoints
List<Pulumi.
Google Native. Service Management. V1. Inputs. Endpoint Args> 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.
Google Native. Service Management. V1. Inputs. Enum Args> 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.
Google Native. Service Management. V1. Inputs. Http Args 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.
Google Native. Service Management. V1. Inputs. Logging Args Logging configuration.
- Logs
List<Pulumi.
Google Native. Service Management. V1. Inputs. Log Descriptor Args> Defines the logs used by this service.
- Metrics
List<Pulumi.
Google Native. Service Management. V1. Inputs. Metric Descriptor Args> Defines the metrics used by this service.
- Monitored
Resources List<Pulumi.Google Native. Service Management. V1. Inputs. Monitored Resource Descriptor Args> Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- Monitoring
Pulumi.
Google Native. Service Management. V1. Inputs. Monitoring Args 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 stringId The Google project that owns this service.
- Quota
Pulumi.
Google Native. Service Management. V1. Inputs. Quota Args Quota configuration.
- System
Parameters Pulumi.Google Native. Service Management. V1. Inputs. System Parameters Args System parameter configuration.
- System
Types List<Pulumi.Google Native. Service Management. V1. Inputs. Type Args> 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.
Google Native. Service Management. V1. Inputs. Type Args> 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 thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32- Usage
Pulumi.
Google Native. Service Management. V1. Inputs. Usage Args Configuration controlling usage of this service.
- Service
Name string - Apis
[]Api
Args 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
Args Auth configuration.
- Backend
Backend
Args API backend configuration.
- Billing
Billing
Args 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
Context
Args Context configuration.
- Control
Control
Args Configuration for the service control plane.
- Custom
Error CustomError Args Custom error configuration.
- Documentation
Documentation
Args Additional API documentation.
- Endpoints
[]Endpoint
Args 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
Args 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
Args 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
Args Logging configuration.
- Logs
[]Log
Descriptor Args Defines the logs used by this service.
- Metrics
[]Metric
Descriptor Args Defines the metrics used by this service.
- Monitored
Resources []MonitoredResource Descriptor Args Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- Monitoring
Monitoring
Args 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 stringId The Google project that owns this service.
- Quota
Quota
Args Quota configuration.
- System
Parameters SystemParameters Args System parameter configuration.
- System
Types []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
[]Type
Args 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 thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32- Usage
Usage
Args Configuration controlling usage of this service.
- service
Name String - apis
List<Api
Args> 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
Args Auth configuration.
- backend
Backend
Args API backend configuration.
- billing
Billing
Args Billing configuration.
- config
Version Integer Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3
.- context
Context
Args Context configuration.
- control
Control
Args Configuration for the service control plane.
- custom
Error CustomError Args Custom error configuration.
- documentation
Documentation
Args Additional API documentation.
- endpoints
List<Endpoint
Args> 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
Args> 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
Args 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
Args Logging configuration.
- logs
List<Log
Descriptor Args> Defines the logs used by this service.
- metrics
List<Metric
Descriptor Args> Defines the metrics used by this service.
- monitored
Resources List<MonitoredResource Descriptor Args> Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Monitoring
Args 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 StringId The Google project that owns this service.
- quota
Quota
Args Quota configuration.
- system
Parameters SystemParameters Args System parameter configuration.
- system
Types List<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
List<Type
Args> 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 thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32- usage
Usage
Args Configuration controlling usage of this service.
- service
Name string - apis
Api
Args[] 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
Args Auth configuration.
- backend
Backend
Args API backend configuration.
- billing
Billing
Args 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
Context
Args Context configuration.
- control
Control
Args Configuration for the service control plane.
- custom
Error CustomError Args Custom error configuration.
- documentation
Documentation
Args Additional API documentation.
- endpoints
Endpoint
Args[] 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
Args[] 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
Args 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
Args Logging configuration.
- logs
Log
Descriptor Args[] Defines the logs used by this service.
- metrics
Metric
Descriptor Args[] Defines the metrics used by this service.
- monitored
Resources MonitoredResource Descriptor Args[] Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Monitoring
Args 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 stringId The Google project that owns this service.
- quota
Quota
Args Quota configuration.
- system
Parameters SystemParameters Args System parameter configuration.
- system
Types 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
Type
Args[] 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 thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32- usage
Usage
Args Configuration controlling usage of this service.
- service_
name str - apis
Sequence[Api
Args] 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
Args Auth configuration.
- backend
Backend
Args API backend configuration.
- billing
Billing
Args 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
Context
Args Context configuration.
- control
Control
Args Configuration for the service control plane.
- custom_
error CustomError Args Custom error configuration.
- documentation
Documentation
Args Additional API documentation.
- endpoints
Sequence[Endpoint
Args] 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[Enum
Args] 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
Args 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
Logging
Args Logging configuration.
- logs
Sequence[Log
Descriptor Args] Defines the logs used by this service.
- metrics
Sequence[Metric
Descriptor Args] Defines the metrics used by this service.
- monitored_
resources Sequence[MonitoredResource Descriptor Args] Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Monitoring
Args 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_ strid The Google project that owns this service.
- quota
Quota
Args Quota configuration.
- system_
parameters SystemParameters Args 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[Type
Args] 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 thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32- usage
Usage
Args Configuration controlling usage of this service.
- service
Name 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.
- config
Version 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.
- custom
Error 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.
- monitored
Resources 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.- producer
Project StringId The Google project that owns this service.
- quota Property Map
Quota configuration.
- system
Parameters Property Map System parameter configuration.
- system
Types 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 thegoogle.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.
- Source
Info Pulumi.Google Native. Service Management. V1. Outputs. Source Info Response The source information for this configuration if available.
- Id string
The provider-assigned unique ID for this managed resource.
- Source
Info SourceInfo Response The source information for this configuration if available.
- id String
The provider-assigned unique ID for this managed resource.
- source
Info SourceInfo Response The source information for this configuration if available.
- id string
The provider-assigned unique ID for this managed resource.
- source
Info SourceInfo Response The source information for this configuration if available.
- id str
The provider-assigned unique ID for this managed resource.
- source_
info SourceInfo Response The source information for this configuration if available.
- id String
The provider-assigned unique ID for this managed resource.
- source
Info Property Map The source information for this configuration if available.
Supporting Types
Api
- Methods
List<Pulumi.
Google Native. Service Management. V1. Inputs. Method> The methods of this interface, in unspecified order.
- Mixins
List<Pulumi.
Google Native. Service Management. 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.
Google Native. Service Management. V1. Inputs. Option> Any metadata attached to the interface.
- Source
Context Pulumi.Google Native. Service Management. V1. Inputs. Source Context Source context for the protocol buffer service represented by this message.
- Syntax
Pulumi.
Google Native. Service Management. V1. Api Syntax 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 in1.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 inv
, as ingoogle.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.
- Source
Context SourceContext Source context for the protocol buffer service represented by this message.
- Syntax
Api
Syntax 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 in1.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 inv
, as ingoogle.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.
- source
Context SourceContext Source context for the protocol buffer service represented by this message.
- syntax
Api
Syntax 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 in1.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 inv
, as ingoogle.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.
- source
Context SourceContext Source context for the protocol buffer service represented by this message.
- syntax
Api
Syntax 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 in1.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 inv
, as ingoogle.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
Api
Syntax 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 in1.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 inv
, as ingoogle.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.
- source
Context Property Map Source context for the protocol buffer service represented by this message.
- syntax "SYNTAX_PROTO2" | "SYNTAX_PROTO3"
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 in1.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 inv
, as ingoogle.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
- Methods
List<Pulumi.
Google Native. Service Management. V1. Inputs. Method Response> The methods of this interface, in unspecified order.
- Mixins
List<Pulumi.
Google Native. Service Management. V1. Inputs. Mixin Response> 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.
Google Native. Service Management. V1. Inputs. Option Response> Any metadata attached to the interface.
- Source
Context Pulumi.Google Native. Service Management. V1. Inputs. Source Context Response 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 in1.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 inv
, as ingoogle.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
Response The methods of this interface, in unspecified order.
- Mixins
[]Mixin
Response 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
Response Any metadata attached to the interface.
- Source
Context SourceContext Response 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 in1.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 inv
, as ingoogle.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
Response> The methods of this interface, in unspecified order.
- mixins
List<Mixin
Response> 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
Response> Any metadata attached to the interface.
- source
Context SourceContext Response 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 in1.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 inv
, as ingoogle.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
Response[] The methods of this interface, in unspecified order.
- mixins
Mixin
Response[] 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
Response[] Any metadata attached to the interface.
- source
Context SourceContext Response 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 in1.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 inv
, as ingoogle.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
Response] The methods of this interface, in unspecified order.
- mixins
Sequence[Mixin
Response] 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
Response] Any metadata attached to the interface.
- source_
context SourceContext Response 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 in1.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 inv
, as ingoogle.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.
- source
Context 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 in1.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 inv
, as ingoogle.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
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Api
Syntax Syntax Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Api
Syntax Syntax Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- SYNTAX_PROTO2
- SYNTAX_PROTO2
Syntax
proto2
. - SYNTAX_PROTO3
- SYNTAX_PROTO3
Syntax
proto3
.
- "SYNTAX_PROTO2"
- SYNTAX_PROTO2
Syntax
proto2
. - "SYNTAX_PROTO3"
- SYNTAX_PROTO3
Syntax
proto3
.
AuthProvider
- 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
- 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<Pulumi.Google Native. Service Management. V1. Inputs. Jwt Location> 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
- 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 []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
- 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<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
- 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 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
- 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
- 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<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
- 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
- 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<Pulumi.Google Native. Service Management. V1. Inputs. Jwt Location Response> 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
- 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 []JwtLocation Response 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
- 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<JwtLocation Response> 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
- 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 JwtLocation Response[] 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
- 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[JwtLocation Response] 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
- 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<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
- 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
- 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
- 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
- provider
Id 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
- provider
Id String id from authentication provider. Example: provider_id: bookstore_auth
AuthRequirementResponse
- 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
- 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
- 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
- provider
Id 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
- provider
Id String id from authentication provider. Example: provider_id: bookstore_auth
Authentication
- Providers
List<Pulumi.
Google Native. Service Management. V1. Inputs. Auth Provider> Defines a set of authentication providers that a service supports.
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Authentication Rule> A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Providers
[]Auth
Provider Defines a set of authentication providers that a service supports.
- Rules
[]Authentication
Rule A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
List<Auth
Provider> Defines a set of authentication providers that a service supports.
- rules
List<Authentication
Rule> A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
Auth
Provider[] Defines a set of authentication providers that a service supports.
- rules
Authentication
Rule[] A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
Sequence[Auth
Provider] Defines a set of authentication providers that a service supports.
- rules
Sequence[Authentication
Rule] 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
- Providers
List<Pulumi.
Google Native. Service Management. V1. Inputs. Auth Provider Response> Defines a set of authentication providers that a service supports.
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Authentication Rule Response> A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Providers
[]Auth
Provider Response Defines a set of authentication providers that a service supports.
- Rules
[]Authentication
Rule Response A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
List<Auth
Provider Response> Defines a set of authentication providers that a service supports.
- rules
List<Authentication
Rule Response> A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
Auth
Provider Response[] Defines a set of authentication providers that a service supports.
- rules
Authentication
Rule Response[] A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
Sequence[Auth
Provider Response] Defines a set of authentication providers that a service supports.
- rules
Sequence[Authentication
Rule Response] 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
- Allow
Without boolCredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- Oauth
Pulumi.
Google Native. Service Management. V1. Inputs. OAuth Requirements The requirements for OAuth credentials.
- Requirements
List<Pulumi.
Google Native. Service Management. V1. Inputs. Auth Requirement> Requirements for additional authentication providers.
- Selector string
Selects the methods to which this rule applies. Refer to selector for syntax details.
- Allow
Without boolCredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- Oauth
OAuth
Requirements The requirements for OAuth credentials.
- Requirements
[]Auth
Requirement Requirements for additional authentication providers.
- Selector string
Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without BooleanCredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements The requirements for OAuth credentials.
- requirements
List<Auth
Requirement> Requirements for additional authentication providers.
- selector String
Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without booleanCredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements The requirements for OAuth credentials.
- requirements
Auth
Requirement[] Requirements for additional authentication providers.
- selector string
Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow_
without_ boolcredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements The requirements for OAuth credentials.
- requirements
Sequence[Auth
Requirement] Requirements for additional authentication providers.
- selector str
Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without BooleanCredential 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
- Allow
Without boolCredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- Oauth
Pulumi.
Google Native. Service Management. V1. Inputs. OAuth Requirements Response The requirements for OAuth credentials.
- Requirements
List<Pulumi.
Google Native. Service Management. V1. Inputs. Auth Requirement Response> Requirements for additional authentication providers.
- Selector string
Selects the methods to which this rule applies. Refer to selector for syntax details.
- Allow
Without boolCredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- Oauth
OAuth
Requirements Response The requirements for OAuth credentials.
- Requirements
[]Auth
Requirement Response Requirements for additional authentication providers.
- Selector string
Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without BooleanCredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements Response The requirements for OAuth credentials.
- requirements
List<Auth
Requirement Response> Requirements for additional authentication providers.
- selector String
Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without booleanCredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements Response The requirements for OAuth credentials.
- requirements
Auth
Requirement Response[] Requirements for additional authentication providers.
- selector string
Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow_
without_ boolcredential If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements Response The requirements for OAuth credentials.
- requirements
Sequence[Auth
Requirement Response] Requirements for additional authentication providers.
- selector str
Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without BooleanCredential 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
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Backend Rule> A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Rules
[]Backend
Rule A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Backend
Rule> A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Backend
Rule[] A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[Backend
Rule] 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
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Backend Rule Response> A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Rules
[]Backend
Rule Response A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Backend
Rule Response> A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Backend
Rule Response[] A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[Backend
Rule Response] 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
- 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.
- 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.
- Operation
Deadline double The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- Path
Translation Pulumi.Google Native. Service Management. V1. Backend Rule Path Translation - 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.
- 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.
- Operation
Deadline float64 The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- Path
Translation BackendRule Path Translation - 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.
- disable
Auth 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.
- 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.
- operation
Deadline Double The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- path
Translation BackendRule Path Translation - 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 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.
- 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.
- operation
Deadline number The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- path
Translation BackendRule Path Translation - 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.
- operation_
deadline float The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- path_
translation BackendRule Path Translation - 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.
- disable
Auth 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.
- 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.
- operation
Deadline Number The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- 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.
BackendRulePathTranslation
- 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
- Backend
Rule Path Translation Path Translation Unspecified - PATH_TRANSLATION_UNSPECIFIED
- Backend
Rule Path Translation 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
- Backend
Rule Path Translation 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
- 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
- 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
- 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
- "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
BackendRuleResponse
- 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.
- 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.
- Operation
Deadline double The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- 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 float64
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.
- Operation
Deadline float64 The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- 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.
- disable
Auth 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.
- 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.
- operation
Deadline Double The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- 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 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 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.
- 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.
- operation
Deadline number The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- 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 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.
- operation_
deadline float The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- 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.
- disable
Auth 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.
- 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.
- operation
Deadline Number The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- 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.
Billing
- Consumer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Billing Destination> 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 []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<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 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.
- consumer
Destinations 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
- 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 []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.
- monitored
Resource 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.
- monitored
Resource 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.
- monitored
Resource String The monitored resource type. The type must be defined in Service.monitored_resources section.
BillingDestinationResponse
- 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 []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.
- monitored
Resource 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.
- monitored
Resource 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.
- monitored
Resource String The monitored resource type. The type must be defined in Service.monitored_resources section.
BillingResponse
- Consumer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Billing Destination Response> 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 []BillingDestination Response 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<BillingDestination Response> 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 BillingDestination Response[] 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 Response] 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<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.
Context
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Context Rule> A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Rules
[]Context
Rule A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Context
Rule> A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Context
Rule[] A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[Context
Rule] 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
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Context Rule Response> A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Rules
[]Context
Rule Response A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Context
Rule Response> A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Context
Rule Response[] A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[Context
Rule Response] 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
- Allowed
Request List<string>Extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- Allowed
Response List<string>Extensions 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.
- Allowed
Request []stringExtensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- Allowed
Response []stringExtensions 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 List<String>Extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response List<String>Extensions 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.
- allowed
Request string[]Extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response string[]Extensions 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_ Sequence[str]extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed_
response_ Sequence[str]extensions 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.
- allowed
Request List<String>Extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response List<String>Extensions 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
- Allowed
Request List<string>Extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- Allowed
Response List<string>Extensions 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.
- Allowed
Request []stringExtensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- Allowed
Response []stringExtensions 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 List<String>Extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response List<String>Extensions 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.
- allowed
Request string[]Extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response string[]Extensions 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_ Sequence[str]extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed_
response_ Sequence[str]extensions 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.
- allowed
Request List<String>Extensions A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response List<String>Extensions 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
- 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
- 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
- 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
- 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
- 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
- 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
ControlResponse
- 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
- 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
- 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
- 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
- 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
- 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
CustomError
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Custom Error Rule> 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
[]Custom
Error Rule 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<Custom
Error Rule> 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
Custom
Error Rule[] 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[Custom
Error Rule] 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
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Custom Error Rule Response> 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
[]Custom
Error Rule Response 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<Custom
Error Rule Response> 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
Custom
Error Rule Response[] 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[Custom
Error Rule Response] 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
- Is
Error boolType 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 boolType 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 BooleanType 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 booleanType 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_ booltype 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.
- is
Error BooleanType 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
- Is
Error boolType 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 boolType 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 BooleanType 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 booleanType 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_ booltype 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.
- is
Error BooleanType 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
CustomHttpPatternResponse
Documentation
- Documentation
Root stringUrl 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 andpages
field.- Pages
List<Pulumi.
Google Native. Service Management. V1. Inputs. Page> The top level pages for the documentation set.
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Documentation Rule> A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- Service
Root stringUrl 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 stringUrl 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 andpages
field.- Pages []Page
The top level pages for the documentation set.
- Rules
[]Documentation
Rule A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- Service
Root stringUrl 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 StringUrl 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 andpages
field.- pages List<Page>
The top level pages for the documentation set.
- rules
List<Documentation
Rule> A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- service
Root StringUrl 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 stringUrl 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 andpages
field.- pages Page[]
The top level pages for the documentation set.
- rules
Documentation
Rule[] A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- service
Root stringUrl 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_ strurl 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 andpages
field.- pages Sequence[Page]
The top level pages for the documentation set.
- rules
Sequence[Documentation
Rule] A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- service_
root_ strurl 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
.
- documentation
Root StringUrl 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 andpages
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.
- service
Root StringUrl 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
- Documentation
Root stringUrl 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 andpages
field.- Pages
List<Pulumi.
Google Native. Service Management. V1. Inputs. Page Response> The top level pages for the documentation set.
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Documentation Rule Response> A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- Service
Root stringUrl 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 stringUrl 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 andpages
field.- Pages
[]Page
Response The top level pages for the documentation set.
- Rules
[]Documentation
Rule Response A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- Service
Root stringUrl 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 StringUrl 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 andpages
field.- pages
List<Page
Response> The top level pages for the documentation set.
- rules
List<Documentation
Rule Response> A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- service
Root StringUrl 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 stringUrl 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 andpages
field.- pages
Page
Response[] The top level pages for the documentation set.
- rules
Documentation
Rule Response[] A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- service
Root stringUrl 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_ strurl 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 andpages
field.- pages
Sequence[Page
Response] The top level pages for the documentation set.
- rules
Sequence[Documentation
Rule Response] A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- service_
root_ strurl 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
.
- documentation
Root StringUrl 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 andpages
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.
- service
Root StringUrl 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
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
Endpoint
- 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".
- 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".
- allow
Cors 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".
- allow
Cors 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".
- 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".
- allow
Cors 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
- 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".
- 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".
- allow
Cors 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".
- allow
Cors 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".
- 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".
- allow
Cors 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
- Enumvalue
List<Pulumi.
Google Native. Service Management. V1. Inputs. Enum Value> Enum value definitions.
- Name string
Enum type name.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option> Protocol buffer options.
- Source
Context Pulumi.Google Native. Service Management. V1. Inputs. Source Context The source context.
- Syntax
Pulumi.
Google Native. Service Management. V1. Enum Syntax The source syntax.
- Enumvalue
[]Enum
Value Enum value definitions.
- Name string
Enum type name.
- Options []Option
Protocol buffer options.
- Source
Context SourceContext The source context.
- Syntax
Enum
Syntax The source syntax.
- enumvalue
List<Enum
Value> Enum value definitions.
- name String
Enum type name.
- options List<Option>
Protocol buffer options.
- source
Context SourceContext The source context.
- syntax
Enum
Syntax The source syntax.
- enumvalue
Enum
Value[] Enum value definitions.
- name string
Enum type name.
- options Option[]
Protocol buffer options.
- source
Context SourceContext The source context.
- syntax
Enum
Syntax The source syntax.
- enumvalue
Sequence[Enum
Value] Enum value definitions.
- name str
Enum type name.
- options Sequence[Option]
Protocol buffer options.
- source_
context SourceContext The source context.
- syntax
Enum
Syntax The source syntax.
- enumvalue List<Property Map>
Enum value definitions.
- name String
Enum type name.
- options List<Property Map>
Protocol buffer options.
- source
Context Property Map The source context.
- syntax "SYNTAX_PROTO2" | "SYNTAX_PROTO3"
The source syntax.
EnumResponse
- Enumvalue
List<Pulumi.
Google Native. Service Management. V1. Inputs. Enum Value Response> Enum value definitions.
- Name string
Enum type name.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> Protocol buffer options.
- Source
Context Pulumi.Google Native. Service Management. V1. Inputs. Source Context Response The source context.
- Syntax string
The source syntax.
- Enumvalue
[]Enum
Value Response Enum value definitions.
- Name string
Enum type name.
- Options
[]Option
Response Protocol buffer options.
- Source
Context SourceContext Response The source context.
- Syntax string
The source syntax.
- enumvalue
List<Enum
Value Response> Enum value definitions.
- name String
Enum type name.
- options
List<Option
Response> Protocol buffer options.
- source
Context SourceContext Response The source context.
- syntax String
The source syntax.
- enumvalue
Enum
Value Response[] Enum value definitions.
- name string
Enum type name.
- options
Option
Response[] Protocol buffer options.
- source
Context SourceContext Response The source context.
- syntax string
The source syntax.
- enumvalue
Sequence[Enum
Value Response] Enum value definitions.
- name str
Enum type name.
- options
Sequence[Option
Response] Protocol buffer options.
- source_
context SourceContext Response The source context.
- syntax str
The source syntax.
- enumvalue List<Property Map>
Enum value definitions.
- name String
Enum type name.
- options List<Property Map>
Protocol buffer options.
- source
Context Property Map The source context.
- syntax String
The source syntax.
EnumSyntax
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Enum
Syntax Syntax Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Enum
Syntax Syntax Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- SYNTAX_PROTO2
- SYNTAX_PROTO2
Syntax
proto2
. - SYNTAX_PROTO3
- SYNTAX_PROTO3
Syntax
proto3
.
- "SYNTAX_PROTO2"
- SYNTAX_PROTO2
Syntax
proto2
. - "SYNTAX_PROTO3"
- SYNTAX_PROTO3
Syntax
proto3
.
EnumValue
- Name string
Enum value name.
- Number int
Enum value number.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option> Protocol buffer options.
- name String
Enum value name.
- number Integer
Enum value number.
- options List<Option>
Protocol buffer options.
- name str
Enum value name.
- number int
Enum value number.
- options Sequence[Option]
Protocol buffer options.
- name String
Enum value name.
- number Number
Enum value number.
- options List<Property Map>
Protocol buffer options.
EnumValueResponse
- Name string
Enum value name.
- Number int
Enum value number.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> Protocol buffer options.
- Name string
Enum value name.
- Number int
Enum value number.
- Options
[]Option
Response Protocol buffer options.
- name String
Enum value name.
- number Integer
Enum value number.
- options
List<Option
Response> Protocol buffer options.
- name string
Enum value name.
- number number
Enum value number.
- options
Option
Response[] Protocol buffer options.
- name str
Enum value name.
- number int
Enum value number.
- options
Sequence[Option
Response] Protocol buffer options.
- name String
Enum value name.
- number Number
Enum value number.
- options List<Property Map>
Protocol buffer options.
Field
- Cardinality
Pulumi.
Google Native. Service Management. V1. Field Cardinality 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
Pulumi.
Google Native. Service Management. V1. Field Kind The field type.
- Name string
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
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option> 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
Field
Cardinality 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
Field
Kind The field type.
- Name string
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 []Option
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
Field
Cardinality 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
Field
Kind The field type.
- name String
The field name.
- number Integer
The field number.
- oneof
Index 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.
- type
Url String The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
.
- cardinality
Field
Cardinality 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
Field
Kind 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 Option[]
The protocol buffer options.
- packed boolean
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
Field
Cardinality 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
Field
Kind 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"
.
- cardinality "CARDINALITY_UNKNOWN" | "CARDINALITY_OPTIONAL" | "CARDINALITY_REQUIRED" | "CARDINALITY_REPEATED"
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 "TYPE_UNKNOWN" | "TYPE_DOUBLE" | "TYPE_FLOAT" | "TYPE_INT64" | "TYPE_UINT64" | "TYPE_INT32" | "TYPE_FIXED64" | "TYPE_FIXED32" | "TYPE_BOOL" | "TYPE_STRING" | "TYPE_GROUP" | "TYPE_MESSAGE" | "TYPE_BYTES" | "TYPE_UINT32" | "TYPE_ENUM" | "TYPE_SFIXED32" | "TYPE_SFIXED64" | "TYPE_SINT32" | "TYPE_SINT64"
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<Property Map>
The protocol buffer options.
- packed Boolean
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"
.
FieldCardinality
- 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.
- Field
Cardinality Cardinality Unknown - CARDINALITY_UNKNOWN
For fields with unknown cardinality.
- Field
Cardinality Cardinality Optional - CARDINALITY_OPTIONAL
For optional fields.
- Field
Cardinality Cardinality Required - CARDINALITY_REQUIRED
For required fields. Proto2 syntax only.
- Field
Cardinality Cardinality Repeated - CARDINALITY_REPEATED
For repeated fields.
- 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.
- 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.
- 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.
- "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.
FieldKind
- 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.
- Field
Kind Type Unknown - TYPE_UNKNOWN
Field type unknown.
- Field
Kind Type Double - TYPE_DOUBLE
Field type double.
- Field
Kind Type Float - TYPE_FLOAT
Field type float.
- Field
Kind Type Int64 - TYPE_INT64
Field type int64.
- Field
Kind Type Uint64 - TYPE_UINT64
Field type uint64.
- Field
Kind Type Int32 - TYPE_INT32
Field type int32.
- Field
Kind Type Fixed64 - TYPE_FIXED64
Field type fixed64.
- Field
Kind Type Fixed32 - TYPE_FIXED32
Field type fixed32.
- Field
Kind Type Bool - TYPE_BOOL
Field type bool.
- Field
Kind Type String - TYPE_STRING
Field type string.
- Field
Kind Type Group - TYPE_GROUP
Field type group. Proto2 syntax only, and deprecated.
- Field
Kind Type Message - TYPE_MESSAGE
Field type message.
- Field
Kind Type Bytes - TYPE_BYTES
Field type bytes.
- Field
Kind Type Uint32 - TYPE_UINT32
Field type uint32.
- Field
Kind Type Enum - TYPE_ENUM
Field type enum.
- Field
Kind Type Sfixed32 - TYPE_SFIXED32
Field type sfixed32.
- Field
Kind Type Sfixed64 - TYPE_SFIXED64
Field type sfixed64.
- Field
Kind Type Sint32 - TYPE_SINT32
Field type sint32.
- Field
Kind Type Sint64 - TYPE_SINT64
Field type sint64.
- 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.
- 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.
- 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.
- "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.
FieldResponse
- 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 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
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> 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.
- 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 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
[]Option
Response 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.
- 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 Integer
The field number.
- oneof
Index 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
Response> The protocol buffer options.
- packed Boolean
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.
- 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
Option
Response[] The protocol buffer options.
- packed boolean
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 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[Option
Response] 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.
- 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<Property Map>
The protocol buffer options.
- packed Boolean
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"
.
Http
- Fully
Decode boolReserved Expansion 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.
Google Native. Service Management. V1. Inputs. Http Rule> A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Fully
Decode boolReserved Expansion 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
[]Http
Rule A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode BooleanReserved Expansion 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<Http
Rule> A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode booleanReserved Expansion 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
Http
Rule[] A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully_
decode_ boolreserved_ expansion 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[Http
Rule] A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode BooleanReserved Expansion 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
- Fully
Decode boolReserved Expansion 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.
Google Native. Service Management. V1. Inputs. Http Rule Response> A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Fully
Decode boolReserved Expansion 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
[]Http
Rule Response A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode BooleanReserved Expansion 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<Http
Rule Response> A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode booleanReserved Expansion 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
Http
Rule Response[] A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully_
decode_ boolreserved_ expansion 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[Http
Rule Response] A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode BooleanReserved Expansion 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
- Additional
Bindings List<Pulumi.Google Native. Service Management. V1. Inputs. Http Rule> 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.
Google Native. Service Management. V1. Inputs. Custom Http Pattern 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.
- Additional
Bindings []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
Custom
Http Pattern 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.
- additional
Bindings 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
Custom
Http Pattern 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.
- additional
Bindings 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
Custom
Http Pattern 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.
- 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
Custom
Http Pattern 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.
- additional
Bindings 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.
- 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.
HttpRuleResponse
- Additional
Bindings List<Pulumi.Google Native. Service Management. V1. Inputs. Http Rule Response> 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.
Google Native. Service Management. V1. Inputs. Custom Http Pattern Response 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.
- Additional
Bindings []HttpRule Response 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
Custom
Http Pattern Response 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.
- additional
Bindings List<HttpRule Response> 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
Custom
Http Pattern Response 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.
- additional
Bindings HttpRule Response[] 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
Custom
Http Pattern Response 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.
- additional_
bindings Sequence[HttpRule Response] 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
Custom
Http Pattern Response 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.
- additional
Bindings 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.
- 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.
JwtLocation
- string
Specifies cookie name to extract JWT token.
- Header 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.
- string
Specifies cookie name to extract JWT token.
- Header 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.
- String
Specifies cookie name to extract JWT token.
- header 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.
- string
Specifies cookie name to extract JWT token.
- header 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.
- str
Specifies cookie name to extract JWT token.
- header 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.
- String
Specifies cookie name to extract JWT token.
- header 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.
JwtLocationResponse
- string
Specifies cookie name to extract JWT token.
- Header 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.
- string
Specifies cookie name to extract JWT token.
- Header 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.
- String
Specifies cookie name to extract JWT token.
- header 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.
- string
Specifies cookie name to extract JWT token.
- header 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.
- str
Specifies cookie name to extract JWT token.
- header 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.
- String
Specifies cookie name to extract JWT token.
- header 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.
LabelDescriptor
- Description string
A human-readable description for the label.
- Key string
The label key.
- Value
Type Pulumi.Google Native. Service Management. V1. Label Descriptor Value Type 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 LabelDescriptor Value Type 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 LabelDescriptor Value Type 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 LabelDescriptor Value Type 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 LabelDescriptor Value Type 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" | "BOOL" | "INT64" The type of data that can be assigned to the label.
LabelDescriptorResponse
- 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.
- 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.
- 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.
- value
Type 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.
- value
Type String The type of data that can be assigned to the label.
LabelDescriptorValueType
- String
- STRING
A variable-length string. This is the default.
- Bool
- BOOL
Boolean; true or false.
- Int64
- INT64
A 64-bit signed integer.
- Label
Descriptor Value Type String - STRING
A variable-length string. This is the default.
- Label
Descriptor Value Type Bool - BOOL
Boolean; true or false.
- Label
Descriptor Value Type Int64 - INT64
A 64-bit signed integer.
- String
- STRING
A variable-length string. This is the default.
- Bool
- BOOL
Boolean; true or false.
- Int64
- INT64
A 64-bit signed integer.
- String
- STRING
A variable-length string. This is the default.
- Bool
- BOOL
Boolean; true or false.
- Int64
- INT64
A 64-bit signed integer.
- STRING
- STRING
A variable-length string. This is the default.
- BOOL
- BOOL
Boolean; true or false.
- INT64
- INT64
A 64-bit signed integer.
- "STRING"
- STRING
A variable-length string. This is the default.
- "BOOL"
- BOOL
Boolean; true or false.
- "INT64"
- INT64
A 64-bit signed integer.
LogDescriptor
- 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<Pulumi.
Google Native. Service Management. V1. Inputs. Label Descriptor> 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
[]Label
Descriptor 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<Label
Descriptor> 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
Label
Descriptor[] 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[Label
Descriptor] 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.
- display
Name 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
- 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<Pulumi.
Google Native. Service Management. V1. Inputs. Label Descriptor Response> 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
[]Label
Descriptor Response 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<Label
Descriptor Response> 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
Label
Descriptor Response[] 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[Label
Descriptor Response] 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.
- display
Name 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
- Consumer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Logging Destination> 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<Pulumi.Google Native. Service Management. V1. Inputs. Logging Destination> 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 []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 []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<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 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.
- consumer
Destinations 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 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.
- consumer
Destinations 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.
- producer
Destinations 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
- 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 []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 "/".
- monitored
Resource 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 "/".
- monitored
Resource 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 "/".
- monitored
Resource String The monitored resource type. The type must be defined in the Service.monitored_resources section.
LoggingDestinationResponse
- 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 []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 "/".
- monitored
Resource 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 "/".
- monitored
Resource 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 "/".
- monitored
Resource String The monitored resource type. The type must be defined in the Service.monitored_resources section.
LoggingResponse
- Consumer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Logging Destination Response> 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<Pulumi.Google Native. Service Management. V1. Inputs. Logging Destination Response> 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 []LoggingDestination Response 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 []LoggingDestination Response 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<LoggingDestination Response> 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<LoggingDestination Response> 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 LoggingDestination Response[] 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 LoggingDestination Response[] 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 Response] 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 Response] 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<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.
- producer
Destinations 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.
Method
- Name string
The simple name of this method.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option> Any metadata attached to the method.
- Request
Streaming bool If true, the request is streamed.
- Request
Type stringUrl A URL of the input message type.
- Response
Streaming bool If true, the response is streamed.
- Response
Type stringUrl The URL of the output message type.
- Syntax
Pulumi.
Google Native. Service Management. V1. Method Syntax The source syntax of this method.
- Name string
The simple name of this method.
- Options []Option
Any metadata attached to the method.
- Request
Streaming bool If true, the request is streamed.
- Request
Type stringUrl A URL of the input message type.
- Response
Streaming bool If true, the response is streamed.
- Response
Type stringUrl The URL of the output message type.
- Syntax
Method
Syntax The source syntax of this method.
- name String
The simple name of this method.
- options List<Option>
Any metadata attached to the method.
- request
Streaming Boolean If true, the request is streamed.
- request
Type StringUrl A URL of the input message type.
- response
Streaming Boolean If true, the response is streamed.
- response
Type StringUrl The URL of the output message type.
- syntax
Method
Syntax The source syntax of this method.
- name string
The simple name of this method.
- options Option[]
Any metadata attached to the method.
- request
Streaming boolean If true, the request is streamed.
- request
Type stringUrl A URL of the input message type.
- response
Streaming boolean If true, the response is streamed.
- response
Type stringUrl The URL of the output message type.
- syntax
Method
Syntax The source syntax of this method.
- name str
The simple name of this method.
- options Sequence[Option]
Any metadata attached to the method.
- request_
streaming bool If true, the request is streamed.
- request_
type_ strurl A URL of the input message type.
- response_
streaming bool If true, the response is streamed.
- response_
type_ strurl The URL of the output message type.
- syntax
Method
Syntax The source syntax of this method.
- name String
The simple name of this method.
- options List<Property Map>
Any metadata attached to the method.
- request
Streaming Boolean If true, the request is streamed.
- request
Type StringUrl A URL of the input message type.
- response
Streaming Boolean If true, the response is streamed.
- response
Type StringUrl The URL of the output message type.
- syntax "SYNTAX_PROTO2" | "SYNTAX_PROTO3"
The source syntax of this method.
MethodResponse
- Name string
The simple name of this method.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> Any metadata attached to the method.
- Request
Streaming bool If true, the request is streamed.
- Request
Type stringUrl A URL of the input message type.
- Response
Streaming bool If true, the response is streamed.
- Response
Type stringUrl The URL of the output message type.
- Syntax string
The source syntax of this method.
- Name string
The simple name of this method.
- Options
[]Option
Response Any metadata attached to the method.
- Request
Streaming bool If true, the request is streamed.
- Request
Type stringUrl A URL of the input message type.
- Response
Streaming bool If true, the response is streamed.
- Response
Type stringUrl The URL of the output message type.
- Syntax string
The source syntax of this method.
- name String
The simple name of this method.
- options
List<Option
Response> Any metadata attached to the method.
- request
Streaming Boolean If true, the request is streamed.
- request
Type StringUrl A URL of the input message type.
- response
Streaming Boolean If true, the response is streamed.
- response
Type StringUrl The URL of the output message type.
- syntax String
The source syntax of this method.
- name string
The simple name of this method.
- options
Option
Response[] Any metadata attached to the method.
- request
Streaming boolean If true, the request is streamed.
- request
Type stringUrl A URL of the input message type.
- response
Streaming boolean If true, the response is streamed.
- response
Type stringUrl The URL of the output message type.
- syntax string
The source syntax of this method.
- name str
The simple name of this method.
- options
Sequence[Option
Response] Any metadata attached to the method.
- request_
streaming bool If true, the request is streamed.
- request_
type_ strurl A URL of the input message type.
- response_
streaming bool If true, the response is streamed.
- response_
type_ strurl The URL of the output message type.
- syntax str
The source syntax of this method.
- name String
The simple name of this method.
- options List<Property Map>
Any metadata attached to the method.
- request
Streaming Boolean If true, the request is streamed.
- request
Type StringUrl A URL of the input message type.
- response
Streaming Boolean If true, the response is streamed.
- response
Type StringUrl The URL of the output message type.
- syntax String
The source syntax of this method.
MethodSyntax
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Method
Syntax Syntax Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Method
Syntax Syntax Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- Syntax
Proto2 - SYNTAX_PROTO2
Syntax
proto2
. - Syntax
Proto3 - SYNTAX_PROTO3
Syntax
proto3
.
- SYNTAX_PROTO2
- SYNTAX_PROTO2
Syntax
proto2
. - SYNTAX_PROTO3
- SYNTAX_PROTO3
Syntax
proto3
.
- "SYNTAX_PROTO2"
- SYNTAX_PROTO2
Syntax
proto2
. - "SYNTAX_PROTO3"
- SYNTAX_PROTO3
Syntax
proto3
.
MetricDescriptor
- 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<Pulumi.
Google Native. Service Management. V1. Inputs. Label Descriptor> 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 Pulumi.Google Native. Service Management. V1. Metric Descriptor Launch Stage Optional. The launch stage of the metric definition.
- Metadata
Pulumi.
Google Native. Service Management. V1. Inputs. Metric Descriptor Metadata Optional. Metadata which can be used to guide usage of the metric.
- Metric
Kind Pulumi.Google Native. Service Management. V1. Metric Descriptor Metric Kind Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.- Monitored
Resource List<string>Types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- Value
Type Pulumi.Google Native. Service Management. V1. Metric Descriptor Value Type Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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
[]Label
Descriptor 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 MetricDescriptor Launch Stage Optional. The launch stage of the metric definition.
- Metadata
Metric
Descriptor Metadata Optional. Metadata which can be used to guide usage of the metric.
- Metric
Kind MetricDescriptor Metric Kind Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.- Monitored
Resource []stringTypes 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- Value
Type MetricDescriptor Value Type Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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<Label
Descriptor> 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 MetricDescriptor Launch Stage Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind MetricDescriptor Metric Kind Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.- monitored
Resource List<String>Types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- value
Type MetricDescriptor Value Type Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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
Label
Descriptor[] 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 MetricDescriptor Launch Stage Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind MetricDescriptor Metric Kind Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.- monitored
Resource string[]Types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- value
Type MetricDescriptor Value Type Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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[Label
Descriptor] 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 MetricDescriptor Launch Stage Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Optional. Metadata which can be used to guide usage of the metric.
- metric_
kind MetricDescriptor Metric Kind Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.- monitored_
resource_ Sequence[str]types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- value_
type MetricDescriptor Value Type Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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<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.- launch
Stage "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.
- metric
Kind "METRIC_KIND_UNSPECIFIED" | "GAUGE" | "DELTA" | "CUMULATIVE" Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.- monitored
Resource List<String>Types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.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
andvalue_type
might not be supported.
MetricDescriptorLaunchStage
- 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.
- Metric
Descriptor Launch Stage Launch Stage Unspecified - LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
- Metric
Descriptor Launch Stage Unimplemented - UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
- Metric
Descriptor Launch Stage Prelaunch - PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
- Metric
Descriptor Launch Stage 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.
- Metric
Descriptor Launch Stage 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.
- Metric
Descriptor Launch Stage 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.
- Metric
Descriptor Launch Stage Ga - GA
GA features are open to all developers and are considered stable and fully qualified for production use.
- Metric
Descriptor Launch Stage 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.
- 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.
- 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.
- 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.
- "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.
MetricDescriptorMetadata
- 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 Pulumi.Google Native. Service Management. V1. Metric Descriptor Metadata Launch Stage Deprecated. Must use the MetricDescriptor.launch_stage instead.
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.
- 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 MetricDescriptor Metadata Launch Stage Deprecated. Must use the MetricDescriptor.launch_stage instead.
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.
- 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 MetricDescriptor Metadata Launch Stage Deprecated. Must use the MetricDescriptor.launch_stage instead.
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.
- 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 MetricDescriptor Metadata Launch Stage Deprecated. Must use the MetricDescriptor.launch_stage instead.
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.
- 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 MetricDescriptor Metadata Launch Stage Deprecated. Must use the MetricDescriptor.launch_stage instead.
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.
- 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 "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED" Deprecated. Must use the MetricDescriptor.launch_stage instead.
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.
MetricDescriptorMetadataLaunchStage
- 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.
- Metric
Descriptor Metadata Launch Stage Launch Stage Unspecified - LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
- Metric
Descriptor Metadata Launch Stage Unimplemented - UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
- Metric
Descriptor Metadata Launch Stage Prelaunch - PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
- Metric
Descriptor Metadata Launch Stage 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.
- Metric
Descriptor Metadata Launch Stage 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.
- Metric
Descriptor Metadata Launch Stage 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.
- Metric
Descriptor Metadata Launch Stage Ga - GA
GA features are open to all developers and are considered stable and fully qualified for production use.
- Metric
Descriptor Metadata Launch Stage 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.
- 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.
- 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.
- 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.
- "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.
MetricDescriptorMetadataResponse
- 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. 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.
- 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. 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.
- 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. 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.
- 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. 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.
- 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. 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.
- 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. 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.
MetricDescriptorMetricKind
- 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.
- Metric
Descriptor Metric Kind Metric Kind Unspecified - METRIC_KIND_UNSPECIFIED
Do not use this default value.
- Metric
Descriptor Metric Kind Gauge - GAUGE
An instantaneous measurement of a value.
- Metric
Descriptor Metric Kind Delta - DELTA
The change in a value during a time interval.
- Metric
Descriptor Metric Kind 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.
- 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.
- 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.
- 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.
- "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.
MetricDescriptorResponse
- 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<Pulumi.
Google Native. Service Management. V1. Inputs. Label Descriptor Response> 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
Pulumi.
Google Native. Service Management. V1. Inputs. Metric Descriptor Metadata Response 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
andvalue_type
might not be supported.- Monitored
Resource List<string>Types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- Value
Type string Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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
[]Label
Descriptor Response 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
Metric
Descriptor Metadata Response 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
andvalue_type
might not be supported.- Monitored
Resource []stringTypes 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- Value
Type string Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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<Label
Descriptor Response> 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
Metric
Descriptor Metadata Response 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
andvalue_type
might not be supported.- monitored
Resource List<String>Types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- value
Type String Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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
Label
Descriptor Response[] 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
Metric
Descriptor Metadata Response 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
andvalue_type
might not be supported.- monitored
Resource string[]Types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- value
Type string Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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[Label
Descriptor Response] 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
Metric
Descriptor Metadata Response 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
andvalue_type
might not be supported.- monitored_
resource_ Sequence[str]types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- value_
type str Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_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<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.- launch
Stage String Optional. The launch stage of the metric definition.
- metadata Property Map
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
andvalue_type
might not be supported.- monitored
Resource List<String>Types 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
orexternal.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
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, 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 anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/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}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; 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
ork{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 aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. 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 in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.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 value3
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 value0.03
means "3 percent").- value
Type String Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.
MetricDescriptorValueType
- 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.
- Metric
Descriptor Value Type Value Type Unspecified - VALUE_TYPE_UNSPECIFIED
Do not use this default value.
- Metric
Descriptor Value Type Bool - BOOL
The value is a boolean. This value type can be used only if the metric kind is
GAUGE
. - Metric
Descriptor Value Type Int64 - INT64
The value is a signed 64-bit integer.
- Metric
Descriptor Value Type Double - DOUBLE
The value is a double precision floating point number.
- Metric
Descriptor Value Type String - STRING
The value is a text string. This value type can be used only if the metric kind is
GAUGE
. - Metric
Descriptor Value Type Distribution - DISTRIBUTION
The value is a
Distribution
. - Metric
Descriptor Value Type Money - MONEY
The value is money.
- 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
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_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_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.
MetricRule
- Metric
Costs 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.
- Metric
Costs 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,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 {[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.
- 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.
MetricRuleResponse
- Metric
Costs 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.
- Metric
Costs 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,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 {[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.
- 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.
Mixin
MixinResponse
MonitoredResourceDescriptor
- Labels
List<Pulumi.
Google Native. Service Management. V1. Inputs. Label Descriptor> 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 Pulumi.Google Native. Service Management. V1. Monitored Resource Descriptor Launch Stage 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 thetype
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
[]Label
Descriptor 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 MonitoredResource Descriptor Launch Stage 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 thetype
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<Label
Descriptor> 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 MonitoredResource Descriptor Launch Stage 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 thetype
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
Label
Descriptor[] 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 MonitoredResource Descriptor Launch Stage 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 thetype
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[Label
Descriptor] 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 MonitoredResource Descriptor Launch Stage 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 thetype
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.
- 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 thetype
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
- 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.
- Monitored
Resource Descriptor Launch Stage Launch Stage Unspecified - LAUNCH_STAGE_UNSPECIFIED
Do not use this default value.
- Monitored
Resource Descriptor Launch Stage Unimplemented - UNIMPLEMENTED
The feature is not yet implemented. Users can not use it.
- Monitored
Resource Descriptor Launch Stage Prelaunch - PRELAUNCH
Prelaunch features are hidden from users and are only visible internally.
- Monitored
Resource Descriptor Launch Stage Early Access - EARLY_ACCESS
Early Access features are limited to a closed group of testers. To use these features, you