ConfigArgs class

The set of arguments for Config. The set of arguments for Config.

Constructors

ConfigArgs({Input<List<Api>>? apis, Input<Authentication>? authentication, Input<Backend>? backend, Input<Billing>? billing, Input<int>? configVersion, Input<Context>? context, Input<Control>? control, Input<CustomError>? customError, Input<Documentation>? documentation, Input<List<Endpoint>>? endpoints, Input<List<Enum>>? enums, Input<Http>? http, Input<String>? id, Input<Logging>? logging, Input<List<LogDescriptor>>? logs, Input<List<MetricDescriptor>>? metrics, Input<List<MonitoredResourceDescriptor>>? monitoredResources, Input<Monitoring>? monitoring, Input<String>? name, Input<String>? producerProjectId, Input<Publishing>? publishing, Input<Quota>? quota, required Input<String> serviceName, Input<SystemParameters>? systemParameters, Input<List<Type>>? systemTypes, Input<String>? title, Input<List<Type>>? types, Input<Usage>? usage})
Creates a new ConfigArgs. apis 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 Auth configuration. backend API backend configuration. billing Billing configuration. configVersion Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3. context Context configuration. control Configuration for the service control plane. customError Custom error configuration. documentation Additional API documentation. endpoints 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 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 configuration. id A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead. logging Logging configuration. logs Defines the logs used by this service. metrics Defines the metrics used by this service. monitoredResources Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. monitoring Monitoring configuration. name The service name, which is a DNS-like logical identifier for the service, such as calendar.googleapis.com. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. producerProjectId The Google project that owns this service. publishing Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers. quota Quota configuration. serviceName Required. systemParameters System parameter configuration. systemTypes 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 The product title for this service, it is the name displayed in Google Cloud Console. types A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 usage Configuration controlling usage of this service.
const
ConfigArgs.fromMap(Map<String, dynamic> map)
factory

Properties

apis → Input<List<Api>>?
A list of API interfaces exported by this service. Only the name field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
final
authentication → Input<Authentication>?
Auth configuration.
final
backend → Input<Backend>?
API backend configuration.
final
billing → Input<Billing>?
Billing configuration.
final
configVersion → Input<int>?
Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.
final
context → Input<Context>?
Context configuration.
final
control → Input<Control>?
Configuration for the service control plane.
final
customError → Input<CustomError>?
Custom error configuration.
final
documentation → Input<Documentation>?
Additional API documentation.
final
endpoints → Input<List<Endpoint>>?
Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
final
enums → Input<List<Enum>>?
A list of all enum types included in this API service. Enums referenced directly or indirectly by the apis are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
final
hashCode → int
The hash code for this object.
no setterinherited
http → Input<Http>?
HTTP configuration.
final
id → Input<String>?
A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.
final
logging → Input<Logging>?
Logging configuration.
final
logs → Input<List<LogDescriptor>>?
Defines the logs used by this service.
final
metrics → Input<List<MetricDescriptor>>?
Defines the metrics used by this service.
final
monitoredResources → Input<List<MonitoredResourceDescriptor>>?
Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.
final
monitoring → Input<Monitoring>?
Monitoring configuration.
final
name → Input<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.
final
producerProjectId → Input<String>?
The Google project that owns this service.
final
publishing → Input<Publishing>?
Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
final
quota → Input<Quota>?
Quota configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceName → Input<String>
final
systemParameters → Input<SystemParameters>?
System parameter configuration.
final
systemTypes → Input<List<Type>>?
A list of all proto message types included in this API service. It serves similar purpose as google.api.Service.types, except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
final
title → Input<String>?
The product title for this service, it is the name displayed in Google Cloud Console.
final
types → Input<List<Type>>?
A list of all proto message types included in this API service. Types referenced directly or indirectly by the apis are automatically included. Messages which are not referenced but shall be included, such as types used by the google.protobuf.Any type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32
final
usage → Input<Usage>?
Configuration controlling usage of this service.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited