Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

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

ServiceName string
Apis List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.ApiArgs>

A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

Authentication Pulumi.GoogleNative.ServiceManagement.V1.Inputs.AuthenticationArgs

Auth configuration.

Backend Pulumi.GoogleNative.ServiceManagement.V1.Inputs.BackendArgs

API backend configuration.

Billing Pulumi.GoogleNative.ServiceManagement.V1.Inputs.BillingArgs

Billing configuration.

ConfigVersion int

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

Context Pulumi.GoogleNative.ServiceManagement.V1.Inputs.ContextArgs

Context configuration.

Control Pulumi.GoogleNative.ServiceManagement.V1.Inputs.ControlArgs

Configuration for the service control plane.

CustomError Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CustomErrorArgs

Custom error configuration.

Documentation Pulumi.GoogleNative.ServiceManagement.V1.Inputs.DocumentationArgs

Additional API documentation.

Endpoints List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.EndpointArgs>

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

Enums List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.EnumArgs>

A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

Http Pulumi.GoogleNative.ServiceManagement.V1.Inputs.HttpArgs

HTTP configuration.

Id string

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.

Logging Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LoggingArgs

Logging configuration.

Logs List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LogDescriptorArgs>

Defines the logs used by this service.

Metrics List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MetricDescriptorArgs>

Defines the metrics used by this service.

MonitoredResources List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MonitoredResourceDescriptorArgs>

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

Monitoring Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MonitoringArgs

Monitoring configuration.

Name string

The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

ProducerProjectId string

The Google project that owns this service.

Quota Pulumi.GoogleNative.ServiceManagement.V1.Inputs.QuotaArgs

Quota configuration.

SystemParameters Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SystemParametersArgs

System parameter configuration.

SystemTypes List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.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<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.TypeArgs>

A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

Usage Pulumi.GoogleNative.ServiceManagement.V1.Inputs.UsageArgs

Configuration controlling usage of this service.

ServiceName string
Apis []ApiArgs

A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

Authentication AuthenticationArgs

Auth configuration.

Backend BackendArgs

API backend configuration.

Billing BillingArgs

Billing configuration.

ConfigVersion int

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

Context ContextArgs

Context configuration.

Control ControlArgs

Configuration for the service control plane.

CustomError CustomErrorArgs

Custom error configuration.

Documentation DocumentationArgs

Additional API documentation.

Endpoints []EndpointArgs

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

Enums []EnumArgs

A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

Http HttpArgs

HTTP configuration.

Id string

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.

Logging LoggingArgs

Logging configuration.

Logs []LogDescriptorArgs

Defines the logs used by this service.

Metrics []MetricDescriptorArgs

Defines the metrics used by this service.

MonitoredResources []MonitoredResourceDescriptorArgs

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

Monitoring MonitoringArgs

Monitoring configuration.

Name string

The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

ProducerProjectId string

The Google project that owns this service.

Quota QuotaArgs

Quota configuration.

SystemParameters SystemParametersArgs

System parameter configuration.

SystemTypes []TypeArgs

A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.

Title string

The product title for this service, it is the name displayed in Google Cloud Console.

Types []TypeArgs

A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

Usage UsageArgs

Configuration controlling usage of this service.

serviceName String
apis List<ApiArgs>

A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

authentication AuthenticationArgs

Auth configuration.

backend BackendArgs

API backend configuration.

billing BillingArgs

Billing configuration.

configVersion Integer

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

context ContextArgs

Context configuration.

control ControlArgs

Configuration for the service control plane.

customError CustomErrorArgs

Custom error configuration.

documentation DocumentationArgs

Additional API documentation.

endpoints List<EndpointArgs>

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

enums List<EnumArgs>

A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

http HttpArgs

HTTP configuration.

id String

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.

logging LoggingArgs

Logging configuration.

logs List<LogDescriptorArgs>

Defines the logs used by this service.

metrics List<MetricDescriptorArgs>

Defines the metrics used by this service.

monitoredResources List<MonitoredResourceDescriptorArgs>

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

monitoring MonitoringArgs

Monitoring configuration.

name String

The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

producerProjectId String

The Google project that owns this service.

quota QuotaArgs

Quota configuration.

systemParameters SystemParametersArgs

System parameter configuration.

systemTypes 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<TypeArgs>

A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

usage UsageArgs

Configuration controlling usage of this service.

serviceName string
apis ApiArgs[]

A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

authentication AuthenticationArgs

Auth configuration.

backend BackendArgs

API backend configuration.

billing BillingArgs

Billing configuration.

configVersion number

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

context ContextArgs

Context configuration.

control ControlArgs

Configuration for the service control plane.

customError CustomErrorArgs

Custom error configuration.

documentation DocumentationArgs

Additional API documentation.

endpoints EndpointArgs[]

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

enums EnumArgs[]

A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

http HttpArgs

HTTP configuration.

id string

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.

logging LoggingArgs

Logging configuration.

logs LogDescriptorArgs[]

Defines the logs used by this service.

metrics MetricDescriptorArgs[]

Defines the metrics used by this service.

monitoredResources MonitoredResourceDescriptorArgs[]

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

monitoring MonitoringArgs

Monitoring configuration.

name string

The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

producerProjectId string

The Google project that owns this service.

quota QuotaArgs

Quota configuration.

systemParameters SystemParametersArgs

System parameter configuration.

systemTypes TypeArgs[]

A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.

title string

The product title for this service, it is the name displayed in Google Cloud Console.

types TypeArgs[]

A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

usage UsageArgs

Configuration controlling usage of this service.

service_name str
apis Sequence[ApiArgs]

A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

authentication AuthenticationArgs

Auth configuration.

backend BackendArgs

API backend configuration.

billing BillingArgs

Billing configuration.

config_version int

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

context ContextArgs

Context configuration.

control ControlArgs

Configuration for the service control plane.

custom_error CustomErrorArgs

Custom error configuration.

documentation DocumentationArgs

Additional API documentation.

endpoints Sequence[EndpointArgs]

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

enums Sequence[EnumArgs]

A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

http HttpArgs

HTTP configuration.

id str

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.

logging LoggingArgs

Logging configuration.

logs Sequence[LogDescriptorArgs]

Defines the logs used by this service.

metrics Sequence[MetricDescriptorArgs]

Defines the metrics used by this service.

monitored_resources Sequence[MonitoredResourceDescriptorArgs]

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

monitoring MonitoringArgs

Monitoring configuration.

name str

The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

producer_project_id str

The Google project that owns this service.

quota QuotaArgs

Quota configuration.

system_parameters SystemParametersArgs

System parameter configuration.

system_types Sequence[TypeArgs]

A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.

title str

The product title for this service, it is the name displayed in Google Cloud Console.

types Sequence[TypeArgs]

A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

usage UsageArgs

Configuration controlling usage of this service.

serviceName String
apis List<Property Map>

A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.

authentication Property Map

Auth configuration.

backend Property Map

API backend configuration.

billing Property Map

Billing configuration.

configVersion Number

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

context Property Map

Context configuration.

control Property Map

Configuration for the service control plane.

customError Property Map

Custom error configuration.

documentation Property Map

Additional API documentation.

endpoints List<Property Map>

Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.

enums List<Property Map>

A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum

http Property Map

HTTP configuration.

id String

A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.

logging Property Map

Logging configuration.

logs List<Property Map>

Defines the logs used by this service.

metrics List<Property Map>

Defines the metrics used by this service.

monitoredResources List<Property Map>

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

monitoring Property Map

Monitoring configuration.

name String

The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name.

producerProjectId String

The Google project that owns this service.

quota Property Map

Quota configuration.

systemParameters Property Map

System parameter configuration.

systemTypes List<Property Map>

A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.

title String

The product title for this service, it is the name displayed in Google Cloud Console.

types List<Property Map>

A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32

usage Property Map

Configuration controlling usage of this service.

Outputs

All input properties are implicitly available as output properties. Additionally, the Config resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

SourceInfo Pulumi.GoogleNative.ServiceManagement.V1.Outputs.SourceInfoResponse

The source information for this configuration if available.

Id string

The provider-assigned unique ID for this managed resource.

SourceInfo SourceInfoResponse

The source information for this configuration if available.

id String

The provider-assigned unique ID for this managed resource.

sourceInfo SourceInfoResponse

The source information for this configuration if available.

id string

The provider-assigned unique ID for this managed resource.

sourceInfo SourceInfoResponse

The source information for this configuration if available.

id str

The provider-assigned unique ID for this managed resource.

source_info SourceInfoResponse

The source information for this configuration if available.

id String

The provider-assigned unique ID for this managed resource.

sourceInfo Property Map

The source information for this configuration if available.

Supporting Types

Api

Methods List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Method>

The methods of this interface, in unspecified order.

Mixins List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Mixin>

Included interfaces. See Mixin.

Name string

The fully qualified name of this interface, including package name followed by the interface's simple name.

Options List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Option>

Any metadata attached to the interface.

SourceContext Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SourceContext

Source context for the protocol buffer service represented by this message.

Syntax Pulumi.GoogleNative.ServiceManagement.V1.ApiSyntax

The source syntax of the service.

Version string

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

Methods []Method

The methods of this interface, in unspecified order.

Mixins []Mixin

Included interfaces. See Mixin.

Name string

The fully qualified name of this interface, including package name followed by the interface's simple name.

Options []Option

Any metadata attached to the interface.

SourceContext SourceContext

Source context for the protocol buffer service represented by this message.

Syntax ApiSyntax

The source syntax of the service.

Version string

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

methods List<Method>

The methods of this interface, in unspecified order.

mixins List<Mixin>

Included interfaces. See Mixin.

name String

The fully qualified name of this interface, including package name followed by the interface's simple name.

options List<Option>

Any metadata attached to the interface.

sourceContext SourceContext

Source context for the protocol buffer service represented by this message.

syntax ApiSyntax

The source syntax of the service.

version String

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

methods Method[]

The methods of this interface, in unspecified order.

mixins Mixin[]

Included interfaces. See Mixin.

name string

The fully qualified name of this interface, including package name followed by the interface's simple name.

options Option[]

Any metadata attached to the interface.

sourceContext SourceContext

Source context for the protocol buffer service represented by this message.

syntax ApiSyntax

The source syntax of the service.

version string

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

methods Sequence[Method]

The methods of this interface, in unspecified order.

mixins Sequence[Mixin]

Included interfaces. See Mixin.

name str

The fully qualified name of this interface, including package name followed by the interface's simple name.

options Sequence[Option]

Any metadata attached to the interface.

source_context SourceContext

Source context for the protocol buffer service represented by this message.

syntax ApiSyntax

The source syntax of the service.

version str

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

methods List<Property Map>

The methods of this interface, in unspecified order.

mixins List<Property Map>

Included interfaces. See Mixin.

name String

The fully qualified name of this interface, including package name followed by the interface's simple name.

options List<Property Map>

Any metadata attached to the interface.

sourceContext Property Map

Source context for the protocol buffer service represented by this message.

syntax "SYNTAX_PROTO2" | "SYNTAX_PROTO3"

The source syntax of the service.

version String

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

ApiResponse

Methods List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MethodResponse>

The methods of this interface, in unspecified order.

Mixins List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MixinResponse>

Included interfaces. See Mixin.

Name string

The fully qualified name of this interface, including package name followed by the interface's simple name.

Options List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.OptionResponse>

Any metadata attached to the interface.

SourceContext Pulumi.GoogleNative.ServiceManagement.V1.Inputs.SourceContextResponse

Source context for the protocol buffer service represented by this message.

Syntax string

The source syntax of the service.

Version string

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

Methods []MethodResponse

The methods of this interface, in unspecified order.

Mixins []MixinResponse

Included interfaces. See Mixin.

Name string

The fully qualified name of this interface, including package name followed by the interface's simple name.

Options []OptionResponse

Any metadata attached to the interface.

SourceContext SourceContextResponse

Source context for the protocol buffer service represented by this message.

Syntax string

The source syntax of the service.

Version string

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

methods List<MethodResponse>

The methods of this interface, in unspecified order.

mixins List<MixinResponse>

Included interfaces. See Mixin.

name String

The fully qualified name of this interface, including package name followed by the interface's simple name.

options List<OptionResponse>

Any metadata attached to the interface.

sourceContext SourceContextResponse

Source context for the protocol buffer service represented by this message.

syntax String

The source syntax of the service.

version String

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

methods MethodResponse[]

The methods of this interface, in unspecified order.

mixins MixinResponse[]

Included interfaces. See Mixin.

name string

The fully qualified name of this interface, including package name followed by the interface's simple name.

options OptionResponse[]

Any metadata attached to the interface.

sourceContext SourceContextResponse

Source context for the protocol buffer service represented by this message.

syntax string

The source syntax of the service.

version string

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

methods Sequence[MethodResponse]

The methods of this interface, in unspecified order.

mixins Sequence[MixinResponse]

Included interfaces. See Mixin.

name str

The fully qualified name of this interface, including package name followed by the interface's simple name.

options Sequence[OptionResponse]

Any metadata attached to the interface.

source_context SourceContextResponse

Source context for the protocol buffer service represented by this message.

syntax str

The source syntax of the service.

version str

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

methods List<Property Map>

The methods of this interface, in unspecified order.

mixins List<Property Map>

Included interfaces. See Mixin.

name String

The fully qualified name of this interface, including package name followed by the interface's simple name.

options List<Property Map>

Any metadata attached to the interface.

sourceContext Property Map

Source context for the protocol buffer service represented by this message.

syntax String

The source syntax of the service.

version String

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end in v, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

ApiSyntax

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

SyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

ApiSyntaxSyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

ApiSyntaxSyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

SyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

SyntaxProto3
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

AuthorizationUrl string

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

Id string

The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".

Issuer string

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

JwksUri string

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

JwtLocations List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.JwtLocation>

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

Audiences string

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

AuthorizationUrl string

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

Id string

The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".

Issuer string

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

JwksUri string

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

JwtLocations []JwtLocation

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

audiences String

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

authorizationUrl String

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

id String

The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".

issuer String

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwksUri String

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

jwtLocations List<JwtLocation>

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

audiences string

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

authorizationUrl string

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

id string

The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".

issuer string

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwksUri string

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

jwtLocations JwtLocation[]

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

audiences str

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

authorization_url str

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

id str

The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".

issuer str

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwks_uri str

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

jwt_locations Sequence[JwtLocation]

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

audiences String

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

authorizationUrl String

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

id String

The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth".

issuer String

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwksUri String

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

jwtLocations List<Property Map>

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

AuthProviderResponse

Audiences string

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

AuthorizationUrl string

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

Issuer string

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

JwksUri string

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

JwtLocations List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.JwtLocationResponse>

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

Audiences string

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

AuthorizationUrl string

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

Issuer string

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

JwksUri string

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

JwtLocations []JwtLocationResponse

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

audiences String

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

authorizationUrl String

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

issuer String

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwksUri String

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

jwtLocations List<JwtLocationResponse>

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

audiences string

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

authorizationUrl string

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

issuer string

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwksUri string

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

jwtLocations JwtLocationResponse[]

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

audiences str

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

authorization_url str

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

issuer str

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwks_uri str

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

jwt_locations Sequence[JwtLocationResponse]

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

audiences String

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

authorizationUrl String

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

issuer String

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com

jwksUri String

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs

jwtLocations List<Property Map>

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token

AuthRequirement

Audiences string

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

ProviderId string

id from authentication provider. Example: provider_id: bookstore_auth

Audiences string

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

ProviderId string

id from authentication provider. Example: provider_id: bookstore_auth

audiences String

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

providerId String

id from authentication provider. Example: provider_id: bookstore_auth

audiences string

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

providerId string

id from authentication provider. Example: provider_id: bookstore_auth

audiences str

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

provider_id str

id from authentication provider. Example: provider_id: bookstore_auth

audiences String

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

providerId String

id from authentication provider. Example: provider_id: bookstore_auth

AuthRequirementResponse

Audiences string

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

ProviderId string

id from authentication provider. Example: provider_id: bookstore_auth

Audiences string

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

ProviderId string

id from authentication provider. Example: provider_id: bookstore_auth

audiences String

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

providerId String

id from authentication provider. Example: provider_id: bookstore_auth

audiences string

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

providerId string

id from authentication provider. Example: provider_id: bookstore_auth

audiences str

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

provider_id str

id from authentication provider. Example: provider_id: bookstore_auth

audiences String

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

providerId String

id from authentication provider. Example: provider_id: bookstore_auth

Authentication

Providers List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.AuthProvider>

Defines a set of authentication providers that a service supports.

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.AuthenticationRule>

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

Providers []AuthProvider

Defines a set of authentication providers that a service supports.

Rules []AuthenticationRule

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

providers List<AuthProvider>

Defines a set of authentication providers that a service supports.

rules List<AuthenticationRule>

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

providers AuthProvider[]

Defines a set of authentication providers that a service supports.

rules AuthenticationRule[]

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

providers Sequence[AuthProvider]

Defines a set of authentication providers that a service supports.

rules Sequence[AuthenticationRule]

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

providers List<Property Map>

Defines a set of authentication providers that a service supports.

rules List<Property Map>

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

AuthenticationResponse

Providers List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.AuthProviderResponse>

Defines a set of authentication providers that a service supports.

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.AuthenticationRuleResponse>

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

Providers []AuthProviderResponse

Defines a set of authentication providers that a service supports.

Rules []AuthenticationRuleResponse

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

providers List<AuthProviderResponse>

Defines a set of authentication providers that a service supports.

rules List<AuthenticationRuleResponse>

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

providers AuthProviderResponse[]

Defines a set of authentication providers that a service supports.

rules AuthenticationRuleResponse[]

A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

providers Sequence[AuthProviderResponse]

Defines a set of authentication providers that a service supports.

rules Sequence[AuthenticationRuleResponse]

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

AllowWithoutCredential bool

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

Oauth Pulumi.GoogleNative.ServiceManagement.V1.Inputs.OAuthRequirements

The requirements for OAuth credentials.

Requirements List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.AuthRequirement>

Requirements for additional authentication providers.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

AllowWithoutCredential bool

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

Oauth OAuthRequirements

The requirements for OAuth credentials.

Requirements []AuthRequirement

Requirements for additional authentication providers.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowWithoutCredential Boolean

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth OAuthRequirements

The requirements for OAuth credentials.

requirements List<AuthRequirement>

Requirements for additional authentication providers.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowWithoutCredential boolean

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth OAuthRequirements

The requirements for OAuth credentials.

requirements AuthRequirement[]

Requirements for additional authentication providers.

selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

allow_without_credential bool

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth OAuthRequirements

The requirements for OAuth credentials.

requirements Sequence[AuthRequirement]

Requirements for additional authentication providers.

selector str

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowWithoutCredential Boolean

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth Property Map

The requirements for OAuth credentials.

requirements List<Property Map>

Requirements for additional authentication providers.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

AuthenticationRuleResponse

AllowWithoutCredential bool

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

Oauth Pulumi.GoogleNative.ServiceManagement.V1.Inputs.OAuthRequirementsResponse

The requirements for OAuth credentials.

Requirements List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.AuthRequirementResponse>

Requirements for additional authentication providers.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

AllowWithoutCredential bool

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

Oauth OAuthRequirementsResponse

The requirements for OAuth credentials.

Requirements []AuthRequirementResponse

Requirements for additional authentication providers.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowWithoutCredential Boolean

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth OAuthRequirementsResponse

The requirements for OAuth credentials.

requirements List<AuthRequirementResponse>

Requirements for additional authentication providers.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowWithoutCredential boolean

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth OAuthRequirementsResponse

The requirements for OAuth credentials.

requirements AuthRequirementResponse[]

Requirements for additional authentication providers.

selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

allow_without_credential bool

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth OAuthRequirementsResponse

The requirements for OAuth credentials.

requirements Sequence[AuthRequirementResponse]

Requirements for additional authentication providers.

selector str

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowWithoutCredential Boolean

If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

oauth Property Map

The requirements for OAuth credentials.

requirements List<Property Map>

Requirements for additional authentication providers.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

Backend

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.BackendRule>

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

Rules []BackendRule

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules List<BackendRule>

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules BackendRule[]

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules Sequence[BackendRule]

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules List<Property Map>

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

BackendResponse

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.BackendRuleResponse>

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

Rules []BackendRuleResponse

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules List<BackendRuleResponse>

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules BackendRuleResponse[]

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules Sequence[BackendRuleResponse]

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules List<Property Map>

A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

BackendRule

Address string

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

Deadline double

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

DisableAuth bool

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

JwtAudience string

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

OperationDeadline double

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

PathTranslation Pulumi.GoogleNative.ServiceManagement.V1.BackendRulePathTranslation
Protocol string

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

Address string

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

Deadline float64

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

DisableAuth bool

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

JwtAudience string

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

OperationDeadline float64

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

PathTranslation BackendRulePathTranslation
Protocol string

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

address String

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

deadline Double

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

disableAuth Boolean

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

jwtAudience String

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

operationDeadline Double

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

pathTranslation BackendRulePathTranslation
protocol String

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

address string

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

deadline number

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

disableAuth boolean

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

jwtAudience string

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

operationDeadline number

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

pathTranslation BackendRulePathTranslation
protocol string

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

address str

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

deadline float

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

disable_auth bool

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

jwt_audience str

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

operation_deadline float

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

path_translation BackendRulePathTranslation
protocol str

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

selector str

Selects the methods to which this rule applies. Refer to selector for syntax details.

address String

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

deadline Number

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

disableAuth Boolean

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

jwtAudience String

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

operationDeadline Number

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

pathTranslation "PATH_TRANSLATION_UNSPECIFIED" | "CONSTANT_ADDRESS" | "APPEND_PATH_TO_ADDRESS"
protocol String

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

BackendRulePathTranslation

PathTranslationUnspecified
PATH_TRANSLATION_UNSPECIFIED
ConstantAddress
CONSTANT_ADDRESS

Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe

