Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.servicemanagement/v1.getConfig
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets a service configuration (version) for a managed service.
Using getConfig
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getConfig(args: GetConfigArgs, opts?: InvokeOptions): Promise<GetConfigResult>
function getConfigOutput(args: GetConfigOutputArgs, opts?: InvokeOptions): Output<GetConfigResult>
def get_config(config_id: Optional[str] = None,
service_name: Optional[str] = None,
view: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetConfigResult
def get_config_output(config_id: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
view: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetConfigResult]
func LookupConfig(ctx *Context, args *LookupConfigArgs, opts ...InvokeOption) (*LookupConfigResult, error)
func LookupConfigOutput(ctx *Context, args *LookupConfigOutputArgs, opts ...InvokeOption) LookupConfigResultOutput
> Note: This function is named LookupConfig
in the Go SDK.
public static class GetConfig
{
public static Task<GetConfigResult> InvokeAsync(GetConfigArgs args, InvokeOptions? opts = null)
public static Output<GetConfigResult> Invoke(GetConfigInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetConfigResult> getConfig(GetConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:servicemanagement/v1:getConfig
arguments:
# arguments dictionary
The following arguments are supported:
- Config
Id string - Service
Name string - View string
- Config
Id string - Service
Name string - View string
- config
Id String - service
Name String - view String
- config
Id string - service
Name string - view string
- config_
id str - service_
name str - view str
- config
Id String - service
Name String - view String
getConfig Result
The following output properties are available:
- Apis
List<Pulumi.
Google Native. Service Management. V1. Outputs. Api Response> - A list of API interfaces exported by this service. Only the
name
field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Authentication
Pulumi.
Google Native. Service Management. V1. Outputs. Authentication Response - Auth configuration.
- Backend
Pulumi.
Google Native. Service Management. V1. Outputs. Backend Response - API backend configuration.
- Billing
Pulumi.
Google Native. Service Management. V1. Outputs. Billing Response - Billing configuration.
- Config
Version int - Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3
. - Context
Pulumi.
Google Native. Service Management. V1. Outputs. Context Response - Context configuration.
- Control
Pulumi.
Google Native. Service Management. V1. Outputs. Control Response - Configuration for the service control plane.
- Custom
Error Pulumi.Google Native. Service Management. V1. Outputs. Custom Error Response - Custom error configuration.
- Documentation
Pulumi.
Google Native. Service Management. V1. Outputs. Documentation Response - Additional API documentation.
- Endpoints
List<Pulumi.
Google Native. Service Management. V1. Outputs. Endpoint Response> - Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- Enums
List<Pulumi.
Google Native. Service Management. V1. Outputs. Enum Response> - A list of all enum types included in this API service. Enums referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - Http
Pulumi.
Google Native. Service Management. V1. Outputs. Http Response - HTTP configuration.
- Logging
Pulumi.
Google Native. Service Management. V1. Outputs. Logging Response - Logging configuration.
- Logs
List<Pulumi.
Google Native. Service Management. V1. Outputs. Log Descriptor Response> - Defines the logs used by this service.
- Metrics
List<Pulumi.
Google Native. Service Management. V1. Outputs. Metric Descriptor Response> - Defines the metrics used by this service.
- Monitored
Resources List<Pulumi.Google Native. Service Management. V1. Outputs. Monitored Resource Descriptor Response> - Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- Monitoring
Pulumi.
Google Native. Service Management. V1. Outputs. Monitoring Response - Monitoring configuration.
- Name string
- The service name, which is a DNS-like logical identifier for the service, such as
calendar.googleapis.com
. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. - Producer
Project stringId - The Google project that owns this service.
- Publishing
Pulumi.
Google Native. Service Management. V1. Outputs. Publishing Response - Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- Quota
Pulumi.
Google Native. Service Management. V1. Outputs. Quota Response - Quota configuration.
- Source
Info Pulumi.Google Native. Service Management. V1. Outputs. Source Info Response - The source information for this configuration if available.
- System
Parameters Pulumi.Google Native. Service Management. V1. Outputs. System Parameters Response - System parameter configuration.
- System
Types List<Pulumi.Google Native. Service Management. V1. Outputs. Type Response> - A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- Title string
- The product title for this service, it is the name displayed in Google Cloud Console.
- Types
List<Pulumi.
Google Native. Service Management. V1. Outputs. Type Response> - A list of all proto message types included in this API service. Types referenced directly or indirectly by the
apis
are automatically included. Messages which are not referenced but shall be included, such as types used by thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - Usage
Pulumi.
Google Native. Service Management. V1. Outputs. Usage Response - Configuration controlling usage of this service.
- Apis
[]Api
Response - A list of API interfaces exported by this service. Only the
name
field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Authentication
Authentication
Response - Auth configuration.
- Backend
Backend
Response - API backend configuration.
- Billing
Billing
Response - Billing configuration.
- Config
Version int - Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3
. - Context
Context
Response - Context configuration.
- Control
Control
Response - Configuration for the service control plane.
- Custom
Error CustomError Response - Custom error configuration.
- Documentation
Documentation
Response - Additional API documentation.
- Endpoints
[]Endpoint
Response - Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- Enums
[]Enum
Response - A list of all enum types included in this API service. Enums referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - Http
Http
Response - HTTP configuration.
- Logging
Logging
Response - Logging configuration.
- Logs
[]Log
Descriptor Response - Defines the logs used by this service.
- Metrics
[]Metric
Descriptor Response - Defines the metrics used by this service.
- Monitored
Resources []MonitoredResource Descriptor Response - Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- Monitoring
Monitoring
Response - Monitoring configuration.
- Name string
- The service name, which is a DNS-like logical identifier for the service, such as
calendar.googleapis.com
. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. - Producer
Project stringId - The Google project that owns this service.
- Publishing
Publishing
Response - Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- Quota
Quota
Response - Quota configuration.
- Source
Info SourceInfo Response - The source information for this configuration if available.
- System
Parameters SystemParameters Response - System parameter configuration.
- System
Types []TypeResponse - A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- Title string
- The product title for this service, it is the name displayed in Google Cloud Console.
- Types
[]Type
Response - A list of all proto message types included in this API service. Types referenced directly or indirectly by the
apis
are automatically included. Messages which are not referenced but shall be included, such as types used by thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - Usage
Usage
Response - Configuration controlling usage of this service.
- apis
List<Api
Response> - A list of API interfaces exported by this service. Only the
name
field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication
Authentication
Response - Auth configuration.
- backend
Backend
Response - API backend configuration.
- billing
Billing
Response - Billing configuration.
- config
Version Integer - Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3
. - context
Context
Response - Context configuration.
- control
Control
Response - Configuration for the service control plane.
- custom
Error CustomError Response - Custom error configuration.
- documentation
Documentation
Response - Additional API documentation.
- endpoints
List<Endpoint
Response> - Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- enums
List<Enum
Response> - A list of all enum types included in this API service. Enums referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - http
Http
Response - HTTP configuration.
- logging
Logging
Response - Logging configuration.
- logs
List<Log
Descriptor Response> - Defines the logs used by this service.
- metrics
List<Metric
Descriptor Response> - Defines the metrics used by this service.
- monitored
Resources List<MonitoredResource Descriptor Response> - Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Monitoring
Response - Monitoring configuration.
- name String
- The service name, which is a DNS-like logical identifier for the service, such as
calendar.googleapis.com
. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. - producer
Project StringId - The Google project that owns this service.
- publishing
Publishing
Response - Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota
Quota
Response - Quota configuration.
- source
Info SourceInfo Response - The source information for this configuration if available.
- system
Parameters SystemParameters Response - System parameter configuration.
- system
Types List<TypeResponse> - A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title String
- The product title for this service, it is the name displayed in Google Cloud Console.
- types
List<Type
Response> - A list of all proto message types included in this API service. Types referenced directly or indirectly by the
apis
are automatically included. Messages which are not referenced but shall be included, such as types used by thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - usage
Usage
Response - Configuration controlling usage of this service.
- apis
Api
Response[] - A list of API interfaces exported by this service. Only the
name
field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication
Authentication
Response - Auth configuration.
- backend
Backend
Response - API backend configuration.
- billing
Billing
Response - Billing configuration.
- config
Version number - Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3
. - context
Context
Response - Context configuration.
- control
Control
Response - Configuration for the service control plane.
- custom
Error CustomError Response - Custom error configuration.
- documentation
Documentation
Response - Additional API documentation.
- endpoints
Endpoint
Response[] - Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- enums
Enum
Response[] - A list of all enum types included in this API service. Enums referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - http
Http
Response - HTTP configuration.
- logging
Logging
Response - Logging configuration.
- logs
Log
Descriptor Response[] - Defines the logs used by this service.
- metrics
Metric
Descriptor Response[] - Defines the metrics used by this service.
- monitored
Resources MonitoredResource Descriptor Response[] - Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Monitoring
Response - Monitoring configuration.
- name string
- The service name, which is a DNS-like logical identifier for the service, such as
calendar.googleapis.com
. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. - producer
Project stringId - The Google project that owns this service.
- publishing
Publishing
Response - Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota
Quota
Response - Quota configuration.
- source
Info SourceInfo Response - The source information for this configuration if available.
- system
Parameters SystemParameters Response - System parameter configuration.
- system
Types TypeResponse[] - A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title string
- The product title for this service, it is the name displayed in Google Cloud Console.
- types
Type
Response[] - A list of all proto message types included in this API service. Types referenced directly or indirectly by the
apis
are automatically included. Messages which are not referenced but shall be included, such as types used by thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - usage
Usage
Response - Configuration controlling usage of this service.
- apis
Sequence[Api
Response] - A list of API interfaces exported by this service. Only the
name
field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication
Authentication
Response - Auth configuration.
- backend
Backend
Response - API backend configuration.
- billing
Billing
Response - Billing configuration.
- config_
version int - Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3
. - context
Context
Response - Context configuration.
- control
Control
Response - Configuration for the service control plane.
- custom_
error CustomError Response - Custom error configuration.
- documentation
Documentation
Response - Additional API documentation.
- endpoints
Sequence[Endpoint
Response] - Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- enums
Sequence[Enum
Response] - A list of all enum types included in this API service. Enums referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - http
Http
Response - HTTP configuration.
- logging
Logging
Response - Logging configuration.
- logs
Sequence[Log
Descriptor Response] - Defines the logs used by this service.
- metrics
Sequence[Metric
Descriptor Response] - Defines the metrics used by this service.
- monitored_
resources Sequence[MonitoredResource Descriptor Response] - Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring
Monitoring
Response - Monitoring configuration.
- name str
- The service name, which is a DNS-like logical identifier for the service, such as
calendar.googleapis.com
. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. - producer_
project_ strid - The Google project that owns this service.
- publishing
Publishing
Response - Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota
Quota
Response - Quota configuration.
- source_
info SourceInfo Response - The source information for this configuration if available.
- system_
parameters SystemParameters Response - System parameter configuration.
- system_
types Sequence[TypeResponse] - A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title str
- The product title for this service, it is the name displayed in Google Cloud Console.
- types
Sequence[Type
Response] - A list of all proto message types included in this API service. Types referenced directly or indirectly by the
apis
are automatically included. Messages which are not referenced but shall be included, such as types used by thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - usage
Usage
Response - Configuration controlling usage of this service.
- apis List<Property Map>
- A list of API interfaces exported by this service. Only the
name
field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - authentication Property Map
- Auth configuration.
- backend Property Map
- API backend configuration.
- billing Property Map
- Billing configuration.
- config
Version Number - Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to
3
. - context Property Map
- Context configuration.
- control Property Map
- Configuration for the service control plane.
- custom
Error Property Map - Custom error configuration.
- documentation Property Map
- Additional API documentation.
- endpoints List<Property Map>
- Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- enums List<Property Map>
- A list of all enum types included in this API service. Enums referenced directly or indirectly by the
apis
are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum - http Property Map
- HTTP configuration.
- logging Property Map
- Logging configuration.
- logs List<Property Map>
- Defines the logs used by this service.
- metrics List<Property Map>
- Defines the metrics used by this service.
- monitored
Resources List<Property Map> - Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
- monitoring Property Map
- Monitoring configuration.
- name String
- The service name, which is a DNS-like logical identifier for the service, such as
calendar.googleapis.com
. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. - producer
Project StringId - The Google project that owns this service.
- publishing Property Map
- Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
- quota Property Map
- Quota configuration.
- source
Info Property Map - The source information for this configuration if available.
- system
Parameters Property Map - System parameter configuration.
- system
Types List<Property Map> - A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
- title String
- The product title for this service, it is the name displayed in Google Cloud Console.
- types List<Property Map>
- A list of all proto message types included in this API service. Types referenced directly or indirectly by the
apis
are automatically included. Messages which are not referenced but shall be included, such as types used by thegoogle.protobuf.Any
type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 - usage Property Map
- Configuration controlling usage of this service.
Supporting Types
ApiResponse
- Methods
List<Pulumi.
Google Native. Service Management. V1. Inputs. Method Response> - The methods of this interface, in unspecified order.
- Mixins
List<Pulumi.
Google Native. Service Management. V1. Inputs. Mixin Response> - Included interfaces. See Mixin.
- Name string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> - Any metadata attached to the interface.
- Source
Context Pulumi.Google Native. Service Management. V1. Inputs. Source Context Response - Source context for the protocol buffer service represented by this message.
- Syntax string
- The source syntax of the service.
- Version string
- A version string for this interface. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end inv
, as ingoogle.feature.v1
. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
- Methods
[]Method
Response - The methods of this interface, in unspecified order.
- Mixins
[]Mixin
Response - Included interfaces. See Mixin.
- Name string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- Options
[]Option
Response - Any metadata attached to the interface.
- Source
Context SourceContext Response - Source context for the protocol buffer service represented by this message.
- Syntax string
- The source syntax of the service.
- Version string
- A version string for this interface. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end inv
, as ingoogle.feature.v1
. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
- methods
List<Method
Response> - The methods of this interface, in unspecified order.
- mixins
List<Mixin
Response> - Included interfaces. See Mixin.
- name String
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
List<Option
Response> - Any metadata attached to the interface.
- source
Context SourceContext Response - Source context for the protocol buffer service represented by this message.
- syntax String
- The source syntax of the service.
- version String
- A version string for this interface. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end inv
, as ingoogle.feature.v1
. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
- methods
Method
Response[] - The methods of this interface, in unspecified order.
- mixins
Mixin
Response[] - Included interfaces. See Mixin.
- name string
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
Option
Response[] - Any metadata attached to the interface.
- source
Context SourceContext Response - Source context for the protocol buffer service represented by this message.
- syntax string
- The source syntax of the service.
- version string
- A version string for this interface. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end inv
, as ingoogle.feature.v1
. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
- methods
Sequence[Method
Response] - The methods of this interface, in unspecified order.
- mixins
Sequence[Mixin
Response] - Included interfaces. See Mixin.
- name str
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options
Sequence[Option
Response] - Any metadata attached to the interface.
- source_
context SourceContext Response - Source context for the protocol buffer service represented by this message.
- syntax str
- The source syntax of the service.
- version str
- A version string for this interface. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end inv
, as ingoogle.feature.v1
. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
- methods List<Property Map>
- The methods of this interface, in unspecified order.
- mixins List<Property Map>
- Included interfaces. See Mixin.
- name String
- The fully qualified name of this interface, including package name followed by the interface's simple name.
- options List<Property Map>
- Any metadata attached to the interface.
- source
Context Property Map - Source context for the protocol buffer service represented by this message.
- syntax String
- The source syntax of the service.
- version String
- A version string for this interface. If specified, must have the form
major-version.minor-version
, as in1.10
. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here. The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan. The major version is also reflected in the package name of the interface, which must end inv
, as ingoogle.feature.v1
. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.
AuthProviderResponse
- Audiences string
- The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- Issuer string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- Jwks
Uri string - URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
- Jwt
Locations List<Pulumi.Google Native. Service Management. V1. Inputs. Jwt Location Response> - Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
- Audiences string
- The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- Issuer string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- Jwks
Uri string - URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
- Jwt
Locations []JwtLocation Response - Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
- audiences String
- The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- String
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer String
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwks
Uri String - URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
- jwt
Locations List<JwtLocation Response> - Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
- audiences string
- The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- string
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer string
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwks
Uri string - URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
- jwt
Locations JwtLocation Response[] - Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
- audiences str
- The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- str
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer str
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwks_
uri str - URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
- jwt_
locations Sequence[JwtLocation Response] - Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
- audiences String
- The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService - https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- String
- Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.
- issuer String
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
- jwks
Uri String - URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document: - can be retrieved from OpenID Discovery of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
- jwt
Locations List<Property Map> - Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations] (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
AuthRequirementResponse
- Audiences string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- Provider
Id string - id from authentication provider. Example: provider_id: bookstore_auth
- Audiences string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- Provider
Id string - id from authentication provider. Example: provider_id: bookstore_auth
- audiences String
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- provider
Id String - id from authentication provider. Example: provider_id: bookstore_auth
- audiences string
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- provider
Id string - id from authentication provider. Example: provider_id: bookstore_auth
- audiences str
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- provider_
id str - id from authentication provider. Example: provider_id: bookstore_auth
- audiences String
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
- provider
Id String - id from authentication provider. Example: provider_id: bookstore_auth
AuthenticationResponse
- Providers
List<Pulumi.
Google Native. Service Management. V1. Inputs. Auth Provider Response> - Defines a set of authentication providers that a service supports.
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Authentication Rule Response> - A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Providers
[]Auth
Provider Response - Defines a set of authentication providers that a service supports.
- Rules
[]Authentication
Rule Response - A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
List<Auth
Provider Response> - Defines a set of authentication providers that a service supports.
- rules
List<Authentication
Rule Response> - A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
Auth
Provider Response[] - Defines a set of authentication providers that a service supports.
- rules
Authentication
Rule Response[] - A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers
Sequence[Auth
Provider Response] - Defines a set of authentication providers that a service supports.
- rules
Sequence[Authentication
Rule Response] - A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- providers List<Property Map>
- Defines a set of authentication providers that a service supports.
- rules List<Property Map>
- A list of authentication rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
AuthenticationRuleResponse
- Allow
Without boolCredential - If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- Oauth
Pulumi.
Google Native. Service Management. V1. Inputs. OAuth Requirements Response - The requirements for OAuth credentials.
- Requirements
List<Pulumi.
Google Native. Service Management. V1. Inputs. Auth Requirement Response> - Requirements for additional authentication providers.
- Selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- Allow
Without boolCredential - If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- Oauth
OAuth
Requirements Response - The requirements for OAuth credentials.
- Requirements
[]Auth
Requirement Response - Requirements for additional authentication providers.
- Selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without BooleanCredential - If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements Response - The requirements for OAuth credentials.
- requirements
List<Auth
Requirement Response> - Requirements for additional authentication providers.
- selector String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without booleanCredential - If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements Response - The requirements for OAuth credentials.
- requirements
Auth
Requirement Response[] - Requirements for additional authentication providers.
- selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow_
without_ boolcredential - If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth
OAuth
Requirements Response - The requirements for OAuth credentials.
- requirements
Sequence[Auth
Requirement Response] - Requirements for additional authentication providers.
- selector str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allow
Without BooleanCredential - If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.
- oauth Property Map
- The requirements for OAuth credentials.
- requirements List<Property Map>
- Requirements for additional authentication providers.
- selector String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
BackendResponse
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Backend Rule Response> - A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Rules
[]Backend
Rule Response - A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Backend
Rule Response> - A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Backend
Rule Response[] - A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[Backend
Rule Response] - A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules List<Property Map>
- A list of API backend rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
BackendRuleResponse
- Address string
- The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
- Deadline double
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- Disable
Auth bool - When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
- Jwt
Audience string - The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
- Min
Deadline double - Deprecated, do not use.
- Operation
Deadline double - The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- Overrides
By Dictionary<string, string>Request Protocol - The map between request protocol and the backend address.
- Path
Translation string - Protocol string
- The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
- Selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- Address string
- The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
- Deadline float64
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- Disable
Auth bool - When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
- Jwt
Audience string - The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
- Min
Deadline float64 - Deprecated, do not use.
- Operation
Deadline float64 - The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- Overrides
By map[string]stringRequest Protocol - The map between request protocol and the backend address.
- Path
Translation string - Protocol string
- The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
- Selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address String
- The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
- deadline Double
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disable
Auth Boolean - When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
- jwt
Audience String - The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
- min
Deadline Double - Deprecated, do not use.
- operation
Deadline Double - The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overrides
By Map<String,String>Request Protocol - The map between request protocol and the backend address.
- path
Translation String - protocol String
- The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
- selector String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address string
- The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
- deadline number
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disable
Auth boolean - When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
- jwt
Audience string - The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
- min
Deadline number - Deprecated, do not use.
- operation
Deadline number - The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overrides
By {[key: string]: string}Request Protocol - The map between request protocol and the backend address.
- path
Translation string - protocol string
- The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
- selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address str
- The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
- deadline float
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disable_
auth bool - When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
- jwt_
audience str - The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
- min_
deadline float - Deprecated, do not use.
- operation_
deadline float - The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overrides_
by_ Mapping[str, str]request_ protocol - The map between request protocol and the backend address.
- path_
translation str - protocol str
- The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
- selector str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- address String
- The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
- deadline Number
- The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
- disable
Auth Boolean - When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.
- jwt
Audience String - The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.
- min
Deadline Number - Deprecated, do not use.
- operation
Deadline Number - The number of seconds to wait for the completion of a long running operation. The default is no deadline.
- overrides
By Map<String>Request Protocol - The map between request protocol and the backend address.
- path
Translation String - protocol String
- The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
- selector String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
BillingDestinationResponse
- Metrics List<string>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- Monitored
Resource string - The monitored resource type. The type must be defined in Service.monitored_resources section.
- Metrics []string
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- Monitored
Resource string - The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics List<String>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitored
Resource String - The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics string[]
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitored
Resource string - The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics Sequence[str]
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitored_
resource str - The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics List<String>
- Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section.
- monitored
Resource String - The monitored resource type. The type must be defined in Service.monitored_resources section.
BillingResponse
- Consumer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Billing Destination Response> - Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
- Consumer
Destinations []BillingDestination Response - Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
- consumer
Destinations List<BillingDestination Response> - Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
- consumer
Destinations BillingDestination Response[] - Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
- consumer_
destinations Sequence[BillingDestination Response] - Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
- consumer
Destinations List<Property Map> - Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type. A metric can be used in at most one consumer destination.
ClientLibrarySettingsResponse
- Cpp
Settings Pulumi.Google Native. Service Management. V1. Inputs. Cpp Settings Response - Settings for C++ client libraries.
- Dotnet
Settings Pulumi.Google Native. Service Management. V1. Inputs. Dotnet Settings Response - Settings for .NET client libraries.
- Go
Settings Pulumi.Google Native. Service Management. V1. Inputs. Go Settings Response - Settings for Go client libraries.
- Java
Settings Pulumi.Google Native. Service Management. V1. Inputs. Java Settings Response - Settings for legacy Java features, supported in the Service YAML.
- Launch
Stage string - Launch stage of this version of the API.
- Node
Settings Pulumi.Google Native. Service Management. V1. Inputs. Node Settings Response - Settings for Node client libraries.
- Php
Settings Pulumi.Google Native. Service Management. V1. Inputs. Php Settings Response - Settings for PHP client libraries.
- Python
Settings Pulumi.Google Native. Service Management. V1. Inputs. Python Settings Response - Settings for Python client libraries.
- Rest
Numeric boolEnums - When using transport=rest, the client request will encode enums as numbers rather than strings.
- Ruby
Settings Pulumi.Google Native. Service Management. V1. Inputs. Ruby Settings Response - Settings for Ruby client libraries.
- Version string
- Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
- Cpp
Settings CppSettings Response - Settings for C++ client libraries.
- Dotnet
Settings DotnetSettings Response - Settings for .NET client libraries.
- Go
Settings GoSettings Response - Settings for Go client libraries.
- Java
Settings JavaSettings Response - Settings for legacy Java features, supported in the Service YAML.
- Launch
Stage string - Launch stage of this version of the API.
- Node
Settings NodeSettings Response - Settings for Node client libraries.
- Php
Settings PhpSettings Response - Settings for PHP client libraries.
- Python
Settings PythonSettings Response - Settings for Python client libraries.
- Rest
Numeric boolEnums - When using transport=rest, the client request will encode enums as numbers rather than strings.
- Ruby
Settings RubySettings Response - Settings for Ruby client libraries.
- Version string
- Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
- cpp
Settings CppSettings Response - Settings for C++ client libraries.
- dotnet
Settings DotnetSettings Response - Settings for .NET client libraries.
- go
Settings GoSettings Response - Settings for Go client libraries.
- java
Settings JavaSettings Response - Settings for legacy Java features, supported in the Service YAML.
- launch
Stage String - Launch stage of this version of the API.
- node
Settings NodeSettings Response - Settings for Node client libraries.
- php
Settings PhpSettings Response - Settings for PHP client libraries.
- python
Settings PythonSettings Response - Settings for Python client libraries.
- rest
Numeric BooleanEnums - When using transport=rest, the client request will encode enums as numbers rather than strings.
- ruby
Settings RubySettings Response - Settings for Ruby client libraries.
- version String
- Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
- cpp
Settings CppSettings Response - Settings for C++ client libraries.
- dotnet
Settings DotnetSettings Response - Settings for .NET client libraries.
- go
Settings GoSettings Response - Settings for Go client libraries.
- java
Settings JavaSettings Response - Settings for legacy Java features, supported in the Service YAML.
- launch
Stage string - Launch stage of this version of the API.
- node
Settings NodeSettings Response - Settings for Node client libraries.
- php
Settings PhpSettings Response - Settings for PHP client libraries.
- python
Settings PythonSettings Response - Settings for Python client libraries.
- rest
Numeric booleanEnums - When using transport=rest, the client request will encode enums as numbers rather than strings.
- ruby
Settings RubySettings Response - Settings for Ruby client libraries.
- version string
- Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
- cpp_
settings CppSettings Response - Settings for C++ client libraries.
- dotnet_
settings DotnetSettings Response - Settings for .NET client libraries.
- go_
settings GoSettings Response - Settings for Go client libraries.
- java_
settings JavaSettings Response - Settings for legacy Java features, supported in the Service YAML.
- launch_
stage str - Launch stage of this version of the API.
- node_
settings NodeSettings Response - Settings for Node client libraries.
- php_
settings PhpSettings Response - Settings for PHP client libraries.
- python_
settings PythonSettings Response - Settings for Python client libraries.
- rest_
numeric_ boolenums - When using transport=rest, the client request will encode enums as numbers rather than strings.
- ruby_
settings RubySettings Response - Settings for Ruby client libraries.
- version str
- Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
- cpp
Settings Property Map - Settings for C++ client libraries.
- dotnet
Settings Property Map - Settings for .NET client libraries.
- go
Settings Property Map - Settings for Go client libraries.
- java
Settings Property Map - Settings for legacy Java features, supported in the Service YAML.
- launch
Stage String - Launch stage of this version of the API.
- node
Settings Property Map - Settings for Node client libraries.
- php
Settings Property Map - Settings for PHP client libraries.
- python
Settings Property Map - Settings for Python client libraries.
- rest
Numeric BooleanEnums - When using transport=rest, the client request will encode enums as numbers rather than strings.
- ruby
Settings Property Map - Settings for Ruby client libraries.
- version String
- Version of the API to apply these settings to. This is the full protobuf package for the API, ending in the version element. Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
CommonLanguageSettingsResponse
- Destinations List<string>
- The destination where API teams want this client library to be published.
- Reference
Docs stringUri - Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- Destinations []string
- The destination where API teams want this client library to be published.
- Reference
Docs stringUri - Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations List<String>
- The destination where API teams want this client library to be published.
- reference
Docs StringUri - Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations string[]
- The destination where API teams want this client library to be published.
- reference
Docs stringUri - Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations Sequence[str]
- The destination where API teams want this client library to be published.
- reference_
docs_ struri - Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
- destinations List<String>
- The destination where API teams want this client library to be published.
- reference
Docs StringUri - Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest
ContextResponse
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Context Rule Response> - A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Rules
[]Context
Rule Response - A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
List<Context
Rule Response> - A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Context
Rule Response[] - A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[Context
Rule Response] - A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- rules List<Property Map>
- A list of RPC context rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
ContextRuleResponse
- Allowed
Request List<string>Extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- Allowed
Response List<string>Extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- Provided List<string>
- A list of full type names of provided contexts.
- Requested List<string>
- A list of full type names of requested contexts.
- Selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- Allowed
Request []stringExtensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- Allowed
Response []stringExtensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- Provided []string
- A list of full type names of provided contexts.
- Requested []string
- A list of full type names of requested contexts.
- Selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowed
Request List<String>Extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response List<String>Extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided List<String>
- A list of full type names of provided contexts.
- requested List<String>
- A list of full type names of requested contexts.
- selector String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowed
Request string[]Extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response string[]Extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided string[]
- A list of full type names of provided contexts.
- requested string[]
- A list of full type names of requested contexts.
- selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowed_
request_ Sequence[str]extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed_
response_ Sequence[str]extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided Sequence[str]
- A list of full type names of provided contexts.
- requested Sequence[str]
- A list of full type names of requested contexts.
- selector str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- allowed
Request List<String>Extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
- allowed
Response List<String>Extensions - A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
- provided List<String>
- A list of full type names of provided contexts.
- requested List<String>
- A list of full type names of requested contexts.
- selector String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
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
- Method
Policies List<Pulumi.Google Native. Service Management. V1. Inputs. Method Policy Response> - Defines policies applying to the API methods of the service.
- Environment string
- The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
- Method
Policies []MethodPolicy Response - Defines policies applying to the API methods of the service.
- environment String
- The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
- method
Policies List<MethodPolicy Response> - Defines policies applying to the API methods of the service.
- environment string
- The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
- method
Policies MethodPolicy Response[] - Defines policies applying to the API methods of the service.
- environment str
- The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
- method_
policies Sequence[MethodPolicy Response] - Defines policies applying to the API methods of the service.
- environment String
- The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com
- method
Policies List<Property Map> - Defines policies applying to the API methods of the service.
CppSettingsResponse
- Common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common Property Map
- Some settings.
CustomErrorResponse
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Custom Error Rule Response> - The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- Types List<string>
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- Rules
[]Custom
Error Rule Response - The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- Types []string
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
List<Custom
Error Rule Response> - The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types List<String>
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
Custom
Error Rule Response[] - The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types string[]
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules
Sequence[Custom
Error Rule Response] - The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types Sequence[str]
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
- rules List<Property Map>
- The list of custom error rules that apply to individual API messages. NOTE: All service configuration rules follow "last one wins" order.
- types List<String>
- The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.
CustomErrorRuleResponse
- Is
Error boolType - Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- Selector string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- Is
Error boolType - Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- Selector string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- is
Error BooleanType - Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector String
- Selects messages to which this rule applies. Refer to selector for syntax details.
- is
Error booleanType - Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector string
- Selects messages to which this rule applies. Refer to selector for syntax details.
- is_
error_ booltype - Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector str
- Selects messages to which this rule applies. Refer to selector for syntax details.
- is
Error BooleanType - Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload.
- selector String
- Selects messages to which this rule applies. Refer to selector for syntax details.
CustomHttpPatternResponse
DocumentationResponse
- Documentation
Root stringUrl - The URL to the root of documentation.
- Overview string
- Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both
overview
field andpages
field. - Pages
List<Pulumi.
Google Native. Service Management. V1. Inputs. Page Response> - The top level pages for the documentation set.
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Documentation Rule Response> - A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- Section
Overrides List<Pulumi.Google Native. Service Management. V1. Inputs. Page Response> - Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- Service
Root stringUrl - Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
- Summary string
- A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field
description
.
- Documentation
Root stringUrl - The URL to the root of documentation.
- Overview string
- Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both
overview
field andpages
field. - Pages
[]Page
Response - The top level pages for the documentation set.
- Rules
[]Documentation
Rule Response - A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- Section
Overrides []PageResponse - Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- Service
Root stringUrl - Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
- Summary string
- A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field
description
.
- documentation
Root StringUrl - The URL to the root of documentation.
- overview String
- Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both
overview
field andpages
field. - pages
List<Page
Response> - The top level pages for the documentation set.
- rules
List<Documentation
Rule Response> - A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- section
Overrides List<PageResponse> - Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- service
Root StringUrl - Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
- summary String
- A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field
description
.
- documentation
Root stringUrl - The URL to the root of documentation.
- overview string
- Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both
overview
field andpages
field. - pages
Page
Response[] - The top level pages for the documentation set.
- rules
Documentation
Rule Response[] - A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- section
Overrides PageResponse[] - Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- service
Root stringUrl - Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
- summary string
- A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field
description
.
- documentation_
root_ strurl - The URL to the root of documentation.
- overview str
- Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both
overview
field andpages
field. - pages
Sequence[Page
Response] - The top level pages for the documentation set.
- rules
Sequence[Documentation
Rule Response] - A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- section_
overrides Sequence[PageResponse] - Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- service_
root_ strurl - Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
- summary str
- A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field
description
.
- documentation
Root StringUrl - The URL to the root of documentation.
- overview String
- Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both
overview
field andpages
field. - pages List<Property Map>
- The top level pages for the documentation set.
- rules List<Property Map>
- A list of documentation rules that apply to individual API elements. NOTE: All service configuration rules follow "last one wins" order.
- section
Overrides List<Property Map> - Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries
- service
Root StringUrl - Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.
- summary String
- A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field
description
.
DocumentationRuleResponse
- Deprecation
Description string - Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated
. - Description string
- Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
- Disable
Replacement stringWords - String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- Selector string
- The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
- Deprecation
Description string - Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated
. - Description string
- Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
- Disable
Replacement stringWords - String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- Selector string
- The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
- deprecation
Description String - Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated
. - description String
- Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
- disable
Replacement StringWords - String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector String
- The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
- deprecation
Description string - Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated
. - description string
- Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
- disable
Replacement stringWords - String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector string
- The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
- deprecation_
description str - Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated
. - description str
- Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
- disable_
replacement_ strwords - String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector str
- The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
- deprecation
Description String - Deprecation description of the selected element(s). It can be provided if an element is marked as
deprecated
. - description String
- Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.
- disable
Replacement StringWords - String of comma or space separated case-sensitive words for which method/field name replacement will be disabled by go/api-docgen.
- selector String
- The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "", indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo." is ok, but not "foo.b*" or "foo.*.bar". A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
DotnetSettingsResponse
- Common
Pulumi.
Google Native. Service Management. V1. Inputs. Common Language Settings Response - Some settings.
- Forced
Namespace List<string>Aliases - Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- Handwritten
Signatures List<string> - Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- Ignored
Resources List<string> - List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- Renamed
Resources Dictionary<string, string> - Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- Renamed
Services Dictionary<string, string> - Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- Common
Common
Language Settings Response - Some settings.
- Forced
Namespace []stringAliases - Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- Handwritten
Signatures []string - Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- Ignored
Resources []string - List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- Renamed
Resources map[string]string - Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- Renamed
Services map[string]string - Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
Common
Language Settings Response - Some settings.
- forced
Namespace List<String>Aliases - Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwritten
Signatures List<String> - Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignored
Resources List<String> - List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamed
Resources Map<String,String> - Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamed
Services Map<String,String> - Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
Common
Language Settings Response - Some settings.
- forced
Namespace string[]Aliases - Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwritten
Signatures string[] - Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignored
Resources string[] - List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamed
Resources {[key: string]: string} - Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamed
Services {[key: string]: string} - Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common
Common
Language Settings Response - Some settings.
- forced_
namespace_ Sequence[str]aliases - Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwritten_
signatures Sequence[str] - Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignored_
resources Sequence[str] - List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamed_
resources Mapping[str, str] - Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamed_
services Mapping[str, str] - Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
- common Property Map
- Some settings.
- forced
Namespace List<String>Aliases - Namespaces which must be aliased in snippets due to a known (but non-generator-predictable) naming collision
- handwritten
Signatures List<String> - Method signatures (in the form "service.method(signature)") which are provided separately, so shouldn't be generated. Snippets calling these methods are still generated, however.
- ignored
Resources List<String> - List of full resource types to ignore during generation. This is typically used for API-specific Location resources, which should be handled by the generator as if they were actually the common Location resources. Example entry: "documentai.googleapis.com/Location"
- renamed
Resources Map<String> - Map from full resource types to the effective short name for the resource. This is used when otherwise resource named from different services would cause naming collisions. Example entry: "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
- renamed
Services Map<String> - Map from original service names to renamed versions. This is used when the default generated types would cause a naming conflict. (Neither name is fully-qualified.) Example: Subscriber to SubscriberServiceApi.
EndpointResponse
- Aliases List<string>
- Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
- Allow
Cors bool - Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- Name string
- The canonical name of this endpoint.
- Target string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- Aliases []string
- Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
- Allow
Cors bool - Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- Name string
- The canonical name of this endpoint.
- Target string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases List<String>
- Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
- allow
Cors Boolean - Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- name String
- The canonical name of this endpoint.
- target String
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases string[]
- Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
- allow
Cors boolean - Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- name string
- The canonical name of this endpoint.
- target string
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases Sequence[str]
- Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
- allow_
cors bool - Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- name str
- The canonical name of this endpoint.
- target str
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
- aliases List<String>
- Unimplemented. Dot not use. DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple google.api.Endpoint for each of the intended aliases. Additional names that this endpoint will be hosted on.
- allow
Cors Boolean - Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- name String
- The canonical name of this endpoint.
- target String
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint. It should be either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
EnumResponse
- Edition string
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- Enumvalue
List<Pulumi.
Google Native. Service Management. V1. Inputs. Enum Value Response> - Enum value definitions.
- Name string
- Enum type name.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> - Protocol buffer options.
- Source
Context Pulumi.Google Native. Service Management. V1. Inputs. Source Context Response - The source context.
- Syntax string
- The source syntax.
- Edition string
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- Enumvalue
[]Enum
Value Response - Enum value definitions.
- Name string
- Enum type name.
- Options
[]Option
Response - Protocol buffer options.
- Source
Context SourceContext Response - The source context.
- Syntax string
- The source syntax.
- edition String
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- enumvalue
List<Enum
Value Response> - Enum value definitions.
- name String
- Enum type name.
- options
List<Option
Response> - Protocol buffer options.
- source
Context SourceContext Response - The source context.
- syntax String
- The source syntax.
- edition string
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- enumvalue
Enum
Value Response[] - Enum value definitions.
- name string
- Enum type name.
- options
Option
Response[] - Protocol buffer options.
- source
Context SourceContext Response - The source context.
- syntax string
- The source syntax.
- edition str
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- enumvalue
Sequence[Enum
Value Response] - Enum value definitions.
- name str
- Enum type name.
- options
Sequence[Option
Response] - Protocol buffer options.
- source_
context SourceContext Response - The source context.
- syntax str
- The source syntax.
- edition String
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- enumvalue List<Property Map>
- Enum value definitions.
- name String
- Enum type name.
- options List<Property Map>
- Protocol buffer options.
- source
Context Property Map - The source context.
- syntax String
- The source syntax.
EnumValueResponse
- Name string
- Enum value name.
- Number int
- Enum value number.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> - Protocol buffer options.
- Name string
- Enum value name.
- Number int
- Enum value number.
- Options
[]Option
Response - Protocol buffer options.
- name String
- Enum value name.
- number Integer
- Enum value number.
- options
List<Option
Response> - Protocol buffer options.
- name string
- Enum value name.
- number number
- Enum value number.
- options
Option
Response[] - Protocol buffer options.
- name str
- Enum value name.
- number int
- Enum value number.
- options
Sequence[Option
Response] - Protocol buffer options.
- name String
- Enum value name.
- number Number
- Enum value number.
- options List<Property Map>
- Protocol buffer options.
FieldPolicyResponse
- Resource
Permission string - Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- Resource
Type string - Specifies the resource type for the resource referred to by the field.
- Selector string
- Selects one or more request or response message fields to apply this
FieldPolicy
. When aFieldPolicy
is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When aFieldPolicy
is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- Resource
Permission string - Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- Resource
Type string - Specifies the resource type for the resource referred to by the field.
- Selector string
- Selects one or more request or response message fields to apply this
FieldPolicy
. When aFieldPolicy
is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When aFieldPolicy
is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resource
Permission String - Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resource
Type String - Specifies the resource type for the resource referred to by the field.
- selector String
- Selects one or more request or response message fields to apply this
FieldPolicy
. When aFieldPolicy
is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When aFieldPolicy
is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resource
Permission string - Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resource
Type string - Specifies the resource type for the resource referred to by the field.
- selector string
- Selects one or more request or response message fields to apply this
FieldPolicy
. When aFieldPolicy
is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When aFieldPolicy
is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resource_
permission str - Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resource_
type str - Specifies the resource type for the resource referred to by the field.
- selector str
- Selects one or more request or response message fields to apply this
FieldPolicy
. When aFieldPolicy
is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When aFieldPolicy
is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
- resource
Permission String - Specifies the required permission(s) for the resource referred to by the field. It requires the field contains a valid resource reference, and the request must pass the permission checks to proceed. For example, "resourcemanager.projects.get".
- resource
Type String - Specifies the resource type for the resource referred to by the field.
- selector String
- Selects one or more request or response message fields to apply this
FieldPolicy
. When aFieldPolicy
is used in proto annotation, the selector must be left as empty. The service config generator will automatically fill the correct value. When aFieldPolicy
is used in service config, the selector must be a comma-separated string with valid request or response field paths, such as "foo.bar" or "foo.bar,foo.baz".
FieldResponse
- Cardinality string
- The field cardinality.
- Default
Value string - The string value of the default value of this field. Proto2 syntax only.
- Json
Name string - The field JSON name.
- Kind string
- The field type.
- Name string
- The field name.
- Number int
- The field number.
- Oneof
Index int - The index of the field type in
Type.oneofs
, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> - The protocol buffer options.
- Packed bool
- Whether to use alternative packed wire representation.
- Type
Url string - The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
.
- Cardinality string
- The field cardinality.
- Default
Value string - The string value of the default value of this field. Proto2 syntax only.
- Json
Name string - The field JSON name.
- Kind string
- The field type.
- Name string
- The field name.
- Number int
- The field number.
- Oneof
Index int - The index of the field type in
Type.oneofs
, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - Options
[]Option
Response - The protocol buffer options.
- Packed bool
- Whether to use alternative packed wire representation.
- Type
Url string - The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
.
- cardinality String
- The field cardinality.
- default
Value String - The string value of the default value of this field. Proto2 syntax only.
- json
Name String - The field JSON name.
- kind String
- The field type.
- name String
- The field name.
- number Integer
- The field number.
- oneof
Index Integer - The index of the field type in
Type.oneofs
, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - options
List<Option
Response> - The protocol buffer options.
- packed Boolean
- Whether to use alternative packed wire representation.
- type
Url String - The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
.
- cardinality string
- The field cardinality.
- default
Value string - The string value of the default value of this field. Proto2 syntax only.
- json
Name string - The field JSON name.
- kind string
- The field type.
- name string
- The field name.
- number number
- The field number.
- oneof
Index number - The index of the field type in
Type.oneofs
, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - options
Option
Response[] - The protocol buffer options.
- packed boolean
- Whether to use alternative packed wire representation.
- type
Url string - The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
.
- cardinality str
- The field cardinality.
- default_
value str - The string value of the default value of this field. Proto2 syntax only.
- json_
name str - The field JSON name.
- kind str
- The field type.
- name str
- The field name.
- number int
- The field number.
- oneof_
index int - The index of the field type in
Type.oneofs
, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - options
Sequence[Option
Response] - The protocol buffer options.
- packed bool
- Whether to use alternative packed wire representation.
- type_
url str - The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
.
- cardinality String
- The field cardinality.
- default
Value String - The string value of the default value of this field. Proto2 syntax only.
- json
Name String - The field JSON name.
- kind String
- The field type.
- name String
- The field name.
- number Number
- The field number.
- oneof
Index Number - The index of the field type in
Type.oneofs
, for message or enumeration types. The first type has index 1; zero means the type is not in the list. - options List<Property Map>
- The protocol buffer options.
- packed Boolean
- Whether to use alternative packed wire representation.
- type
Url String - The field type URL, without the scheme, for message or enumeration types. Example:
"type.googleapis.com/google.protobuf.Timestamp"
.
GoSettingsResponse
- Common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common Property Map
- Some settings.
HttpResponse
- Fully
Decode boolReserved Expansion - When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Http Rule Response> - A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Fully
Decode boolReserved Expansion - When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
- Rules
[]Http
Rule Response - A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode BooleanReserved Expansion - When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
- rules
List<Http
Rule Response> - A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode booleanReserved Expansion - When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
- rules
Http
Rule Response[] - A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully_
decode_ boolreserved_ expansion - When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
- rules
Sequence[Http
Rule Response] - A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- fully
Decode BooleanReserved Expansion - When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.
- rules List<Property Map>
- A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
HttpRuleResponse
- Additional
Bindings List<Pulumi.Google Native. Service Management. V1. Inputs. Http Rule Response> - Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - Body string
- The name of the request field whose value is mapped to the HTTP request body, or
*
for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. - Custom
Pulumi.
Google Native. Service Management. V1. Inputs. Custom Http Pattern Response - The custom pattern is used for specifying an HTTP method that is not included in the
pattern
field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - Delete string
- Maps to HTTP DELETE. Used for deleting a resource.
- Get string
- Maps to HTTP GET. Used for listing and getting information about resources.
- Patch string
- Maps to HTTP PATCH. Used for updating a resource.
- Post string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- Put string
- Maps to HTTP PUT. Used for replacing a resource.
- Response
Body string - Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
- Selector string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- Additional
Bindings []HttpRule Response - Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - Body string
- The name of the request field whose value is mapped to the HTTP request body, or
*
for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. - Custom
Custom
Http Pattern Response - The custom pattern is used for specifying an HTTP method that is not included in the
pattern
field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - Delete string
- Maps to HTTP DELETE. Used for deleting a resource.
- Get string
- Maps to HTTP GET. Used for listing and getting information about resources.
- Patch string
- Maps to HTTP PATCH. Used for updating a resource.
- Post string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- Put string
- Maps to HTTP PUT. Used for replacing a resource.
- Response
Body string - Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
- Selector string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additional
Bindings List<HttpRule Response> - Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - body String
- The name of the request field whose value is mapped to the HTTP request body, or
*
for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. - custom
Custom
Http Pattern Response - The custom pattern is used for specifying an HTTP method that is not included in the
pattern
field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete String
- Maps to HTTP DELETE. Used for deleting a resource.
- get String
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch String
- Maps to HTTP PATCH. Used for updating a resource.
- post String
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put String
- Maps to HTTP PUT. Used for replacing a resource.
- response
Body String - Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
- selector String
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additional
Bindings HttpRule Response[] - Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - body string
- The name of the request field whose value is mapped to the HTTP request body, or
*
for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. - custom
Custom
Http Pattern Response - The custom pattern is used for specifying an HTTP method that is not included in the
pattern
field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete string
- Maps to HTTP DELETE. Used for deleting a resource.
- get string
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch string
- Maps to HTTP PATCH. Used for updating a resource.
- post string
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put string
- Maps to HTTP PUT. Used for replacing a resource.
- response
Body string - Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
- selector string
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additional_
bindings Sequence[HttpRule Response] - Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - body str
- The name of the request field whose value is mapped to the HTTP request body, or
*
for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. - custom
Custom
Http Pattern Response - The custom pattern is used for specifying an HTTP method that is not included in the
pattern
field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete str
- Maps to HTTP DELETE. Used for deleting a resource.
- get str
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch str
- Maps to HTTP PATCH. Used for updating a resource.
- post str
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put str
- Maps to HTTP PUT. Used for replacing a resource.
- response_
body str - Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
- selector str
- Selects a method to which this rule applies. Refer to selector for syntax details.
- additional
Bindings List<Property Map> - Additional HTTP bindings for the selector. Nested bindings must not contain an
additional_bindings
field themselves (that is, the nesting may only be one level deep). - body String
- The name of the request field whose value is mapped to the HTTP request body, or
*
for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. - custom Property Map
- The custom pattern is used for specifying an HTTP method that is not included in the
pattern
field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients. - delete String
- Maps to HTTP DELETE. Used for deleting a resource.
- get String
- Maps to HTTP GET. Used for listing and getting information about resources.
- patch String
- Maps to HTTP PATCH. Used for updating a resource.
- post String
- Maps to HTTP POST. Used for creating a resource or performing an action.
- put String
- Maps to HTTP PUT. Used for replacing a resource.
- response
Body String - Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
- selector String
- Selects a method to which this rule applies. Refer to selector for syntax details.
JavaSettingsResponse
- Common
Pulumi.
Google Native. Service Management. V1. Inputs. Common Language Settings Response - Some settings.
- Library
Package string - The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used only by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
- Service
Class Dictionary<string, string>Names - Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
- Common
Common
Language Settings Response - Some settings.
- Library
Package string - The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used only by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
- Service
Class map[string]stringNames - Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
- common
Common
Language Settings Response - Some settings.
- library
Package String - The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used only by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
- service
Class Map<String,String>Names - Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
- common
Common
Language Settings Response - Some settings.
- library
Package string - The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used only by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
- service
Class {[key: string]: string}Names - Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
- common
Common
Language Settings Response - Some settings.
- library_
package str - The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used only by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
- service_
class_ Mapping[str, str]names - Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
- common Property Map
- Some settings.
- library
Package String - The package name to use in Java. Clobbers the java_package option set in the protobuf. This should be used only by APIs who have already set the language_settings.java.package_name" field in gapic.yaml. API teams should use the protobuf java_package option where possible. Example of a YAML configuration:: publishing: java_settings: library_package: com.google.cloud.pubsub.v1
- service
Class Map<String>Names - Configure the Java class name to use instead of the service's for its corresponding generated GAPIC client. Keys are fully-qualified service names as they appear in the protobuf (including the full the language_settings.java.interface_names" field in gapic.yaml. API teams should otherwise use the service name as it appears in the protobuf. Example of a YAML configuration:: publishing: java_settings: service_class_names: - google.pubsub.v1.Publisher: TopicAdmin - google.pubsub.v1.Subscriber: SubscriptionAdmin
JwtLocationResponse
- string
- Specifies cookie name to extract JWT token.
- Header string
- Specifies HTTP header name to extract JWT token.
- Query string
- Specifies URL query parameter name to extract JWT token.
- Value
Prefix string - The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
- string
- Specifies cookie name to extract JWT token.
- Header string
- Specifies HTTP header name to extract JWT token.
- Query string
- Specifies URL query parameter name to extract JWT token.
- Value
Prefix string - The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
- String
- Specifies cookie name to extract JWT token.
- header String
- Specifies HTTP header name to extract JWT token.
- query String
- Specifies URL query parameter name to extract JWT token.
- value
Prefix String - The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
- string
- Specifies cookie name to extract JWT token.
- header string
- Specifies HTTP header name to extract JWT token.
- query string
- Specifies URL query parameter name to extract JWT token.
- value
Prefix string - The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
- str
- Specifies cookie name to extract JWT token.
- header str
- Specifies HTTP header name to extract JWT token.
- query str
- Specifies URL query parameter name to extract JWT token.
- value_
prefix str - The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
- String
- Specifies cookie name to extract JWT token.
- header String
- Specifies HTTP header name to extract JWT token.
- query String
- Specifies URL query parameter name to extract JWT token.
- value
Prefix String - The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.
LabelDescriptorResponse
- Description string
- A human-readable description for the label.
- Key string
- The label key.
- Value
Type string - The type of data that can be assigned to the label.
- Description string
- A human-readable description for the label.
- Key string
- The label key.
- Value
Type string - The type of data that can be assigned to the label.
- description String
- A human-readable description for the label.
- key String
- The label key.
- value
Type String - The type of data that can be assigned to the label.
- description string
- A human-readable description for the label.
- key string
- The label key.
- value
Type string - The type of data that can be assigned to the label.
- description str
- A human-readable description for the label.
- key str
- The label key.
- value_
type str - The type of data that can be assigned to the label.
- description String
- A human-readable description for the label.
- key String
- The label key.
- value
Type String - The type of data that can be assigned to the label.
LogDescriptorResponse
- Description string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- Display
Name string - The human-readable name for this log. This information appears on the user interface and should be concise.
- Labels
List<Pulumi.
Google Native. Service Management. V1. Inputs. Label Descriptor Response> - The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- Name string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- Description string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- Display
Name string - The human-readable name for this log. This information appears on the user interface and should be concise.
- Labels
[]Label
Descriptor Response - The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- Name string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description String
- A human-readable description of this log. This information appears in the documentation and can contain details.
- display
Name String - The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
List<Label
Descriptor Response> - The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name String
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description string
- A human-readable description of this log. This information appears in the documentation and can contain details.
- display
Name string - The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
Label
Descriptor Response[] - The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name string
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description str
- A human-readable description of this log. This information appears in the documentation and can contain details.
- display_
name str - The human-readable name for this log. This information appears on the user interface and should be concise.
- labels
Sequence[Label
Descriptor Response] - The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name str
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- description String
- A human-readable description of this log. This information appears in the documentation and can contain details.
- display
Name String - The human-readable name for this log. This information appears on the user interface and should be concise.
- labels List<Property Map>
- The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid.
- name String
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
LoggingDestinationResponse
- Logs List<string>
- Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- Monitored
Resource string - The monitored resource type. The type must be defined in the Service.monitored_resources section.
- Logs []string
- Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- Monitored
Resource string - The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs List<String>
- Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- monitored
Resource String - The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs string[]
- Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- monitored
Resource string - The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs Sequence[str]
- Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- monitored_
resource str - The monitored resource type. The type must be defined in the Service.monitored_resources section.
- logs List<String>
- Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- monitored
Resource String - The monitored resource type. The type must be defined in the Service.monitored_resources section.
LoggingResponse
- Consumer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Logging Destination Response> - Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- Producer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Logging Destination Response> - Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- Consumer
Destinations []LoggingDestination Response - Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- Producer
Destinations []LoggingDestination Response - Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumer
Destinations List<LoggingDestination Response> - Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producer
Destinations List<LoggingDestination Response> - Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumer
Destinations LoggingDestination Response[] - Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producer
Destinations LoggingDestination Response[] - Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumer_
destinations Sequence[LoggingDestination Response] - Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producer_
destinations Sequence[LoggingDestination Response] - Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
- consumer
Destinations List<Property Map> - Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be used in at most one consumer destination.
- producer
Destinations List<Property Map> - Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be used in at most one producer destination.
LongRunningResponse
- Initial
Poll stringDelay - Initial delay after which the first poll request will be made. Default value: 5 seconds.
- Max
Poll stringDelay - Maximum time between two subsequent poll requests. Default value: 45 seconds.
- Poll
Delay doubleMultiplier - Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- Total
Poll stringTimeout - Total polling timeout. Default value: 5 minutes.
- Initial
Poll stringDelay - Initial delay after which the first poll request will be made. Default value: 5 seconds.
- Max
Poll stringDelay - Maximum time between two subsequent poll requests. Default value: 45 seconds.
- Poll
Delay float64Multiplier - Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- Total
Poll stringTimeout - Total polling timeout. Default value: 5 minutes.
- initial
Poll StringDelay - Initial delay after which the first poll request will be made. Default value: 5 seconds.
- max
Poll StringDelay - Maximum time between two subsequent poll requests. Default value: 45 seconds.
- poll
Delay DoubleMultiplier - Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- total
Poll StringTimeout - Total polling timeout. Default value: 5 minutes.
- initial
Poll stringDelay - Initial delay after which the first poll request will be made. Default value: 5 seconds.
- max
Poll stringDelay - Maximum time between two subsequent poll requests. Default value: 45 seconds.
- poll
Delay numberMultiplier - Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- total
Poll stringTimeout - Total polling timeout. Default value: 5 minutes.
- initial_
poll_ strdelay - Initial delay after which the first poll request will be made. Default value: 5 seconds.
- max_
poll_ strdelay - Maximum time between two subsequent poll requests. Default value: 45 seconds.
- poll_
delay_ floatmultiplier - Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- total_
poll_ strtimeout - Total polling timeout. Default value: 5 minutes.
- initial
Poll StringDelay - Initial delay after which the first poll request will be made. Default value: 5 seconds.
- max
Poll StringDelay - Maximum time between two subsequent poll requests. Default value: 45 seconds.
- poll
Delay NumberMultiplier - Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay. Default value: 1.5.
- total
Poll StringTimeout - Total polling timeout. Default value: 5 minutes.
MethodPolicyResponse
- Request
Policies List<Pulumi.Google Native. Service Management. V1. Inputs. Field Policy Response> - Policies that are applicable to the request message.
- Selector string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- Request
Policies []FieldPolicy Response - Policies that are applicable to the request message.
- Selector string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- request
Policies List<FieldPolicy Response> - Policies that are applicable to the request message.
- selector String
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- request
Policies FieldPolicy Response[] - Policies that are applicable to the request message.
- selector string
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- request_
policies Sequence[FieldPolicy Response] - Policies that are applicable to the request message.
- selector str
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
- request
Policies List<Property Map> - Policies that are applicable to the request message.
- selector String
- Selects a method to which these policies should be enforced, for example, "google.pubsub.v1.Subscriber.CreateSubscription". Refer to selector for syntax details. NOTE: This field must not be set in the proto annotation. It will be automatically filled by the service config compiler .
MethodResponse
- Name string
- The simple name of this method.
- Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> - Any metadata attached to the method.
- Request
Streaming bool - If true, the request is streamed.
- Request
Type stringUrl - A URL of the input message type.
- Response
Streaming bool - If true, the response is streamed.
- Response
Type stringUrl - The URL of the output message type.
- Syntax string
- The source syntax of this method.
- Name string
- The simple name of this method.
- Options
[]Option
Response - Any metadata attached to the method.
- Request
Streaming bool - If true, the request is streamed.
- Request
Type stringUrl - A URL of the input message type.
- Response
Streaming bool - If true, the response is streamed.
- Response
Type stringUrl - The URL of the output message type.
- Syntax string
- The source syntax of this method.
- name String
- The simple name of this method.
- options
List<Option
Response> - Any metadata attached to the method.
- request
Streaming Boolean - If true, the request is streamed.
- request
Type StringUrl - A URL of the input message type.
- response
Streaming Boolean - If true, the response is streamed.
- response
Type StringUrl - The URL of the output message type.
- syntax String
- The source syntax of this method.
- name string
- The simple name of this method.
- options
Option
Response[] - Any metadata attached to the method.
- request
Streaming boolean - If true, the request is streamed.
- request
Type stringUrl - A URL of the input message type.
- response
Streaming boolean - If true, the response is streamed.
- response
Type stringUrl - The URL of the output message type.
- syntax string
- The source syntax of this method.
- name str
- The simple name of this method.
- options
Sequence[Option
Response] - Any metadata attached to the method.
- request_
streaming bool - If true, the request is streamed.
- request_
type_ strurl - A URL of the input message type.
- response_
streaming bool - If true, the response is streamed.
- response_
type_ strurl - The URL of the output message type.
- syntax str
- The source syntax of this method.
- name String
- The simple name of this method.
- options List<Property Map>
- Any metadata attached to the method.
- request
Streaming Boolean - If true, the request is streamed.
- request
Type StringUrl - A URL of the input message type.
- response
Streaming Boolean - If true, the response is streamed.
- response
Type StringUrl - The URL of the output message type.
- syntax String
- The source syntax of this method.
MethodSettingsResponse
- Long
Running Pulumi.Google Native. Service Management. V1. Inputs. Long Running Response - Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- Selector string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- Long
Running LongRunning Response - Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- Selector string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- long
Running LongRunning Response - Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector String
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- long
Running LongRunning Response - Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector string
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- long_
running LongRunning Response - Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector str
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
- long
Running Property Map - Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto. Example of a YAML configuration:: publishing: method_settings: - selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes
- selector String
- The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.
MetricDescriptorMetadataResponse
- Ingest
Delay string - The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
- Launch
Stage string - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- Sample
Period string - The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
- Ingest
Delay string - The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
- Launch
Stage string - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- Sample
Period string - The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
- ingest
Delay String - The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
- launch
Stage String - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period String - The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
- ingest
Delay string - The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
- launch
Stage string - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period string - The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
- ingest_
delay str - The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
- launch_
stage str - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample_
period str - The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
- ingest
Delay String - The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.
- launch
Stage String - Deprecated. Must use the MetricDescriptor.launch_stage instead.
- sample
Period String - The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.
MetricDescriptorResponse
- Description string
- A detailed description of the metric, which can be used in documentation.
- Display
Name string - A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
- Labels
List<Pulumi.
Google Native. Service Management. V1. Inputs. Label Descriptor Response> - The set of labels that can be used to describe a specific instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - Launch
Stage string - Optional. The launch stage of the metric definition.
- Metadata
Pulumi.
Google Native. Service Management. V1. Inputs. Metric Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- Metric
Kind string - Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported. - Monitored
Resource List<string>Types - Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
- Name string
- The resource name of the metric descriptor.
- Type string
- The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com
orexternal.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" - Unit string
- The units in which the metric value is reported. It is only applicable if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/1024
). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bit
bit *By
byte *s
second *min
minute *h
hour *d
day *1
dimensionless Prefixes (PREFIX) *k
kilo (10^3) *M
mega (10^6) *G
giga (10^9) *T
tera (10^12) *P
peta (10^15) *E
exa (10^18) *Z
zetta (10^21) *Y
yotta (10^24) *m
milli (10^-3) *u
micro (10^-6) *n
nano (10^-9) *p
pico (10^-12) *f
femto (10^-15) *a
atto (10^-18) *z
zepto (10^-21) *y
yocto (10^-24) *Ki
kibi (2^10) *Mi
mebi (2^20) *Gi
gibi (2^30) *Ti
tebi (2^40) *Pi
pebi (2^50) Grammar The grammar also includes these connectors: */
division or ratio (as an infix operator). For examples,kBy/{email}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; rates should always be computed at query time from the underlying cumulative or delta value). *.
multiplication or composition (as an infix operator). For examples,GBy.d
ork{watt}.h
. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: *Annotation
is just a comment if it follows aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. For examples,{request}/s == 1/s
,By{transmitted}/s == By/s
. *NAME
is a sequence of non-blank printable ASCII characters not containing{
or}
. *1
represents a unitary dimensionless unit of 1, such as in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.3
would mean "5300 page views per day"). *%
represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value3
means "3 percent"). *10^2.%
indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value0.03
means "3 percent"). - Value
Type string - Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.
- Description string
- A detailed description of the metric, which can be used in documentation.
- Display
Name string - A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
- Labels
[]Label
Descriptor Response - The set of labels that can be used to describe a specific instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - Launch
Stage string - Optional. The launch stage of the metric definition.
- Metadata
Metric
Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- Metric
Kind string - Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported. - Monitored
Resource []stringTypes - Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
- Name string
- The resource name of the metric descriptor.
- Type string
- The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com
orexternal.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" - Unit string
- The units in which the metric value is reported. It is only applicable if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/1024
). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bit
bit *By
byte *s
second *min
minute *h
hour *d
day *1
dimensionless Prefixes (PREFIX) *k
kilo (10^3) *M
mega (10^6) *G
giga (10^9) *T
tera (10^12) *P
peta (10^15) *E
exa (10^18) *Z
zetta (10^21) *Y
yotta (10^24) *m
milli (10^-3) *u
micro (10^-6) *n
nano (10^-9) *p
pico (10^-12) *f
femto (10^-15) *a
atto (10^-18) *z
zepto (10^-21) *y
yocto (10^-24) *Ki
kibi (2^10) *Mi
mebi (2^20) *Gi
gibi (2^30) *Ti
tebi (2^40) *Pi
pebi (2^50) Grammar The grammar also includes these connectors: */
division or ratio (as an infix operator). For examples,kBy/{email}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; rates should always be computed at query time from the underlying cumulative or delta value). *.
multiplication or composition (as an infix operator). For examples,GBy.d
ork{watt}.h
. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: *Annotation
is just a comment if it follows aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. For examples,{request}/s == 1/s
,By{transmitted}/s == By/s
. *NAME
is a sequence of non-blank printable ASCII characters not containing{
or}
. *1
represents a unitary dimensionless unit of 1, such as in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.3
would mean "5300 page views per day"). *%
represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value3
means "3 percent"). *10^2.%
indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value0.03
means "3 percent"). - Value
Type string - Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.
- description String
- A detailed description of the metric, which can be used in documentation.
- display
Name String - A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
- labels
List<Label
Descriptor Response> - The set of labels that can be used to describe a specific instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - launch
Stage String - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind String - Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported. - monitored
Resource List<String>Types - Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
- name String
- The resource name of the metric descriptor.
- type String
- The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com
orexternal.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" - unit String
- The units in which the metric value is reported. It is only applicable if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/1024
). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bit
bit *By
byte *s
second *min
minute *h
hour *d
day *1
dimensionless Prefixes (PREFIX) *k
kilo (10^3) *M
mega (10^6) *G
giga (10^9) *T
tera (10^12) *P
peta (10^15) *E
exa (10^18) *Z
zetta (10^21) *Y
yotta (10^24) *m
milli (10^-3) *u
micro (10^-6) *n
nano (10^-9) *p
pico (10^-12) *f
femto (10^-15) *a
atto (10^-18) *z
zepto (10^-21) *y
yocto (10^-24) *Ki
kibi (2^10) *Mi
mebi (2^20) *Gi
gibi (2^30) *Ti
tebi (2^40) *Pi
pebi (2^50) Grammar The grammar also includes these connectors: */
division or ratio (as an infix operator). For examples,kBy/{email}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; rates should always be computed at query time from the underlying cumulative or delta value). *.
multiplication or composition (as an infix operator). For examples,GBy.d
ork{watt}.h
. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: *Annotation
is just a comment if it follows aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. For examples,{request}/s == 1/s
,By{transmitted}/s == By/s
. *NAME
is a sequence of non-blank printable ASCII characters not containing{
or}
. *1
represents a unitary dimensionless unit of 1, such as in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.3
would mean "5300 page views per day"). *%
represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value3
means "3 percent"). *10^2.%
indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value0.03
means "3 percent"). - value
Type String - Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.
- description string
- A detailed description of the metric, which can be used in documentation.
- display
Name string - A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
- labels
Label
Descriptor Response[] - The set of labels that can be used to describe a specific instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - launch
Stage string - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind string - Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported. - monitored
Resource string[]Types - Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
- name string
- The resource name of the metric descriptor.
- type string
- The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com
orexternal.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" - unit string
- The units in which the metric value is reported. It is only applicable if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/1024
). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bit
bit *By
byte *s
second *min
minute *h
hour *d
day *1
dimensionless Prefixes (PREFIX) *k
kilo (10^3) *M
mega (10^6) *G
giga (10^9) *T
tera (10^12) *P
peta (10^15) *E
exa (10^18) *Z
zetta (10^21) *Y
yotta (10^24) *m
milli (10^-3) *u
micro (10^-6) *n
nano (10^-9) *p
pico (10^-12) *f
femto (10^-15) *a
atto (10^-18) *z
zepto (10^-21) *y
yocto (10^-24) *Ki
kibi (2^10) *Mi
mebi (2^20) *Gi
gibi (2^30) *Ti
tebi (2^40) *Pi
pebi (2^50) Grammar The grammar also includes these connectors: */
division or ratio (as an infix operator). For examples,kBy/{email}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; rates should always be computed at query time from the underlying cumulative or delta value). *.
multiplication or composition (as an infix operator). For examples,GBy.d
ork{watt}.h
. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: *Annotation
is just a comment if it follows aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. For examples,{request}/s == 1/s
,By{transmitted}/s == By/s
. *NAME
is a sequence of non-blank printable ASCII characters not containing{
or}
. *1
represents a unitary dimensionless unit of 1, such as in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.3
would mean "5300 page views per day"). *%
represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value3
means "3 percent"). *10^2.%
indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value0.03
means "3 percent"). - value
Type string - Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.
- description str
- A detailed description of the metric, which can be used in documentation.
- display_
name str - A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
- labels
Sequence[Label
Descriptor Response] - The set of labels that can be used to describe a specific instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - launch_
stage str - Optional. The launch stage of the metric definition.
- metadata
Metric
Descriptor Metadata Response - Optional. Metadata which can be used to guide usage of the metric.
- metric_
kind str - Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported. - monitored_
resource_ Sequence[str]types - Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
- name str
- The resource name of the metric descriptor.
- type str
- The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com
orexternal.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" - unit str
- The units in which the metric value is reported. It is only applicable if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/1024
). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bit
bit *By
byte *s
second *min
minute *h
hour *d
day *1
dimensionless Prefixes (PREFIX) *k
kilo (10^3) *M
mega (10^6) *G
giga (10^9) *T
tera (10^12) *P
peta (10^15) *E
exa (10^18) *Z
zetta (10^21) *Y
yotta (10^24) *m
milli (10^-3) *u
micro (10^-6) *n
nano (10^-9) *p
pico (10^-12) *f
femto (10^-15) *a
atto (10^-18) *z
zepto (10^-21) *y
yocto (10^-24) *Ki
kibi (2^10) *Mi
mebi (2^20) *Gi
gibi (2^30) *Ti
tebi (2^40) *Pi
pebi (2^50) Grammar The grammar also includes these connectors: */
division or ratio (as an infix operator). For examples,kBy/{email}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; rates should always be computed at query time from the underlying cumulative or delta value). *.
multiplication or composition (as an infix operator). For examples,GBy.d
ork{watt}.h
. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: *Annotation
is just a comment if it follows aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. For examples,{request}/s == 1/s
,By{transmitted}/s == By/s
. *NAME
is a sequence of non-blank printable ASCII characters not containing{
or}
. *1
represents a unitary dimensionless unit of 1, such as in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.3
would mean "5300 page views per day"). *%
represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value3
means "3 percent"). *10^2.%
indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value0.03
means "3 percent"). - value_
type str - Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.
- description String
- A detailed description of the metric, which can be used in documentation.
- display
Name String - A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.
- labels List<Property Map>
- The set of labels that can be used to describe a specific instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric type has a label for the HTTP response code,response_code
, so you can look at latencies for successful responses or just for responses that failed. - launch
Stage String - Optional. The launch stage of the metric definition.
- metadata Property Map
- Optional. Metadata which can be used to guide usage of the metric.
- metric
Kind String - Whether the metric records instantaneous values, changes to a value, etc. Some combinations of
metric_kind
andvalue_type
might not be supported. - monitored
Resource List<String>Types - Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.
- name String
- The resource name of the metric descriptor.
- type String
- The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com
orexternal.googleapis.com
. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" - unit String
- The units in which the metric value is reported. It is only applicable if the
value_type
isINT64
,DOUBLE
, orDISTRIBUTION
. Theunit
defines the representation of the stored metric values. Different systems might scale the values to be more easily displayed (so a value of0.02kBy
might be displayed as20By
, and a value of3523kBy
might be displayed as3.5MBy
). However, if theunit
iskBy
, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create anINT64 CUMULATIVE
metric whoseunit
iss{CPU}
(or equivalently1s{CPU}
or justs
). If the job uses 12,005 CPU-seconds, then the value is written as12005
. Alternatively, if you want a custom metric to record data in a more granular way, you can create aDOUBLE CUMULATIVE
metric whoseunit
isks{CPU}
, and then write the value12.005
(which is12005/1000
), or useKis{CPU}
and write11.723
(which is12005/1024
). The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bit
bit *By
byte *s
second *min
minute *h
hour *d
day *1
dimensionless Prefixes (PREFIX) *k
kilo (10^3) *M
mega (10^6) *G
giga (10^9) *T
tera (10^12) *P
peta (10^15) *E
exa (10^18) *Z
zetta (10^21) *Y
yotta (10^24) *m
milli (10^-3) *u
micro (10^-6) *n
nano (10^-9) *p
pico (10^-12) *f
femto (10^-15) *a
atto (10^-18) *z
zepto (10^-21) *y
yocto (10^-24) *Ki
kibi (2^10) *Mi
mebi (2^20) *Gi
gibi (2^30) *Ti
tebi (2^40) *Pi
pebi (2^50) Grammar The grammar also includes these connectors: */
division or ratio (as an infix operator). For examples,kBy/{email}
orMiBy/10ms
(although you should almost never have/s
in a metricunit
; rates should always be computed at query time from the underlying cumulative or delta value). *.
multiplication or composition (as an infix operator). For examples,GBy.d
ork{watt}.h
. The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: *Annotation
is just a comment if it follows aUNIT
. If the annotation is used alone, then the unit is equivalent to1
. For examples,{request}/s == 1/s
,By{transmitted}/s == By/s
. *NAME
is a sequence of non-blank printable ASCII characters not containing{
or}
. *1
represents a unitary dimensionless unit of 1, such as in1/s
. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as1/d
or{new-users}/d
(and a metric value5
would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as1000/d
ork1/d
ork{page_views}/d
(and a metric value of5.3
would mean "5300 page views per day"). *%
represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value3
means "3 percent"). *10^2.%
indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value0.03
means "3 percent"). - value
Type String - Whether the measurement is an integer, a floating-point number, etc. Some combinations of
metric_kind
andvalue_type
might not be supported.
MetricRuleResponse
- Metric
Costs Dictionary<string, string> - Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
- Selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- Metric
Costs map[string]string - Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
- Selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metric
Costs Map<String,String> - Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
- selector String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metric
Costs {[key: string]: string} - Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
- selector string
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metric_
costs Mapping[str, str] - Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
- selector str
- Selects the methods to which this rule applies. Refer to selector for syntax details.
- metric
Costs Map<String> - Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount increased for the metric against which the quota limits are defined. The value must not be negative.
- selector String
- Selects the methods to which this rule applies. Refer to selector for syntax details.
MixinResponse
MonitoredResourceDescriptorResponse
- Description string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- Display
Name string - Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example,
"Google Cloud SQL Database"
. - Labels
List<Pulumi.
Google Native. Service Management. V1. Inputs. Label Descriptor Response> - A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels
"database_id"
and"zone"
. - Launch
Stage string - Optional. The launch stage of the monitored resource definition.
- Name string
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - Type string
- The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.
- Description string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- Display
Name string - Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example,
"Google Cloud SQL Database"
. - Labels
[]Label
Descriptor Response - A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels
"database_id"
and"zone"
. - Launch
Stage string - Optional. The launch stage of the monitored resource definition.
- Name string
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - Type string
- The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.
- description String
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- display
Name String - Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example,
"Google Cloud SQL Database"
. - labels
List<Label
Descriptor Response> - A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels
"database_id"
and"zone"
. - launch
Stage String - Optional. The launch stage of the monitored resource definition.
- name String
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - type String
- The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.
- description string
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- display
Name string - Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example,
"Google Cloud SQL Database"
. - labels
Label
Descriptor Response[] - A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels
"database_id"
and"zone"
. - launch
Stage string - Optional. The launch stage of the monitored resource definition.
- name string
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - type string
- The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.
- description str
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- display_
name str - Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example,
"Google Cloud SQL Database"
. - labels
Sequence[Label
Descriptor Response] - A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels
"database_id"
and"zone"
. - launch_
stage str - Optional. The launch stage of the monitored resource definition.
- name str
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - type str
- The monitored resource type. For example, the type
"cloudsql_database"
represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types and Logging resource types.
- description String
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- display
Name String - Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example,
"Google Cloud SQL Database"
. - labels List<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"
. - launch
Stage String - Optional. The launch stage of the monitored resource definition.
- name String
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"
where {type} is the value of thetype
field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}"
. - 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.
MonitoringDestinationResponse
- Metrics List<string>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- Monitored
Resource string - The monitored resource type. The type must be defined in Service.monitored_resources section.
- Metrics []string
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- Monitored
Resource string - The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics List<String>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitored
Resource String - The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics string[]
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitored
Resource string - The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics Sequence[str]
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitored_
resource str - The monitored resource type. The type must be defined in Service.monitored_resources section.
- metrics List<String>
- Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section.
- monitored
Resource String - The monitored resource type. The type must be defined in Service.monitored_resources section.
MonitoringResponse
- Consumer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Monitoring Destination Response> - Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- Producer
Destinations List<Pulumi.Google Native. Service Management. V1. Inputs. Monitoring Destination Response> - Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- Consumer
Destinations []MonitoringDestination Response - Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- Producer
Destinations []MonitoringDestination Response - Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- consumer
Destinations List<MonitoringDestination Response> - Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- producer
Destinations List<MonitoringDestination Response> - Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- consumer
Destinations MonitoringDestination Response[] - Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- producer
Destinations MonitoringDestination Response[] - Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- consumer_
destinations Sequence[MonitoringDestination Response] - Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- producer_
destinations Sequence[MonitoringDestination Response] - Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- consumer
Destinations List<Property Map> - Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
- producer
Destinations List<Property Map> - Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.
NodeSettingsResponse
- Common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common Property Map
- Some settings.
OAuthRequirementsResponse
- Canonical
Scopes string - The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- Canonical
Scopes string - The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonical
Scopes String - The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonical
Scopes string - The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonical_
scopes str - The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
- canonical
Scopes String - The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
OptionResponse
- Name string
- The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example,
"map_entry"
. For custom options, it should be the fully-qualified name. For example,"google.api.http"
. - Value Dictionary<string, string>
- The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
- Name string
- The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example,
"map_entry"
. For custom options, it should be the fully-qualified name. For example,"google.api.http"
. - Value map[string]string
- The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
- name String
- The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example,
"map_entry"
. For custom options, it should be the fully-qualified name. For example,"google.api.http"
. - value Map<String,String>
- The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
- name string
- The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example,
"map_entry"
. For custom options, it should be the fully-qualified name. For example,"google.api.http"
. - value {[key: string]: string}
- The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
- name str
- The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example,
"map_entry"
. For custom options, it should be the fully-qualified name. For example,"google.api.http"
. - value Mapping[str, str]
- The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
- name String
- The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example,
"map_entry"
. For custom options, it should be the fully-qualified name. For example,"google.api.http"
. - value Map<String>
- The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
PageResponse
- Content string
- The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
- Name string
- The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with
.
) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can referenceJava
page using Markdown reference link syntax:Java
. - Subpages
List<Pulumi.
Google Native. Service Management. V1. Inputs. Page Response> - Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- Content string
- The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
- Name string
- The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with
.
) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can referenceJava
page using Markdown reference link syntax:Java
. - Subpages
[]Page
Response - Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content String
- The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
- name String
- The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with
.
) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can referenceJava
page using Markdown reference link syntax:Java
. - subpages
List<Page
Response> - Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content string
- The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
- name string
- The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with
.
) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can referenceJava
page using Markdown reference link syntax:Java
. - subpages
Page
Response[] - Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content str
- The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
- name str
- The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with
.
) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can referenceJava
page using Markdown reference link syntax:Java
. - subpages
Sequence[Page
Response] - Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- content String
- The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.
- name String
- The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with
.
) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can referenceJava
page using Markdown reference link syntax:Java
. - subpages List<Property Map>
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
PhpSettingsResponse
- Common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common Property Map
- Some settings.
PublishingResponse
- Api
Short stringName - Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- Codeowner
Github List<string>Teams - GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- Doc
Tag stringPrefix - A prefix used in sample code when demarking regions to be included in documentation.
- Documentation
Uri string - Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- Github
Label string - GitHub label to apply to issues and pull requests opened for this API.
- Library
Settings List<Pulumi.Google Native. Service Management. V1. Inputs. Client Library Settings Response> - Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
- Method
Settings List<Pulumi.Google Native. Service Management. V1. Inputs. Method Settings Response> - A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- New
Issue stringUri - Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- Organization string
- For whom the client library is being published.
- Proto
Reference stringDocumentation Uri - Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- Api
Short stringName - Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- Codeowner
Github []stringTeams - GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- Doc
Tag stringPrefix - A prefix used in sample code when demarking regions to be included in documentation.
- Documentation
Uri string - Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- Github
Label string - GitHub label to apply to issues and pull requests opened for this API.
- Library
Settings []ClientLibrary Settings Response - Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
- Method
Settings []MethodSettings Response - A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- New
Issue stringUri - Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- Organization string
- For whom the client library is being published.
- Proto
Reference stringDocumentation Uri - Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- api
Short StringName - Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeowner
Github List<String>Teams - GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- doc
Tag StringPrefix - A prefix used in sample code when demarking regions to be included in documentation.
- documentation
Uri String - Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- github
Label String - GitHub label to apply to issues and pull requests opened for this API.
- library
Settings List<ClientLibrary Settings Response> - Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
- method
Settings List<MethodSettings Response> - A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- new
Issue StringUri - Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization String
- For whom the client library is being published.
- proto
Reference StringDocumentation Uri - Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- api
Short stringName - Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeowner
Github string[]Teams - GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- doc
Tag stringPrefix - A prefix used in sample code when demarking regions to be included in documentation.
- documentation
Uri string - Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- github
Label string - GitHub label to apply to issues and pull requests opened for this API.
- library
Settings ClientLibrary Settings Response[] - Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
- method
Settings MethodSettings Response[] - A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- new
Issue stringUri - Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization string
- For whom the client library is being published.
- proto
Reference stringDocumentation Uri - Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- api_
short_ strname - Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeowner_
github_ Sequence[str]teams - GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- doc_
tag_ strprefix - A prefix used in sample code when demarking regions to be included in documentation.
- documentation_
uri str - Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- github_
label str - GitHub label to apply to issues and pull requests opened for this API.
- library_
settings Sequence[ClientLibrary Settings Response] - Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
- method_
settings Sequence[MethodSettings Response] - A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- new_
issue_ struri - Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization str
- For whom the client library is being published.
- proto_
reference_ strdocumentation_ uri - Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
- api
Short StringName - Used as a tracking tag when collecting data about the APIs developer relations artifacts like docs, packages delivered to package managers, etc. Example: "speech".
- codeowner
Github List<String>Teams - GitHub teams to be added to CODEOWNERS in the directory in GitHub containing source code for the client libraries for this API.
- doc
Tag StringPrefix - A prefix used in sample code when demarking regions to be included in documentation.
- documentation
Uri String - Link to product home page. Example: https://cloud.google.com/asset-inventory/docs/overview
- github
Label String - GitHub label to apply to issues and pull requests opened for this API.
- library
Settings List<Property Map> - Client library settings. If the same version string appears multiple times in this list, then the last one wins. Settings from earlier settings with the same version string are discarded.
- method
Settings List<Property Map> - A list of API method settings, e.g. the behavior for methods that use the long-running operation pattern.
- new
Issue StringUri - Link to a public URI where users can report issues. Example: https://issuetracker.google.com/issues/new?component=190865&template=1161103
- organization String
- For whom the client library is being published.
- proto
Reference StringDocumentation Uri - Optional link to proto reference documentation. Example: https://cloud.google.com/pubsub/lite/docs/reference/rpc
PythonSettingsResponse
- Common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common Property Map
- Some settings.
QuotaLimitResponse
- Default
Limit string - Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
- Description string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name
). - Display
Name string - User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- Duration string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- Free
Tier string - Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
- Max
Limit string - Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
- Metric string
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- Name string
- Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
- Unit string
- Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
- Values Dictionary<string, string>
- Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
- Default
Limit string - Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
- Description string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name
). - Display
Name string - User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- Duration string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- Free
Tier string - Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
- Max
Limit string - Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
- Metric string
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- Name string
- Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
- Unit string
- Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
- Values map[string]string
- Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
- default
Limit String - Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
- description String
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name
). - display
Name String - User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration String
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- free
Tier String - Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
- max
Limit String - Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
- metric String
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- name String
- Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
- unit String
- Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
- values Map<String,String>
- Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
- default
Limit string - Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
- description string
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name
). - display
Name string - User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration string
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- free
Tier string - Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
- max
Limit string - Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
- metric string
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- name string
- Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
- unit string
- Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
- values {[key: string]: string}
- Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
- default_
limit str - Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
- description str
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name
). - display_
name str - User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration str
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- free_
tier str - Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
- max_
limit str - Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
- metric str
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- name str
- Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
- unit str
- Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
- values Mapping[str, str]
- Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
- default
Limit String - Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1 will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
- description String
- Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name (see:
display_name
). - display
Name String - User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the default display name generated from the configuration.
- duration String
- Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only.
- free
Tier String - Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled. This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is no free tier for this service. Used by group-based quotas only.
- max
Limit String - Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to -1, indicating unlimited maximum quota. Used by group-based quotas only.
- metric String
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- name String
- Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of the limit name is 64 characters.
- unit String
- Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
- values Map<String>
- Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD is supported.
QuotaResponse
- Limits
List<Pulumi.
Google Native. Service Management. V1. Inputs. Quota Limit Response> - List of QuotaLimit definitions for the service.
- Metric
Rules List<Pulumi.Google Native. Service Management. V1. Inputs. Metric Rule Response> - List of MetricRule definitions, each one mapping a selected method to one or more metrics.
- Limits
[]Quota
Limit Response - List of QuotaLimit definitions for the service.
- Metric
Rules []MetricRule Response - List of MetricRule definitions, each one mapping a selected method to one or more metrics.
- limits
List<Quota
Limit Response> - List of QuotaLimit definitions for the service.
- metric
Rules List<MetricRule Response> - List of MetricRule definitions, each one mapping a selected method to one or more metrics.
- limits
Quota
Limit Response[] - List of QuotaLimit definitions for the service.
- metric
Rules MetricRule Response[] - List of MetricRule definitions, each one mapping a selected method to one or more metrics.
- limits
Sequence[Quota
Limit Response] - List of QuotaLimit definitions for the service.
- metric_
rules Sequence[MetricRule Response] - List of MetricRule definitions, each one mapping a selected method to one or more metrics.
- limits List<Property Map>
- List of QuotaLimit definitions for the service.
- metric
Rules List<Property Map> - List of MetricRule definitions, each one mapping a selected method to one or more metrics.
RubySettingsResponse
- Common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common
Common
Language Settings Response - Some settings.
- common Property Map
- Some settings.
SourceContextResponse
- File
Name string - The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto"
.
- File
Name string - The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto"
.
- file
Name String - The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto"
.
- file
Name string - The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto"
.
- file_
name str - The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto"
.
- file
Name String - The path-qualified name of the .proto file that contained the associated protobuf element. For example:
"google/protobuf/source_context.proto"
.
SourceInfoResponse
- Source
Files List<ImmutableDictionary<string, string>> - All files used during config generation.
- Source
Files []map[string]string - All files used during config generation.
- source
Files List<Map<String,String>> - All files used during config generation.
- source
Files {[key: string]: string}[] - All files used during config generation.
- source_
files Sequence[Mapping[str, str]] - All files used during config generation.
- source
Files List<Map<String>> - All files used during config generation.
SystemParameterResponse
- Http
Header string - Define the HTTP header name to use for the parameter. It is case insensitive.
- Name string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- Url
Query stringParameter - Define the URL query parameter name to use for the parameter. It is case sensitive.
- Http
Header string - Define the HTTP header name to use for the parameter. It is case insensitive.
- Name string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- Url
Query stringParameter - Define the URL query parameter name to use for the parameter. It is case sensitive.
- http
Header String - Define the HTTP header name to use for the parameter. It is case insensitive.
- name String
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- url
Query StringParameter - Define the URL query parameter name to use for the parameter. It is case sensitive.
- http
Header string - Define the HTTP header name to use for the parameter. It is case insensitive.
- name string
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- url
Query stringParameter - Define the URL query parameter name to use for the parameter. It is case sensitive.
- http_
header str - Define the HTTP header name to use for the parameter. It is case insensitive.
- name str
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- url_
query_ strparameter - Define the URL query parameter name to use for the parameter. It is case sensitive.
- http
Header String - Define the HTTP header name to use for the parameter. It is case insensitive.
- name String
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- url
Query StringParameter - Define the URL query parameter name to use for the parameter. It is case sensitive.
SystemParameterRuleResponse
- Parameters
List<Pulumi.
Google Native. Service Management. V1. Inputs. System Parameter Response> - Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- Selector string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- Parameters
[]System
Parameter Response - Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- Selector string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
List<System
Parameter Response> - Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
System
Parameter Response[] - Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters
Sequence[System
Parameter Response] - Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector str
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- parameters List<Property Map>
- Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
- selector String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
SystemParametersResponse
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. System Parameter Rule Response> - Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 NOTE: All service configuration rules follow "last one wins" order.
- Rules
[]System
Parameter Rule Response - Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 NOTE: All service configuration rules follow "last one wins" order.
- rules
List<System
Parameter Rule Response> - Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 NOTE: All service configuration rules follow "last one wins" order.
- rules
System
Parameter Rule Response[] - Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 NOTE: All service configuration rules follow "last one wins" order.
- rules
Sequence[System
Parameter Rule Response] - Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 NOTE: All service configuration rules follow "last one wins" order.
- rules List<Property Map>
- Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*" parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: - name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 NOTE: All service configuration rules follow "last one wins" order.
TypeResponse
- Edition string
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- Fields
List<Pulumi.
Google Native. Service Management. V1. Inputs. Field Response> - The list of fields.
- Name string
- The fully qualified message name.
- Oneofs List<string>
- The list of types appearing in
oneof
definitions in this type. - Options
List<Pulumi.
Google Native. Service Management. V1. Inputs. Option Response> - The protocol buffer options.
- Source
Context Pulumi.Google Native. Service Management. V1. Inputs. Source Context Response - The source context.
- Syntax string
- The source syntax.
- Edition string
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- Fields
[]Field
Response - The list of fields.
- Name string
- The fully qualified message name.
- Oneofs []string
- The list of types appearing in
oneof
definitions in this type. - Options
[]Option
Response - The protocol buffer options.
- Source
Context SourceContext Response - The source context.
- Syntax string
- The source syntax.
- edition String
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- fields
List<Field
Response> - The list of fields.
- name String
- The fully qualified message name.
- oneofs List<String>
- The list of types appearing in
oneof
definitions in this type. - options
List<Option
Response> - The protocol buffer options.
- source
Context SourceContext Response - The source context.
- syntax String
- The source syntax.
- edition string
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- fields
Field
Response[] - The list of fields.
- name string
- The fully qualified message name.
- oneofs string[]
- The list of types appearing in
oneof
definitions in this type. - options
Option
Response[] - The protocol buffer options.
- source
Context SourceContext Response - The source context.
- syntax string
- The source syntax.
- edition str
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- fields
Sequence[Field
Response] - The list of fields.
- name str
- The fully qualified message name.
- oneofs Sequence[str]
- The list of types appearing in
oneof
definitions in this type. - options
Sequence[Option
Response] - The protocol buffer options.
- source_
context SourceContext Response - The source context.
- syntax str
- The source syntax.
- edition String
- The source edition string, only valid when syntax is SYNTAX_EDITIONS.
- fields List<Property Map>
- The list of fields.
- name String
- The fully qualified message name.
- oneofs List<String>
- The list of types appearing in
oneof
definitions in this type. - options List<Property Map>
- The protocol buffer options.
- source
Context Property Map - The source context.
- syntax String
- The source syntax.
UsageResponse
- Producer
Notification stringChannel - The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
- Requirements List<string>
- Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
- Rules
List<Pulumi.
Google Native. Service Management. V1. Inputs. Usage Rule Response> - A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- Producer
Notification stringChannel - The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
- Requirements []string
- Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
- Rules
[]Usage
Rule Response - A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producer
Notification StringChannel - The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
- requirements List<String>
- Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
- rules
List<Usage
Rule Response> - A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producer
Notification stringChannel - The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
- requirements string[]
- Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
- rules
Usage
Rule Response[] - A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producer_
notification_ strchannel - The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
- requirements Sequence[str]
- Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
- rules
Sequence[Usage
Rule Response] - A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
- producer
Notification StringChannel - The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
- requirements List<String>
- Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
- rules List<Property Map>
- A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.
UsageRuleResponse
- Allow
Unregistered boolCalls - If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- Selector string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- Skip
Service boolControl - If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
- Allow
Unregistered boolCalls - If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- Selector string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- Skip
Service boolControl - If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
- allow
Unregistered BooleanCalls - If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skip
Service BooleanControl - If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
- allow
Unregistered booleanCalls - If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector string
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skip
Service booleanControl - If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
- allow_
unregistered_ boolcalls - If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector str
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skip_
service_ boolcontrol - If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
- allow
Unregistered BooleanCalls - If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application.
- selector String
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details.
- skip
Service BooleanControl - If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi