ConfigArgs class

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

Constructors

ConfigArgs({required Input<String> apiConfigId, required Input<String> apiId, Input<String>? displayName, Input<String>? gatewayServiceAccount, Input<List<ApigatewayApiConfigGrpcServiceDefinition>>? grpcServices, Input<Map<String, String>>? labels, Input<String>? location, Input<List<ApigatewayApiConfigFile>>? managedServiceConfigs, Input<List<ApigatewayApiConfigOpenApiDocument>>? openapiDocuments, Input<String>? project})
Creates a new ConfigArgs. apiConfigId Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource. apiId Required. displayName Optional. Display name. gatewayServiceAccount Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service. grpcServices Optional. gRPC service definition files. If specified, openapi_documents must not be included. labels Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources location Optional. managedServiceConfigs Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields. openapiDocuments Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included. project Optional.
const
ConfigArgs.fromMap(Map<String, dynamic> map)
factory

Properties

apiConfigId → Input<String>
Required. Identifier to assign to the API Config. Must be unique within scope of the parent resource.
final
apiId → Input<String>
final
displayName → Input<String>?
Optional. Display name.
final
gatewayServiceAccount → Input<String>?
Immutable. The Google Cloud IAM Service Account that Gateways serving this config should use to authenticate to other services. This may either be the Service Account's email ({ACCOUNT_ID}@{PROJECT}.iam.gserviceaccount.com) or its full resource name (projects/{PROJECT}/accounts/{UNIQUE_ID}). This is most often used when the service is a GCP resource such as a Cloud Run Service or an IAP-secured service.
final
grpcServices → Input<List<ApigatewayApiConfigGrpcServiceDefinition>>?
Optional. gRPC service definition files. If specified, openapi_documents must not be included.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>>?
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
final
location → Input<String>?
final
managedServiceConfigs → Input<List<ApigatewayApiConfigFile>>?
Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields.
final
openapiDocuments → Input<List<ApigatewayApiConfigOpenApiDocument>>?
Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included.
final
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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