AppendPathToAddress
APPEND_PATH_TO_ADDRESS

The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST

BackendRulePathTranslationPathTranslationUnspecified
PATH_TRANSLATION_UNSPECIFIED
BackendRulePathTranslationConstantAddress
CONSTANT_ADDRESS

Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe

BackendRulePathTranslationAppendPathToAddress
APPEND_PATH_TO_ADDRESS

The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST

PathTranslationUnspecified
PATH_TRANSLATION_UNSPECIFIED
ConstantAddress
CONSTANT_ADDRESS

Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe

AppendPathToAddress
APPEND_PATH_TO_ADDRESS

The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST

PathTranslationUnspecified
PATH_TRANSLATION_UNSPECIFIED
ConstantAddress
CONSTANT_ADDRESS

Use the backend address as-is, with no modification to the path. If the URL pattern contains variables, the variable names and values will be appended to the query string. If a query string parameter and a URL pattern variable have the same name, this may result in duplicate keys in the query string. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.cloudfunctions.net/getUser Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.cloudfunctions.net/getUser?cid=widgetworks&uid=johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.cloudfunctions.net/getUser?timezone=EST&cid=widgetworks&uid=johndoe

AppendPathToAddress
APPEND_PATH_TO_ADDRESS

The request path will be appended to the backend address. # Examples Given the following operation config: Method path: /api/company/{cid}/user/{uid} Backend address: https://example.appspot.com Requests to the following request paths will call the backend at the translated path: Request path: /api/company/widgetworks/user/johndoe Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe Request path: /api/company/widgetworks/user/johndoe?timezone=EST Translated: https://example.appspot.com/api/company/widgetworks/user/johndoe?timezone=EST

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.

DisableAuth bool

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

JwtAudience string

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

OperationDeadline double

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

PathTranslation string
Protocol string

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

Address string

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

Deadline float64

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

DisableAuth bool

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

JwtAudience string

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

OperationDeadline float64

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

PathTranslation string
Protocol string

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

address String

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

deadline Double

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

disableAuth Boolean

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

jwtAudience String

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

operationDeadline Double

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

pathTranslation String
protocol String

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

address string

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

deadline number

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

disableAuth boolean

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

jwtAudience string

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

operationDeadline number

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

pathTranslation string
protocol string

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

address str

The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.

deadline float

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

disable_auth bool

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

jwt_audience str

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

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.

disableAuth Boolean

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

jwtAudience String

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

operationDeadline Number

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

pathTranslation String
protocol String

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

Billing

ConsumerDestinations List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.BillingDestination>

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

ConsumerDestinations []BillingDestination

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

consumerDestinations List<BillingDestination>

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

consumerDestinations BillingDestination[]

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

consumer_destinations Sequence[BillingDestination]

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

consumerDestinations List<Property Map>

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

BillingDestination

Metrics List<string>

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

MonitoredResource string

The monitored resource type. The type must be defined in Service.monitored_resources section.

Metrics []string

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

MonitoredResource string

The monitored resource type. The type must be defined in Service.monitored_resources section.

metrics List<String>

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

monitoredResource String

The monitored resource type. The type must be defined in Service.monitored_resources section.

metrics string[]

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

monitoredResource string

The monitored resource type. The type must be defined in Service.monitored_resources section.

metrics Sequence[str]

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

monitored_resource str

The monitored resource type. The type must be defined in Service.monitored_resources section.

metrics List<String>

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

monitoredResource String

The monitored resource type. The type must be defined in Service.monitored_resources section.

BillingDestinationResponse

Metrics List<string>

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

MonitoredResource string

The monitored resource type. The type must be defined in Service.monitored_resources section.

Metrics []string

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

MonitoredResource string

The monitored resource type. The type must be defined in Service.monitored_resources section.

metrics List<String>

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

monitoredResource String

The monitored resource type. The type must be defined in Service.monitored_resources section.

metrics string[]

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

monitoredResource string

The monitored resource type. The type must be defined in Service.monitored_resources section.

metrics Sequence[str]

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

monitored_resource str

The monitored resource type. The type must be defined in Service.monitored_resources section.

metrics List<String>

Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.

monitoredResource String

The monitored resource type. The type must be defined in Service.monitored_resources section.

BillingResponse

ConsumerDestinations List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.BillingDestinationResponse>

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

ConsumerDestinations []BillingDestinationResponse

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

consumerDestinations List<BillingDestinationResponse>

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

consumerDestinations BillingDestinationResponse[]

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

consumer_destinations Sequence[BillingDestinationResponse]

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

consumerDestinations List<Property Map>

Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.

Context

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.ContextRule>

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

Rules []ContextRule

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules List<ContextRule>

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules ContextRule[]

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules Sequence[ContextRule]

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules List<Property Map>

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

ContextResponse

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.ContextRuleResponse>

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

Rules []ContextRuleResponse

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules List<ContextRuleResponse>

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules ContextRuleResponse[]

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules Sequence[ContextRuleResponse]

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

rules List<Property Map>

A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

ContextRule

AllowedRequestExtensions List<string>

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

AllowedResponseExtensions List<string>

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

Provided List<string>

A list of full type names of provided contexts.

Requested List<string>

A list of full type names of requested contexts.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

AllowedRequestExtensions []string

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

AllowedResponseExtensions []string

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

Provided []string

A list of full type names of provided contexts.

Requested []string

A list of full type names of requested contexts.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowedRequestExtensions List<String>

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowedResponseExtensions List<String>

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided List<String>

A list of full type names of provided contexts.

requested List<String>

A list of full type names of requested contexts.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowedRequestExtensions string[]

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowedResponseExtensions string[]

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided string[]

A list of full type names of provided contexts.

requested string[]

A list of full type names of requested contexts.

selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowed_request_extensions Sequence[str]

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowed_response_extensions Sequence[str]

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided Sequence[str]

A list of full type names of provided contexts.

requested Sequence[str]

A list of full type names of requested contexts.

selector str

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowedRequestExtensions List<String>

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowedResponseExtensions List<String>

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided List<String>

A list of full type names of provided contexts.

requested List<String>

A list of full type names of requested contexts.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

ContextRuleResponse

AllowedRequestExtensions List<string>

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

AllowedResponseExtensions List<string>

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

Provided List<string>

A list of full type names of provided contexts.

Requested List<string>

A list of full type names of requested contexts.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

AllowedRequestExtensions []string

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

AllowedResponseExtensions []string

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

Provided []string

A list of full type names of provided contexts.

Requested []string

A list of full type names of requested contexts.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowedRequestExtensions List<String>

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowedResponseExtensions List<String>

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided List<String>

A list of full type names of provided contexts.

requested List<String>

A list of full type names of requested contexts.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowedRequestExtensions string[]

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowedResponseExtensions string[]

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided string[]

A list of full type names of provided contexts.

requested string[]

A list of full type names of requested contexts.

selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowed_request_extensions Sequence[str]

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowed_response_extensions Sequence[str]

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided Sequence[str]

A list of full type names of provided contexts.

requested Sequence[str]

A list of full type names of requested contexts.

selector str

Selects the methods to which this rule applies. Refer to selector for syntax details.

allowedRequestExtensions List<String>

A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.

allowedResponseExtensions List<String>

A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.

provided List<String>

A list of full type names of provided contexts.

requested List<String>

A list of full type names of requested contexts.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

Control

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.GoogleNative.ServiceManagement.V1.Inputs.CustomErrorRule>

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

Types List<string>

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

Rules []CustomErrorRule

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

Types []string

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

rules List<CustomErrorRule>

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

types List<String>

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

rules CustomErrorRule[]

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

types string[]

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

rules Sequence[CustomErrorRule]

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

types Sequence[str]

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

rules List<Property Map>

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

types List<String>

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

CustomErrorResponse

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CustomErrorRuleResponse>

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

Types List<string>

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

Rules []CustomErrorRuleResponse

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

Types []string

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

rules List<CustomErrorRuleResponse>

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

types List<String>

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

rules CustomErrorRuleResponse[]

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

types string[]

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

rules Sequence[CustomErrorRuleResponse]

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

types Sequence[str]

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

rules List<Property Map>

The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.

types List<String>

The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.

CustomErrorRule

IsErrorType bool

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

Selector string

Selects messages to which this rule applies. Refer to selector for syntax details.

IsErrorType bool

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

Selector string

Selects messages to which this rule applies. Refer to selector for syntax details.

isErrorType Boolean

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

selector String

Selects messages to which this rule applies. Refer to selector for syntax details.

isErrorType boolean

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

selector string

Selects messages to which this rule applies. Refer to selector for syntax details.

is_error_type bool

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

selector str

Selects messages to which this rule applies. Refer to selector for syntax details.

isErrorType Boolean

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

selector String

Selects messages to which this rule applies. Refer to selector for syntax details.

CustomErrorRuleResponse

IsErrorType bool

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

Selector string

Selects messages to which this rule applies. Refer to selector for syntax details.

IsErrorType bool

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

Selector string

Selects messages to which this rule applies. Refer to selector for syntax details.

isErrorType Boolean

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

selector String

Selects messages to which this rule applies. Refer to selector for syntax details.

isErrorType boolean

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

selector string

Selects messages to which this rule applies. Refer to selector for syntax details.

is_error_type bool

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

selector str

Selects messages to which this rule applies. Refer to selector for syntax details.

isErrorType Boolean

Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.

selector String

Selects messages to which this rule applies. Refer to selector for syntax details.

CustomHttpPattern

Kind string

The name of this custom HTTP verb.

Path string

The path matched by this custom verb.

Kind string

The name of this custom HTTP verb.

Path string

The path matched by this custom verb.

kind String

The name of this custom HTTP verb.

path String

The path matched by this custom verb.

kind string

The name of this custom HTTP verb.

path string

The path matched by this custom verb.

kind str

The name of this custom HTTP verb.

path str

The path matched by this custom verb.

kind String

The name of this custom HTTP verb.

path String

The path matched by this custom verb.

CustomHttpPatternResponse

Kind string

The name of this custom HTTP verb.

Path string

The path matched by this custom verb.

Kind string

The name of this custom HTTP verb.

Path string

The path matched by this custom verb.

kind String

The name of this custom HTTP verb.

path String

The path matched by this custom verb.

kind string

The name of this custom HTTP verb.

path string

The path matched by this custom verb.

kind str

The name of this custom HTTP verb.

path str

The path matched by this custom verb.

kind String

The name of this custom HTTP verb.

path String

The path matched by this custom verb.

Documentation

DocumentationRootUrl string

The URL to the root of documentation.

Overview string

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

Pages List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Page>

The top level pages for the documentation set.

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.DocumentationRule>

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

ServiceRootUrl string

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

Summary string

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

DocumentationRootUrl string

The URL to the root of documentation.

Overview string

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

Pages []Page

The top level pages for the documentation set.

Rules []DocumentationRule

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

ServiceRootUrl string

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

Summary string

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

documentationRootUrl String

The URL to the root of documentation.

overview String

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

pages List<Page>

The top level pages for the documentation set.

rules List<DocumentationRule>

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

serviceRootUrl String

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

summary String

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

documentationRootUrl string

The URL to the root of documentation.

overview string

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

pages Page[]

The top level pages for the documentation set.

rules DocumentationRule[]

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

serviceRootUrl string

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

summary string

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

documentation_root_url str

The URL to the root of documentation.

overview str

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

pages Sequence[Page]

The top level pages for the documentation set.

rules Sequence[DocumentationRule]

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

service_root_url str

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

summary str

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

documentationRootUrl String

The URL to the root of documentation.

overview String

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

pages List<Property Map>

The top level pages for the documentation set.

rules List<Property Map>

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

serviceRootUrl String

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

summary String

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

DocumentationResponse

DocumentationRootUrl string

The URL to the root of documentation.

Overview string

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

Pages List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.PageResponse>

The top level pages for the documentation set.

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.DocumentationRuleResponse>

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

ServiceRootUrl string

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

Summary string

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

DocumentationRootUrl string

The URL to the root of documentation.

Overview string

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

Pages []PageResponse

The top level pages for the documentation set.

Rules []DocumentationRuleResponse

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

ServiceRootUrl string

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

Summary string

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

documentationRootUrl String

The URL to the root of documentation.

overview String

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

pages List<PageResponse>

The top level pages for the documentation set.

rules List<DocumentationRuleResponse>

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

serviceRootUrl String

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

summary String

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

documentationRootUrl string

The URL to the root of documentation.

overview string

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

pages PageResponse[]

The top level pages for the documentation set.

rules DocumentationRuleResponse[]

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

serviceRootUrl string

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

summary string

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

documentation_root_url str

The URL to the root of documentation.

overview str

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

pages Sequence[PageResponse]

The top level pages for the documentation set.

rules Sequence[DocumentationRuleResponse]

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

service_root_url str

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

summary str

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

documentationRootUrl String

The URL to the root of documentation.

overview String

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both overview field and pages field.

pages List<Property Map>

The top level pages for the documentation set.

rules List<Property Map>

A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.

serviceRootUrl String

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

summary String

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field description.

DocumentationRule

DeprecationDescription string

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Description string

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

Selector string

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

DeprecationDescription string

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Description string

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

Selector string

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

deprecationDescription String

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

description String

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

selector String

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

deprecationDescription string

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

description string

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

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.

deprecationDescription String

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

description String

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

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

DeprecationDescription string

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Description string

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

Selector string

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

DeprecationDescription string

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Description string

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

Selector string

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

deprecationDescription String

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

description String

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

selector String

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.

deprecationDescription string

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

description string

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

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.

deprecationDescription String

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

description String

Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

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

AllowCors bool

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

Name string

The canonical name of this endpoint.

Target string

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

AllowCors bool

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

Name string

The canonical name of this endpoint.

Target string

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

allowCors Boolean

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

name String

The canonical name of this endpoint.

target String

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

allowCors boolean

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

name string

The canonical name of this endpoint.

target string

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

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

allowCors Boolean

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

name String

The canonical name of this endpoint.

target String

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

EndpointResponse

AllowCors bool

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

Name string

The canonical name of this endpoint.

Target string

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

AllowCors bool

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

Name string

The canonical name of this endpoint.

Target string

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

allowCors Boolean

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

name String

The canonical name of this endpoint.

target String

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

allowCors boolean

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

name string

The canonical name of this endpoint.

target string

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

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

allowCors Boolean

Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.

name String

The canonical name of this endpoint.

target String

The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".

Enum

Enumvalue []EnumValue

Enum value definitions.

Name string

Enum type name.

Options []Option

Protocol buffer options.

SourceContext SourceContext

The source context.

Syntax EnumSyntax

The source syntax.

enumvalue List<EnumValue>

Enum value definitions.

name String

Enum type name.

options List<Option>

Protocol buffer options.

sourceContext SourceContext

The source context.

syntax EnumSyntax

The source syntax.

enumvalue EnumValue[]

Enum value definitions.

name string

Enum type name.

options Option[]

Protocol buffer options.

sourceContext SourceContext

The source context.

syntax EnumSyntax

The source syntax.

enumvalue Sequence[EnumValue]

Enum value definitions.

name str

Enum type name.

options Sequence[Option]

Protocol buffer options.

source_context SourceContext

The source context.

syntax EnumSyntax

The source syntax.

enumvalue List<Property Map>

Enum value definitions.

name String

Enum type name.

options List<Property Map>

Protocol buffer options.

sourceContext Property Map

The source context.

syntax "SYNTAX_PROTO2" | "SYNTAX_PROTO3"

The source syntax.

EnumResponse

Enumvalue []EnumValueResponse

Enum value definitions.

Name string

Enum type name.

Options []OptionResponse

Protocol buffer options.

SourceContext SourceContextResponse

The source context.

Syntax string

The source syntax.

enumvalue List<EnumValueResponse>

Enum value definitions.

name String

Enum type name.

options List<OptionResponse>

Protocol buffer options.

sourceContext SourceContextResponse

The source context.

syntax String

The source syntax.

enumvalue EnumValueResponse[]

Enum value definitions.

name string

Enum type name.

options OptionResponse[]

Protocol buffer options.

sourceContext SourceContextResponse

The source context.

syntax string

The source syntax.

enumvalue Sequence[EnumValueResponse]

Enum value definitions.

name str

Enum type name.

options Sequence[OptionResponse]

Protocol buffer options.

source_context SourceContextResponse

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.

sourceContext Property Map

The source context.

syntax String

The source syntax.

EnumSyntax

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

SyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

EnumSyntaxSyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

EnumSyntaxSyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

SyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

SyntaxProto3
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.GoogleNative.ServiceManagement.V1.Inputs.Option>

Protocol buffer options.

Name string

Enum value name.

Number int

Enum value number.

Options []Option

Protocol buffer options.

name String

Enum value name.

number Integer

Enum value number.

options List<Option>

Protocol buffer options.

name string

Enum value name.

number number

Enum value number.

options 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.GoogleNative.ServiceManagement.V1.Inputs.OptionResponse>

Protocol buffer options.

Name string

Enum value name.

Number int

Enum value number.

Options []OptionResponse

Protocol buffer options.

name String

Enum value name.

number Integer

Enum value number.

options List<OptionResponse>

Protocol buffer options.

name string

Enum value name.

number number

Enum value number.

options OptionResponse[]

Protocol buffer options.

name str

Enum value name.

number int

Enum value number.

options Sequence[OptionResponse]

Protocol buffer options.

name String

Enum value name.

number Number

Enum value number.

options List<Property Map>

Protocol buffer options.

Field

Cardinality Pulumi.GoogleNative.ServiceManagement.V1.FieldCardinality

The field cardinality.

DefaultValue string

The string value of the default value of this field. Proto2 syntax only.

JsonName string

The field JSON name.

Kind Pulumi.GoogleNative.ServiceManagement.V1.FieldKind

The field type.

Name string

The field name.

Number int

The field number.

OneofIndex int

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

Options List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Option>

The protocol buffer options.

Packed bool

Whether to use alternative packed wire representation.

TypeUrl string

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Cardinality FieldCardinality

The field cardinality.

DefaultValue string

The string value of the default value of this field. Proto2 syntax only.

JsonName string

The field JSON name.

Kind FieldKind

The field type.

Name string

The field name.

Number int

The field number.

OneofIndex int

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

Options []Option

The protocol buffer options.

Packed bool

Whether to use alternative packed wire representation.

TypeUrl string

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

cardinality FieldCardinality

The field cardinality.

defaultValue String

The string value of the default value of this field. Proto2 syntax only.

jsonName String

The field JSON name.

kind FieldKind

The field type.

name String

The field name.

number Integer

The field number.

oneofIndex Integer

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

options List<Option>

The protocol buffer options.

packed Boolean

Whether to use alternative packed wire representation.

typeUrl String

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

cardinality FieldCardinality

The field cardinality.

defaultValue string

The string value of the default value of this field. Proto2 syntax only.

jsonName string

The field JSON name.

kind FieldKind

The field type.

name string

The field name.

number number

The field number.

oneofIndex number

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

options Option[]

The protocol buffer options.

packed boolean

Whether to use alternative packed wire representation.

typeUrl string

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

cardinality FieldCardinality

The field cardinality.

default_value str

The string value of the default value of this field. Proto2 syntax only.

json_name str

The field JSON name.

kind FieldKind

The field type.

name str

The field name.

number int

The field number.

oneof_index int

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

options Sequence[Option]

The protocol buffer options.

packed bool

Whether to use alternative packed wire representation.

type_url str

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

cardinality "CARDINALITY_UNKNOWN" | "CARDINALITY_OPTIONAL" | "CARDINALITY_REQUIRED" | "CARDINALITY_REPEATED"

The field cardinality.

defaultValue String

The string value of the default value of this field. Proto2 syntax only.

jsonName String

The field JSON name.

kind "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.

oneofIndex Number

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

options List<Property Map>

The protocol buffer options.

packed Boolean

Whether to use alternative packed wire representation.

typeUrl String

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

FieldCardinality

CardinalityUnknown
CARDINALITY_UNKNOWN

For fields with unknown cardinality.

CardinalityOptional
CARDINALITY_OPTIONAL

For optional fields.

CardinalityRequired
CARDINALITY_REQUIRED

For required fields. Proto2 syntax only.

CardinalityRepeated
CARDINALITY_REPEATED

For repeated fields.

FieldCardinalityCardinalityUnknown
CARDINALITY_UNKNOWN

For fields with unknown cardinality.

FieldCardinalityCardinalityOptional
CARDINALITY_OPTIONAL

For optional fields.

FieldCardinalityCardinalityRequired
CARDINALITY_REQUIRED

For required fields. Proto2 syntax only.

FieldCardinalityCardinalityRepeated
CARDINALITY_REPEATED

For repeated fields.

CardinalityUnknown
CARDINALITY_UNKNOWN

For fields with unknown cardinality.

CardinalityOptional
CARDINALITY_OPTIONAL

For optional fields.

CardinalityRequired
CARDINALITY_REQUIRED

For required fields. Proto2 syntax only.

CardinalityRepeated
CARDINALITY_REPEATED

For repeated fields.

CardinalityUnknown
CARDINALITY_UNKNOWN

For fields with unknown cardinality.

CardinalityOptional
CARDINALITY_OPTIONAL

For optional fields.

CardinalityRequired
CARDINALITY_REQUIRED

For required fields. Proto2 syntax only.

CardinalityRepeated
CARDINALITY_REPEATED

For repeated fields.

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

TypeUnknown
TYPE_UNKNOWN

Field type unknown.

TypeDouble
TYPE_DOUBLE

Field type double.

TypeFloat
TYPE_FLOAT

Field type float.

TypeInt64
TYPE_INT64

Field type int64.

TypeUint64
TYPE_UINT64

Field type uint64.

TypeInt32
TYPE_INT32

Field type int32.

TypeFixed64
TYPE_FIXED64

Field type fixed64.

TypeFixed32
TYPE_FIXED32

Field type fixed32.

TypeBool
TYPE_BOOL

Field type bool.

TypeString
TYPE_STRING

Field type string.

TypeGroup
TYPE_GROUP

Field type group. Proto2 syntax only, and deprecated.

TypeMessage
TYPE_MESSAGE

Field type message.

TypeBytes
TYPE_BYTES

Field type bytes.

TypeUint32
TYPE_UINT32

Field type uint32.

TypeEnum
TYPE_ENUM

Field type enum.

TypeSfixed32
TYPE_SFIXED32

Field type sfixed32.

TypeSfixed64
TYPE_SFIXED64

Field type sfixed64.

TypeSint32
TYPE_SINT32

Field type sint32.

TypeSint64
TYPE_SINT64

Field type sint64.

FieldKindTypeUnknown
TYPE_UNKNOWN

Field type unknown.

FieldKindTypeDouble
TYPE_DOUBLE

Field type double.

FieldKindTypeFloat
TYPE_FLOAT

Field type float.

FieldKindTypeInt64
TYPE_INT64

Field type int64.

FieldKindTypeUint64
TYPE_UINT64

Field type uint64.

FieldKindTypeInt32
TYPE_INT32

Field type int32.

FieldKindTypeFixed64
TYPE_FIXED64

Field type fixed64.

FieldKindTypeFixed32
TYPE_FIXED32

Field type fixed32.

FieldKindTypeBool
TYPE_BOOL

Field type bool.

FieldKindTypeString
TYPE_STRING

Field type string.

FieldKindTypeGroup
TYPE_GROUP

Field type group. Proto2 syntax only, and deprecated.

FieldKindTypeMessage
TYPE_MESSAGE

Field type message.

FieldKindTypeBytes
TYPE_BYTES

Field type bytes.

FieldKindTypeUint32
TYPE_UINT32

Field type uint32.

FieldKindTypeEnum
TYPE_ENUM

Field type enum.

FieldKindTypeSfixed32
TYPE_SFIXED32

Field type sfixed32.

FieldKindTypeSfixed64
TYPE_SFIXED64

Field type sfixed64.

FieldKindTypeSint32
TYPE_SINT32

Field type sint32.

FieldKindTypeSint64
TYPE_SINT64

Field type sint64.

TypeUnknown
TYPE_UNKNOWN

Field type unknown.

TypeDouble
TYPE_DOUBLE

Field type double.

TypeFloat
TYPE_FLOAT

Field type float.

TypeInt64
TYPE_INT64

Field type int64.

TypeUint64
TYPE_UINT64

Field type uint64.

TypeInt32
TYPE_INT32

Field type int32.

TypeFixed64
TYPE_FIXED64

Field type fixed64.

TypeFixed32
TYPE_FIXED32

Field type fixed32.

TypeBool
TYPE_BOOL

Field type bool.

TypeString
TYPE_STRING

Field type string.

TypeGroup
TYPE_GROUP

Field type group. Proto2 syntax only, and deprecated.

TypeMessage
TYPE_MESSAGE

Field type message.

TypeBytes
TYPE_BYTES

Field type bytes.

TypeUint32
TYPE_UINT32

Field type uint32.

TypeEnum
TYPE_ENUM

Field type enum.

TypeSfixed32
TYPE_SFIXED32

Field type sfixed32.

TypeSfixed64
TYPE_SFIXED64

Field type sfixed64.

TypeSint32
TYPE_SINT32

Field type sint32.

TypeSint64
TYPE_SINT64

Field type sint64.

TypeUnknown
TYPE_UNKNOWN

Field type unknown.

TypeDouble
TYPE_DOUBLE

Field type double.

TypeFloat
TYPE_FLOAT

Field type float.

TypeInt64
TYPE_INT64

Field type int64.

TypeUint64
TYPE_UINT64

Field type uint64.

TypeInt32
TYPE_INT32

Field type int32.

TypeFixed64
TYPE_FIXED64

Field type fixed64.

TypeFixed32
TYPE_FIXED32

Field type fixed32.

TypeBool
TYPE_BOOL

Field type bool.

TypeString
TYPE_STRING

Field type string.

TypeGroup
TYPE_GROUP

Field type group. Proto2 syntax only, and deprecated.

TypeMessage
TYPE_MESSAGE

Field type message.

TypeBytes
TYPE_BYTES

Field type bytes.

TypeUint32
TYPE_UINT32

Field type uint32.

TypeEnum
TYPE_ENUM

Field type enum.

TypeSfixed32
TYPE_SFIXED32

Field type sfixed32.

TypeSfixed64
TYPE_SFIXED64

Field type sfixed64.

TypeSint32
TYPE_SINT32

Field type sint32.

TypeSint64
TYPE_SINT64

Field type sint64.

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.

DefaultValue string

The string value of the default value of this field. Proto2 syntax only.

JsonName string

The field JSON name.

Kind string

The field type.

Name string

The field name.

Number int

The field number.

OneofIndex int

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

Options List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.OptionResponse>

The protocol buffer options.

Packed bool

Whether to use alternative packed wire representation.

TypeUrl string

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Cardinality string

The field cardinality.

DefaultValue string

The string value of the default value of this field. Proto2 syntax only.

JsonName string

The field JSON name.

Kind string

The field type.

Name string

The field name.

Number int

The field number.

OneofIndex int

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

Options []OptionResponse

The protocol buffer options.

Packed bool

Whether to use alternative packed wire representation.

TypeUrl string

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

cardinality String

The field cardinality.

defaultValue String

The string value of the default value of this field. Proto2 syntax only.

jsonName String

The field JSON name.

kind String

The field type.

name String

The field name.

number Integer

The field number.

oneofIndex Integer

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

options List<OptionResponse>

The protocol buffer options.

packed Boolean

Whether to use alternative packed wire representation.

typeUrl String

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

cardinality string

The field cardinality.

defaultValue string

The string value of the default value of this field. Proto2 syntax only.

jsonName string

The field JSON name.

kind string

The field type.

name string

The field name.

number number

The field number.

oneofIndex number

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

options OptionResponse[]

The protocol buffer options.

packed boolean

Whether to use alternative packed wire representation.

typeUrl string

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

cardinality str

The field cardinality.

default_value str

The string value of the default value of this field. Proto2 syntax only.

json_name str

The field JSON name.

kind str

The field type.

name str

The field name.

number int

The field number.

oneof_index int

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

options Sequence[OptionResponse]

The protocol buffer options.

packed bool

Whether to use alternative packed wire representation.

type_url str

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

cardinality String

The field cardinality.

defaultValue String

The string value of the default value of this field. Proto2 syntax only.

jsonName String

The field JSON name.

kind String

The field type.

name String

The field name.

number Number

The field number.

oneofIndex Number

The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.

options List<Property Map>

The protocol buffer options.

packed Boolean

Whether to use alternative packed wire representation.

typeUrl String

The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".

Http

FullyDecodeReservedExpansion bool

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.HttpRule>

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

FullyDecodeReservedExpansion bool

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

Rules []HttpRule

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

fullyDecodeReservedExpansion Boolean

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

rules List<HttpRule>

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

fullyDecodeReservedExpansion boolean

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

rules HttpRule[]

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

fully_decode_reserved_expansion bool

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

rules Sequence[HttpRule]

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

fullyDecodeReservedExpansion Boolean

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

rules List<Property Map>

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

HttpResponse

FullyDecodeReservedExpansion bool

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

Rules List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.HttpRuleResponse>

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

FullyDecodeReservedExpansion bool

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

Rules []HttpRuleResponse

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

fullyDecodeReservedExpansion Boolean

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

rules List<HttpRuleResponse>

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

fullyDecodeReservedExpansion boolean

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

rules HttpRuleResponse[]

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

fully_decode_reserved_expansion bool

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

rules Sequence[HttpRuleResponse]

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

fullyDecodeReservedExpansion Boolean

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

rules List<Property Map>

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

HttpRule

AdditionalBindings List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.HttpRule>

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

Body string

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

Custom Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CustomHttpPattern

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

Delete string

Maps to HTTP DELETE. Used for deleting a resource.

Get string

Maps to HTTP GET. Used for listing and getting information about resources.

Patch string

Maps to HTTP PATCH. Used for updating a resource.

Post string

Maps to HTTP POST. Used for creating a resource or performing an action.

Put string

Maps to HTTP PUT. Used for replacing a resource.

ResponseBody string

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

Selector string

Selects a method to which this rule applies. Refer to selector for syntax details.

AdditionalBindings []HttpRule

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

Body string

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

Custom CustomHttpPattern

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

Delete string

Maps to HTTP DELETE. Used for deleting a resource.

Get string

Maps to HTTP GET. Used for listing and getting information about resources.

Patch string

Maps to HTTP PATCH. Used for updating a resource.

Post string

Maps to HTTP POST. Used for creating a resource or performing an action.

Put string

Maps to HTTP PUT. Used for replacing a resource.

ResponseBody string

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

Selector string

Selects a method to which this rule applies. Refer to selector for syntax details.

additionalBindings List<HttpRule>

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

body String

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

custom CustomHttpPattern

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

delete String

Maps to HTTP DELETE. Used for deleting a resource.

get String

Maps to HTTP GET. Used for listing and getting information about resources.

patch String

Maps to HTTP PATCH. Used for updating a resource.

post String

Maps to HTTP POST. Used for creating a resource or performing an action.

put String

Maps to HTTP PUT. Used for replacing a resource.

responseBody String

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

selector String

Selects a method to which this rule applies. Refer to selector for syntax details.

additionalBindings HttpRule[]

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

body string

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

custom CustomHttpPattern

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

delete string

Maps to HTTP DELETE. Used for deleting a resource.

get string

Maps to HTTP GET. Used for listing and getting information about resources.

patch string

Maps to HTTP PATCH. Used for updating a resource.

post string

Maps to HTTP POST. Used for creating a resource or performing an action.

put string

Maps to HTTP PUT. Used for replacing a resource.

responseBody string

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

selector string

Selects a method to which this rule applies. Refer to selector for syntax details.

additional_bindings Sequence[HttpRule]

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

body str

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

custom CustomHttpPattern

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

delete str

Maps to HTTP DELETE. Used for deleting a resource.

get str

Maps to HTTP GET. Used for listing and getting information about resources.

patch str

Maps to HTTP PATCH. Used for updating a resource.

post str

Maps to HTTP POST. Used for creating a resource or performing an action.

put str

Maps to HTTP PUT. Used for replacing a resource.

response_body str

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

selector str

Selects a method to which this rule applies. Refer to selector for syntax details.

additionalBindings List<Property Map>

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

body String

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

custom Property Map

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

delete String

Maps to HTTP DELETE. Used for deleting a resource.

get String

Maps to HTTP GET. Used for listing and getting information about resources.

patch String

Maps to HTTP PATCH. Used for updating a resource.

post String

Maps to HTTP POST. Used for creating a resource or performing an action.

put String

Maps to HTTP PUT. Used for replacing a resource.

responseBody String

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

selector String

Selects a method to which this rule applies. Refer to selector for syntax details.

HttpRuleResponse

