GatewayState class - apigateway library

Constructors

GatewayState({Input<String?>? apiConfig, Input<String?>? defaultHostname, Input<String?>? deletionPolicy, Input<String?>? displayName, Input<Map<String, String>?>? effectiveLabels, Input<String?>? gatewayId, Input<Map<String, String>?>? labels, Input<String?>? name, Input<String?>? project, Input<Map<String, String>?>? pulumiLabels, Input<String?>? region}): Creates a new GatewayState. apiConfig Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}. defaultHostname The default API Gateway host name of the form {gatewayId}-{hash}.{region_code}.gateway.dev. 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. gatewayId Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project). labels Resource labels to represent user-provided metadata. name Resource name of the Gateway. Format: projects/{project}/locations/{region}/gateways/{gateway} project The ID of the project in which the resource belongs. pulumiLabels The combination of labels configured directly on the resource region The region of the gateway for the API.
const
GatewayState.fromMap(Map<String, dynamic> map): factory

Properties

apiConfig → Input<String?>?: Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}. When changing api configs please ensure the new config is a new resource and the lifecycle rule createBeforeDestroy is set.
final
defaultHostname → Input<String?>?: The default API Gateway host name of the form {gatewayId}-{hash}.{region_code}.gateway.dev.
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
gatewayId → Input<String?>?: Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project).
final
hashCode → int: The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?: Resource labels to represent user-provided metadata.
final
name → Input<String?>?: Resource name of the Gateway. Format: projects/{project}/locations/{region}/gateways/{gateway}
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
region → Input<String?>?: The region of the gateway for the API.
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