ApiConfigState class

Input properties used for looking up and filtering ApiConfig resources.

Constructors

ApiConfigState({Input<String?>? api, Input<String?>? apiConfigId, Input<String?>? apiConfigIdPrefix, Input<String?>? deletionPolicy, Input<String?>? displayName, Input<Map<String, String>?>? effectiveLabels, Input<ApiConfigGatewayConfig?>? gatewayConfig, Input<List<ApiConfigGrpcService>?>? grpcServices, Input<Map<String, String>?>? labels, Input<List<ApiConfigManagedServiceConfig>?>? managedServiceConfigs, Input<String?>? name, Input<List<ApiConfigOpenapiDocument>?>? openapiDocuments, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<String?>? serviceConfigId})
Creates a new ApiConfigState. api The API to attach the config to. apiConfigId Identifier to assign to the API Config. Must be unique within scope of the parent resource(api). apiConfigIdPrefix Creates a unique name beginning with the deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. displayName A user-visible name for the API. effectiveLabels All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. gatewayConfig Immutable. Gateway specific configuration. grpcServices gRPC service definition files. If specified, openapiDocuments must not be included. labels Resource labels to represent user-provided metadata. 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. name The resource name of the API Config. openapiDocuments OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included. project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource serviceConfigId The ID of the associated Service Config (https://cloud.google.com/service-infrastructure/docs/glossary#config).
const
ApiConfigState.fromMap(Map<String, dynamic> map)
factory

Properties

api → Input<String?>?
The API to attach the config to.
final
apiConfigId → Input<String?>?
Identifier to assign to the API Config. Must be unique within scope of the parent resource(api).
final
apiConfigIdPrefix → Input<String?>?
Creates a unique name beginning with the specified prefix. If this and apiConfigId are unspecified, a random value is chosen for the name.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
displayName → Input<String?>?
A user-visible name for the API.
final
effectiveLabels → Input<Map<String, String>?>?
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
final
gatewayConfig → Input<ApiConfigGatewayConfig?>?
Immutable. Gateway specific configuration. If not specified, backend authentication will be set to use OIDC authentication using the default compute service account Structure is documented below.
final
grpcServices → Input<List<ApiConfigGrpcService>?>?
gRPC service definition files. If specified, openapiDocuments must not be included. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?
Resource labels to represent user-provided metadata.
final
managedServiceConfigs → Input<List<ApiConfigManagedServiceConfig>?>?
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. Structure is documented below.
final
name → Input<String?>?
The resource name of the API Config.
final
openapiDocuments → Input<List<ApiConfigOpenapiDocument>?>?
OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included. Structure is documented below.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pulumiLabels → Input<Map<String, String>?>?
The combination of labels configured directly on the resource and default labels configured on the provider.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceConfigId → Input<String?>?
The ID of the associated Service Config (https://cloud.google.com/service-infrastructure/docs/glossary#config).
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