AdditionalBindings List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.HttpRuleResponse>

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

Body string

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

Custom Pulumi.GoogleNative.ServiceManagement.V1.Inputs.CustomHttpPatternResponse

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

Delete string

Maps to HTTP DELETE. Used for deleting a resource.

Get string

Maps to HTTP GET. Used for listing and getting information about resources.

Patch string

Maps to HTTP PATCH. Used for updating a resource.

Post string

Maps to HTTP POST. Used for creating a resource or performing an action.

Put string

Maps to HTTP PUT. Used for replacing a resource.

ResponseBody string

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

Selector string

Selects a method to which this rule applies. Refer to selector for syntax details.

AdditionalBindings []HttpRuleResponse

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

Body string

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

Custom CustomHttpPatternResponse

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

Delete string

Maps to HTTP DELETE. Used for deleting a resource.

Get string

Maps to HTTP GET. Used for listing and getting information about resources.

Patch string

Maps to HTTP PATCH. Used for updating a resource.

Post string

Maps to HTTP POST. Used for creating a resource or performing an action.

Put string

Maps to HTTP PUT. Used for replacing a resource.

ResponseBody string

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

Selector string

Selects a method to which this rule applies. Refer to selector for syntax details.

additionalBindings List<HttpRuleResponse>

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

body String

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

custom CustomHttpPatternResponse

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

delete String

Maps to HTTP DELETE. Used for deleting a resource.

get String

Maps to HTTP GET. Used for listing and getting information about resources.

patch String

Maps to HTTP PATCH. Used for updating a resource.

post String

Maps to HTTP POST. Used for creating a resource or performing an action.

put String

Maps to HTTP PUT. Used for replacing a resource.

responseBody String

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

selector String

Selects a method to which this rule applies. Refer to selector for syntax details.

additionalBindings HttpRuleResponse[]

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

body string

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

custom CustomHttpPatternResponse

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

delete string

Maps to HTTP DELETE. Used for deleting a resource.

get string

Maps to HTTP GET. Used for listing and getting information about resources.

patch string

Maps to HTTP PATCH. Used for updating a resource.

post string

Maps to HTTP POST. Used for creating a resource or performing an action.

put string

Maps to HTTP PUT. Used for replacing a resource.

responseBody string

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

selector string

Selects a method to which this rule applies. Refer to selector for syntax details.

additional_bindings Sequence[HttpRuleResponse]

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

body str

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

custom CustomHttpPatternResponse

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

delete str

Maps to HTTP DELETE. Used for deleting a resource.

get str

Maps to HTTP GET. Used for listing and getting information about resources.

patch str

Maps to HTTP PATCH. Used for updating a resource.

post str

Maps to HTTP POST. Used for creating a resource or performing an action.

put str

Maps to HTTP PUT. Used for replacing a resource.

response_body str

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

selector str

Selects a method to which this rule applies. Refer to selector for syntax details.

additionalBindings List<Property Map>

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep).

body String

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.

custom Property Map

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

delete String

Maps to HTTP DELETE. Used for deleting a resource.

get String

Maps to HTTP GET. Used for listing and getting information about resources.

patch String

Maps to HTTP PATCH. Used for updating a resource.

post String

Maps to HTTP POST. Used for creating a resource or performing an action.

put String

Maps to HTTP PUT. Used for replacing a resource.

responseBody String

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.

selector String

Selects a method to which this rule applies. Refer to selector for syntax details.

JwtLocation

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

ValuePrefix string

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

Cookie string

Specifies cookie name to extract JWT token.

Header string

Specifies HTTP header name to extract JWT token.

Query string

Specifies URL query parameter name to extract JWT token.

ValuePrefix string

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

cookie String

Specifies cookie name to extract JWT token.

header String

Specifies HTTP header name to extract JWT token.

query String

Specifies URL query parameter name to extract JWT token.

valuePrefix String

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

cookie string

Specifies cookie name to extract JWT token.

header string

Specifies HTTP header name to extract JWT token.

query string

Specifies URL query parameter name to extract JWT token.

valuePrefix string

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

cookie str

Specifies cookie name to extract JWT token.

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.

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

valuePrefix String

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

JwtLocationResponse

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

ValuePrefix string

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

Cookie string

Specifies cookie name to extract JWT token.

Header string

Specifies HTTP header name to extract JWT token.

Query string

Specifies URL query parameter name to extract JWT token.

ValuePrefix string

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

cookie String

Specifies cookie name to extract JWT token.

header String

Specifies HTTP header name to extract JWT token.

query String

Specifies URL query parameter name to extract JWT token.

valuePrefix String

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

cookie string

Specifies cookie name to extract JWT token.

header string

Specifies HTTP header name to extract JWT token.

query string

Specifies URL query parameter name to extract JWT token.

valuePrefix string

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

cookie str

Specifies cookie name to extract JWT token.

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.

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

valuePrefix String

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

LabelDescriptor

Description string

A human-readable description for the label.

Key string

The label key.

ValueType Pulumi.GoogleNative.ServiceManagement.V1.LabelDescriptorValueType

The type of data that can be assigned to the label.

Description string

A human-readable description for the label.

Key string

The label key.

ValueType LabelDescriptorValueType

The type of data that can be assigned to the label.

description String

A human-readable description for the label.

key String

The label key.

valueType LabelDescriptorValueType

The type of data that can be assigned to the label.

description string

A human-readable description for the label.

key string

The label key.

valueType LabelDescriptorValueType

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 LabelDescriptorValueType

The type of data that can be assigned to the label.

description String

A human-readable description for the label.

key String

The label key.

valueType "STRING" | "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.

ValueType string

The type of data that can be assigned to the label.

Description string

A human-readable description for the label.

Key string

The label key.

ValueType string

The type of data that can be assigned to the label.

description String

A human-readable description for the label.

key String

The label key.

valueType String

The type of data that can be assigned to the label.

description string

A human-readable description for the label.

key string

The label key.

valueType string

The type of data that can be assigned to the label.

description str

A human-readable description for the label.

key str

The label key.

value_type str

The type of data that can be assigned to the label.

description String

A human-readable description for the label.

key String

The label key.

valueType String

The type of data that can be assigned to the label.

LabelDescriptorValueType

String
STRING

A variable-length string. This is the default.

Bool
BOOL

Boolean; true or false.

Int64
INT64

A 64-bit signed integer.

LabelDescriptorValueTypeString
STRING

A variable-length string. This is the default.

LabelDescriptorValueTypeBool
BOOL

Boolean; true or false.

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

DisplayName string

The human-readable name for this log. This information appears on the user interface and should be concise.

Labels List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptor>

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

Name string

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

Description string

A human-readable description of this log. This information appears in the documentation and can contain details.

DisplayName string

The human-readable name for this log. This information appears on the user interface and should be concise.

Labels []LabelDescriptor

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

Name string

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

description String

A human-readable description of this log. This information appears in the documentation and can contain details.

displayName String

The human-readable name for this log. This information appears on the user interface and should be concise.

labels List<LabelDescriptor>

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

name String

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

description string

A human-readable description of this log. This information appears in the documentation and can contain details.

displayName string

The human-readable name for this log. This information appears on the user interface and should be concise.

labels LabelDescriptor[]

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

name string

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

description str

A human-readable description of this log. This information appears in the documentation and can contain details.

display_name str

The human-readable name for this log. This information appears on the user interface and should be concise.

labels Sequence[LabelDescriptor]

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

name str

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

description String

A human-readable description of this log. This information appears in the documentation and can contain details.

displayName String

The human-readable name for this log. This information appears on the user interface and should be concise.

labels List<Property Map>

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

name String

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

LogDescriptorResponse

Description string

A human-readable description of this log. This information appears in the documentation and can contain details.

DisplayName string

The human-readable name for this log. This information appears on the user interface and should be concise.

Labels List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptorResponse>

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

Name string

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

Description string

A human-readable description of this log. This information appears in the documentation and can contain details.

DisplayName string

The human-readable name for this log. This information appears on the user interface and should be concise.

Labels []LabelDescriptorResponse

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

Name string

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

description String

A human-readable description of this log. This information appears in the documentation and can contain details.

displayName String

The human-readable name for this log. This information appears on the user interface and should be concise.

labels List<LabelDescriptorResponse>

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

name String

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

description string

A human-readable description of this log. This information appears in the documentation and can contain details.

displayName string

The human-readable name for this log. This information appears on the user interface and should be concise.

labels LabelDescriptorResponse[]

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

name string

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

description str

A human-readable description of this log. This information appears in the documentation and can contain details.

display_name str

The human-readable name for this log. This information appears on the user interface and should be concise.

labels Sequence[LabelDescriptorResponse]

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

name str

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

description String

A human-readable description of this log. This information appears in the documentation and can contain details.

displayName String

The human-readable name for this log. This information appears on the user interface and should be concise.

labels List<Property Map>

The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.

name String

The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].

Logging

ConsumerDestinations List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LoggingDestination>

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

ProducerDestinations List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LoggingDestination>

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

ConsumerDestinations []LoggingDestination

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

ProducerDestinations []LoggingDestination

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

consumerDestinations List<LoggingDestination>

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

producerDestinations List<LoggingDestination>

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

consumerDestinations LoggingDestination[]

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

producerDestinations LoggingDestination[]

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

consumer_destinations Sequence[LoggingDestination]

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

producer_destinations Sequence[LoggingDestination]

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

consumerDestinations List<Property Map>

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

producerDestinations List<Property Map>

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

LoggingDestination

Logs List<string>

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

MonitoredResource string

The monitored resource type. The type must be defined in the Service.monitored_resources section.

Logs []string

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

MonitoredResource string

The monitored resource type. The type must be defined in the Service.monitored_resources section.

logs List<String>

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

monitoredResource String

The monitored resource type. The type must be defined in the Service.monitored_resources section.

logs string[]

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

monitoredResource string

The monitored resource type. The type must be defined in the Service.monitored_resources section.

logs Sequence[str]

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

monitored_resource str

The monitored resource type. The type must be defined in the Service.monitored_resources section.

logs List<String>

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

monitoredResource String

The monitored resource type. The type must be defined in the Service.monitored_resources section.

LoggingDestinationResponse

Logs List<string>

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

MonitoredResource string

The monitored resource type. The type must be defined in the Service.monitored_resources section.

Logs []string

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

MonitoredResource string

The monitored resource type. The type must be defined in the Service.monitored_resources section.

logs List<String>

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

monitoredResource String

The monitored resource type. The type must be defined in the Service.monitored_resources section.

logs string[]

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

monitoredResource string

The monitored resource type. The type must be defined in the Service.monitored_resources section.

logs Sequence[str]

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

monitored_resource str

The monitored resource type. The type must be defined in the Service.monitored_resources section.

logs List<String>

Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".

monitoredResource String

The monitored resource type. The type must be defined in the Service.monitored_resources section.

LoggingResponse

ConsumerDestinations List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LoggingDestinationResponse>

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

ProducerDestinations List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LoggingDestinationResponse>

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

ConsumerDestinations []LoggingDestinationResponse

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

ProducerDestinations []LoggingDestinationResponse

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

consumerDestinations List<LoggingDestinationResponse>

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

producerDestinations List<LoggingDestinationResponse>

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

consumerDestinations LoggingDestinationResponse[]

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

producerDestinations LoggingDestinationResponse[]

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

consumer_destinations Sequence[LoggingDestinationResponse]

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

producer_destinations Sequence[LoggingDestinationResponse]

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

consumerDestinations List<Property Map>

Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.

producerDestinations List<Property Map>

Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.

Method

Name string

The simple name of this method.

Options List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.Option>

Any metadata attached to the method.

RequestStreaming bool

If true, the request is streamed.

RequestTypeUrl string

A URL of the input message type.

ResponseStreaming bool

If true, the response is streamed.

ResponseTypeUrl string

The URL of the output message type.

Syntax Pulumi.GoogleNative.ServiceManagement.V1.MethodSyntax

The source syntax of this method.

Name string

The simple name of this method.

Options []Option

Any metadata attached to the method.

RequestStreaming bool

If true, the request is streamed.

RequestTypeUrl string

A URL of the input message type.

ResponseStreaming bool

If true, the response is streamed.

ResponseTypeUrl string

The URL of the output message type.

Syntax MethodSyntax

The source syntax of this method.

name String

The simple name of this method.

options List<Option>

Any metadata attached to the method.

requestStreaming Boolean

If true, the request is streamed.

requestTypeUrl String

A URL of the input message type.

responseStreaming Boolean

If true, the response is streamed.

responseTypeUrl String

The URL of the output message type.

syntax MethodSyntax

The source syntax of this method.

name string

The simple name of this method.

options Option[]

Any metadata attached to the method.

requestStreaming boolean

If true, the request is streamed.

requestTypeUrl string

A URL of the input message type.

responseStreaming boolean

If true, the response is streamed.

responseTypeUrl string

The URL of the output message type.

syntax MethodSyntax

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_url str

A URL of the input message type.

response_streaming bool

If true, the response is streamed.

response_type_url str

The URL of the output message type.

syntax MethodSyntax

The source syntax of this method.

name String

The simple name of this method.

options List<Property Map>

Any metadata attached to the method.

requestStreaming Boolean

If true, the request is streamed.

requestTypeUrl String

A URL of the input message type.

responseStreaming Boolean

If true, the response is streamed.

responseTypeUrl String

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.GoogleNative.ServiceManagement.V1.Inputs.OptionResponse>

Any metadata attached to the method.

RequestStreaming bool

If true, the request is streamed.

RequestTypeUrl string

A URL of the input message type.

ResponseStreaming bool

If true, the response is streamed.

ResponseTypeUrl string

The URL of the output message type.

Syntax string

The source syntax of this method.

Name string

The simple name of this method.

Options []OptionResponse

Any metadata attached to the method.

RequestStreaming bool

If true, the request is streamed.

RequestTypeUrl string

A URL of the input message type.

ResponseStreaming bool

If true, the response is streamed.

ResponseTypeUrl string

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<OptionResponse>

Any metadata attached to the method.

requestStreaming Boolean

If true, the request is streamed.

requestTypeUrl String

A URL of the input message type.

responseStreaming Boolean

If true, the response is streamed.

responseTypeUrl String

The URL of the output message type.

syntax String

The source syntax of this method.

name string

The simple name of this method.

options OptionResponse[]

Any metadata attached to the method.

requestStreaming boolean

If true, the request is streamed.

requestTypeUrl string

A URL of the input message type.

responseStreaming boolean

If true, the response is streamed.

responseTypeUrl string

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[OptionResponse]

Any metadata attached to the method.

request_streaming bool

If true, the request is streamed.

request_type_url str

A URL of the input message type.

response_streaming bool

If true, the response is streamed.

response_type_url str

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.

requestStreaming Boolean

If true, the request is streamed.

requestTypeUrl String

A URL of the input message type.

responseStreaming Boolean

If true, the response is streamed.

responseTypeUrl String

The URL of the output message type.

syntax String

The source syntax of this method.

MethodSyntax

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

SyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

MethodSyntaxSyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

MethodSyntaxSyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

SyntaxProto3
SYNTAX_PROTO3

Syntax proto3.

SyntaxProto2
SYNTAX_PROTO2

Syntax proto2.

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

DisplayName string

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

Labels List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptor>

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

LaunchStage Pulumi.GoogleNative.ServiceManagement.V1.MetricDescriptorLaunchStage

Optional. The launch stage of the metric definition.

Metadata Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MetricDescriptorMetadata

Optional. Metadata which can be used to guide usage of the metric.

MetricKind Pulumi.GoogleNative.ServiceManagement.V1.MetricDescriptorMetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

MonitoredResourceTypes List<string>

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

Name string

The resource name of the metric descriptor.

Type string

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

Unit string

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

ValueType Pulumi.GoogleNative.ServiceManagement.V1.MetricDescriptorValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

Description string

A detailed description of the metric, which can be used in documentation.

DisplayName string

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

Labels []LabelDescriptor

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

LaunchStage MetricDescriptorLaunchStage

Optional. The launch stage of the metric definition.

Metadata MetricDescriptorMetadata

Optional. Metadata which can be used to guide usage of the metric.

MetricKind MetricDescriptorMetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

MonitoredResourceTypes []string

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

Name string

The resource name of the metric descriptor.

Type string

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

Unit string

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

ValueType MetricDescriptorValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description String

A detailed description of the metric, which can be used in documentation.

displayName String

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

labels List<LabelDescriptor>

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

launchStage MetricDescriptorLaunchStage

Optional. The launch stage of the metric definition.

metadata MetricDescriptorMetadata

Optional. Metadata which can be used to guide usage of the metric.

metricKind MetricDescriptorMetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

monitoredResourceTypes List<String>

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

name String

The resource name of the metric descriptor.

type String

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

unit String

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

valueType MetricDescriptorValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description string

A detailed description of the metric, which can be used in documentation.

displayName string

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

labels LabelDescriptor[]

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

launchStage MetricDescriptorLaunchStage

Optional. The launch stage of the metric definition.

metadata MetricDescriptorMetadata

Optional. Metadata which can be used to guide usage of the metric.

metricKind MetricDescriptorMetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

monitoredResourceTypes string[]

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

name string

The resource name of the metric descriptor.

type string

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

unit string

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

valueType MetricDescriptorValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description str

A detailed description of the metric, which can be used in documentation.

display_name str

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

labels Sequence[LabelDescriptor]

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

launch_stage MetricDescriptorLaunchStage

Optional. The launch stage of the metric definition.

metadata MetricDescriptorMetadata

Optional. Metadata which can be used to guide usage of the metric.

metric_kind MetricDescriptorMetricKind

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

monitored_resource_types Sequence[str]

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

name str

The resource name of the metric descriptor.

type str

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

unit str

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

value_type MetricDescriptorValueType

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description String

A detailed description of the metric, which can be used in documentation.

displayName String

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

labels List<Property Map>

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

launchStage "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"

Optional. The launch stage of the metric definition.

metadata Property Map

Optional. Metadata which can be used to guide usage of the metric.

metricKind "METRIC_KIND_UNSPECIFIED" | "GAUGE" | "DELTA" | "CUMULATIVE"

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

monitoredResourceTypes List<String>

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

name String

The resource name of the metric descriptor.

type String

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

unit String

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

valueType "VALUE_TYPE_UNSPECIFIED" | "BOOL" | "INT64" | "DOUBLE" | "STRING" | "DISTRIBUTION" | "MONEY"

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

MetricDescriptorLaunchStage

LaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

Unimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

Prelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

EarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

Alpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

Beta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

Ga
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

Deprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

MetricDescriptorLaunchStageLaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

MetricDescriptorLaunchStageUnimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

MetricDescriptorLaunchStagePrelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

MetricDescriptorLaunchStageEarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

MetricDescriptorLaunchStageAlpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

MetricDescriptorLaunchStageBeta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

MetricDescriptorLaunchStageGa
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

MetricDescriptorLaunchStageDeprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

LaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

Unimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

Prelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

EarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

Alpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

Beta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

Ga
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

Deprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

LaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

Unimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

Prelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

EarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

Alpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

Beta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

Ga
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

Deprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

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

IngestDelay string

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

LaunchStage Pulumi.GoogleNative.ServiceManagement.V1.MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

IngestDelay string

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

LaunchStage MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingestDelay String

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

launchStage MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingestDelay string

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

launchStage MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod string

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingest_delay str

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

launch_stage MetricDescriptorMetadataLaunchStage

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

sample_period str

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingestDelay String

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

launchStage "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

MetricDescriptorMetadataLaunchStage

LaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

Unimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

Prelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

EarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

Alpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

Beta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

Ga
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

Deprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

MetricDescriptorMetadataLaunchStageLaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

MetricDescriptorMetadataLaunchStageUnimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

MetricDescriptorMetadataLaunchStagePrelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

MetricDescriptorMetadataLaunchStageEarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

MetricDescriptorMetadataLaunchStageAlpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

MetricDescriptorMetadataLaunchStageBeta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

MetricDescriptorMetadataLaunchStageGa
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

MetricDescriptorMetadataLaunchStageDeprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

LaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

Unimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

Prelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

EarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

Alpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

Beta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

Ga
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

Deprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

LaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

Unimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

Prelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

EarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

Alpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

Beta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

Ga
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

Deprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

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

IngestDelay string

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

LaunchStage string

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

IngestDelay string

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

LaunchStage string

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

SamplePeriod string

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingestDelay String

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

launchStage String

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingestDelay string

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

launchStage string

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod string

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingest_delay str

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

launch_stage str

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

sample_period str

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

ingestDelay String

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

launchStage String

Deprecated. Must use the MetricDescriptor.launch_stage instead.

Deprecated:

Deprecated. Must use the MetricDescriptor.launch_stage instead.

samplePeriod String

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

MetricDescriptorMetricKind

MetricKindUnspecified
METRIC_KIND_UNSPECIFIED

Do not use this default value.

Gauge
GAUGE

An instantaneous measurement of a value.

Delta
DELTA

The change in a value during a time interval.

Cumulative
CUMULATIVE

A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.

MetricDescriptorMetricKindMetricKindUnspecified
METRIC_KIND_UNSPECIFIED

Do not use this default value.

MetricDescriptorMetricKindGauge
GAUGE

An instantaneous measurement of a value.

MetricDescriptorMetricKindDelta
DELTA

The change in a value during a time interval.

MetricDescriptorMetricKindCumulative
CUMULATIVE

A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.

MetricKindUnspecified
METRIC_KIND_UNSPECIFIED

Do not use this default value.

Gauge
GAUGE

An instantaneous measurement of a value.

Delta
DELTA

The change in a value during a time interval.

Cumulative
CUMULATIVE

A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.

MetricKindUnspecified
METRIC_KIND_UNSPECIFIED

Do not use this default value.

Gauge
GAUGE

An instantaneous measurement of a value.

Delta
DELTA

The change in a value during a time interval.

Cumulative
CUMULATIVE

A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.

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.

DisplayName string

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

Labels List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptorResponse>

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

LaunchStage string

Optional. The launch stage of the metric definition.

Metadata Pulumi.GoogleNative.ServiceManagement.V1.Inputs.MetricDescriptorMetadataResponse

Optional. Metadata which can be used to guide usage of the metric.

MetricKind string

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

MonitoredResourceTypes List<string>

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

Name string

The resource name of the metric descriptor.

Type string

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

Unit string

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

ValueType string

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

Description string

A detailed description of the metric, which can be used in documentation.

DisplayName string

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

Labels []LabelDescriptorResponse

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

LaunchStage string

Optional. The launch stage of the metric definition.

Metadata MetricDescriptorMetadataResponse

Optional. Metadata which can be used to guide usage of the metric.

MetricKind string

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

MonitoredResourceTypes []string

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

Name string

The resource name of the metric descriptor.

Type string

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

Unit string

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

ValueType string

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description String

A detailed description of the metric, which can be used in documentation.

displayName String

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

labels List<LabelDescriptorResponse>

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

launchStage String

Optional. The launch stage of the metric definition.

metadata MetricDescriptorMetadataResponse

Optional. Metadata which can be used to guide usage of the metric.

metricKind String

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

monitoredResourceTypes List<String>

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

name String

The resource name of the metric descriptor.

type String

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

unit String

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

valueType String

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description string

A detailed description of the metric, which can be used in documentation.

displayName string

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

labels LabelDescriptorResponse[]

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

launchStage string

Optional. The launch stage of the metric definition.

metadata MetricDescriptorMetadataResponse

Optional. Metadata which can be used to guide usage of the metric.

metricKind string

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

monitoredResourceTypes string[]

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

name string

The resource name of the metric descriptor.

type string

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

unit string

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

valueType string

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description str

A detailed description of the metric, which can be used in documentation.

display_name str

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

labels Sequence[LabelDescriptorResponse]

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

launch_stage str

Optional. The launch stage of the metric definition.

metadata MetricDescriptorMetadataResponse

Optional. Metadata which can be used to guide usage of the metric.

metric_kind str

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

monitored_resource_types Sequence[str]

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

name str

The resource name of the metric descriptor.

type str

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

unit str

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

value_type str

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

description String

A detailed description of the metric, which can be used in documentation.

displayName String

A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.

labels List<Property Map>

The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.

launchStage String

Optional. The launch stage of the metric definition.

metadata Property Map

Optional. Metadata which can be used to guide usage of the metric.

metricKind String

Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.

monitoredResourceTypes List<String>

Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.

name String

The resource name of the metric descriptor.

type String

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies"

unit String

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) * bit bit * By byte * s second * min minute * h hour * d day * 1 dimensionless Prefixes (PREFIX) * k kilo (10^3) * M mega (10^6) * G giga (10^9) * T tera (10^12) * P peta (10^15) * E exa (10^18) * Z zetta (10^21) * Y yotta (10^24) * m milli (10^-3) * u micro (10^-6) * n nano (10^-9) * p pico (10^-12) * f femto (10^-15) * a atto (10^-18) * z zepto (10^-21) * y yocto (10^-24) * Ki kibi (2^10) * Mi mebi (2^20) * Gi gibi (2^30) * Ti tebi (2^40) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: * Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

valueType String

Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.

MetricDescriptorValueType

ValueTypeUnspecified
VALUE_TYPE_UNSPECIFIED

Do not use this default value.

Bool
BOOL

The value is a boolean. This value type can be used only if the metric kind is GAUGE.

Int64
INT64

The value is a signed 64-bit integer.

Double
DOUBLE

The value is a double precision floating point number.

String
STRING

The value is a text string. This value type can be used only if the metric kind is GAUGE.

Distribution
DISTRIBUTION

The value is a Distribution.

Money
MONEY

The value is money.

MetricDescriptorValueTypeValueTypeUnspecified
VALUE_TYPE_UNSPECIFIED

Do not use this default value.

MetricDescriptorValueTypeBool
BOOL

The value is a boolean. This value type can be used only if the metric kind is GAUGE.

MetricDescriptorValueTypeInt64
INT64

The value is a signed 64-bit integer.

MetricDescriptorValueTypeDouble
DOUBLE

The value is a double precision floating point number.

MetricDescriptorValueTypeString
STRING

The value is a text string. This value type can be used only if the metric kind is GAUGE.

MetricDescriptorValueTypeDistribution
DISTRIBUTION

The value is a Distribution.

MetricDescriptorValueTypeMoney
MONEY

The value is money.

ValueTypeUnspecified
VALUE_TYPE_UNSPECIFIED

Do not use this default value.

Bool
BOOL

The value is a boolean. This value type can be used only if the metric kind is GAUGE.

Int64
INT64

The value is a signed 64-bit integer.

Double
DOUBLE

The value is a double precision floating point number.

String
STRING

The value is a text string. This value type can be used only if the metric kind is GAUGE.

Distribution
DISTRIBUTION

The value is a Distribution.

Money
MONEY

The value is money.

ValueTypeUnspecified
VALUE_TYPE_UNSPECIFIED

Do not use this default value.

Bool
BOOL

The value is a boolean. This value type can be used only if the metric kind is GAUGE.

Int64
INT64

The value is a signed 64-bit integer.

Double
DOUBLE

The value is a double precision floating point number.

String
STRING

The value is a text string. This value type can be used only if the metric kind is GAUGE.

Distribution
DISTRIBUTION

The value is a Distribution.

Money
MONEY

The value is money.

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

MetricCosts Dictionary<string, string>

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

MetricCosts map[string]string

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

metricCosts Map<String,String>

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

metricCosts {[key: string]: string}

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

metric_costs Mapping[str, str]

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

selector str

Selects the methods to which this rule applies. Refer to selector for syntax details.

metricCosts Map<String>

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

MetricRuleResponse

MetricCosts Dictionary<string, string>

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

MetricCosts map[string]string

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

Selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

metricCosts Map<String,String>

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

metricCosts {[key: string]: string}

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

selector string

Selects the methods to which this rule applies. Refer to selector for syntax details.

metric_costs Mapping[str, str]

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

selector str

Selects the methods to which this rule applies. Refer to selector for syntax details.

metricCosts Map<String>

Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.

selector String

Selects the methods to which this rule applies. Refer to selector for syntax details.

Mixin

Name string

The fully qualified name of the interface which is included.

Root string

If non-empty specifies a path under which inherited HTTP paths are rooted.

Name string

The fully qualified name of the interface which is included.

Root string

If non-empty specifies a path under which inherited HTTP paths are rooted.

name String

The fully qualified name of the interface which is included.

root String

If non-empty specifies a path under which inherited HTTP paths are rooted.

name string

The fully qualified name of the interface which is included.

root string

If non-empty specifies a path under which inherited HTTP paths are rooted.

name str

The fully qualified name of the interface which is included.

root str

If non-empty specifies a path under which inherited HTTP paths are rooted.

name String

The fully qualified name of the interface which is included.

root String

If non-empty specifies a path under which inherited HTTP paths are rooted.

MixinResponse

Name string

The fully qualified name of the interface which is included.

Root string

If non-empty specifies a path under which inherited HTTP paths are rooted.

Name string

The fully qualified name of the interface which is included.

Root string

If non-empty specifies a path under which inherited HTTP paths are rooted.

name String

The fully qualified name of the interface which is included.

root String

If non-empty specifies a path under which inherited HTTP paths are rooted.

name string

The fully qualified name of the interface which is included.

root string

If non-empty specifies a path under which inherited HTTP paths are rooted.

name str

The fully qualified name of the interface which is included.

root str

If non-empty specifies a path under which inherited HTTP paths are rooted.

name String

The fully qualified name of the interface which is included.

root String

If non-empty specifies a path under which inherited HTTP paths are rooted.

MonitoredResourceDescriptor

Labels List<Pulumi.GoogleNative.ServiceManagement.V1.Inputs.LabelDescriptor>

A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".

Type string

The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.

Description string

Optional. A detailed description of the monitored resource type that might be used in documentation.

DisplayName string

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

LaunchStage Pulumi.GoogleNative.ServiceManagement.V1.MonitoredResourceDescriptorLaunchStage

Optional. The launch stage of the monitored resource definition.

Name string

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

Labels []LabelDescriptor

A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".

Type string

The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.

Description string

Optional. A detailed description of the monitored resource type that might be used in documentation.

DisplayName string

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

LaunchStage MonitoredResourceDescriptorLaunchStage

Optional. The launch stage of the monitored resource definition.

Name string

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

labels List<LabelDescriptor>

A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".

type String

The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.

description String

Optional. A detailed description of the monitored resource type that might be used in documentation.

displayName String

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

launchStage MonitoredResourceDescriptorLaunchStage

Optional. The launch stage of the monitored resource definition.

name String

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

labels LabelDescriptor[]

A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".

type string

The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.

description string

Optional. A detailed description of the monitored resource type that might be used in documentation.

displayName string

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

launchStage MonitoredResourceDescriptorLaunchStage

Optional. The launch stage of the monitored resource definition.

name string

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

labels Sequence[LabelDescriptor]

A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".

type str

The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.

description str

Optional. A detailed description of the monitored resource type that might be used in documentation.

display_name str

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

launch_stage MonitoredResourceDescriptorLaunchStage

Optional. The launch stage of the monitored resource definition.

name str

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

labels List<Property Map>

A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".

type String

The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.

description String

Optional. A detailed description of the monitored resource type that might be used in documentation.

displayName String

Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".

launchStage "LAUNCH_STAGE_UNSPECIFIED" | "UNIMPLEMENTED" | "PRELAUNCH" | "EARLY_ACCESS" | "ALPHA" | "BETA" | "GA" | "DEPRECATED"

Optional. The launch stage of the monitored resource definition.

name String

Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".

MonitoredResourceDescriptorLaunchStage

LaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

Unimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

Prelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

EarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

Alpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

Beta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

Ga
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

Deprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

MonitoredResourceDescriptorLaunchStageLaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

MonitoredResourceDescriptorLaunchStageUnimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

MonitoredResourceDescriptorLaunchStagePrelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

MonitoredResourceDescriptorLaunchStageEarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

MonitoredResourceDescriptorLaunchStageAlpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases.

MonitoredResourceDescriptorLaunchStageBeta
BETA

Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases.

MonitoredResourceDescriptorLaunchStageGa
GA

GA features are open to all developers and are considered stable and fully qualified for production use.

MonitoredResourceDescriptorLaunchStageDeprecated
DEPRECATED

Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service and the Google Cloud Platform Subject to the Deprecation Policy documentation.

LaunchStageUnspecified
LAUNCH_STAGE_UNSPECIFIED

Do not use this default value.

Unimplemented
UNIMPLEMENTED

The feature is not yet implemented. Users can not use it.

Prelaunch
PRELAUNCH

Prelaunch features are hidden from users and are only visible internally.

EarlyAccess
EARLY_ACCESS

Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released.

Alpha
ALPHA

Alpha is a limited availability test for releases before they are cleared for widespread use. By A