RegionHealthCheckArgs class

The set of arguments for RegionHealthCheck. The set of arguments for RegionHealthCheck.

Constructors

RegionHealthCheckArgs({Input<int>? checkIntervalSec, Input<String>? description, Input<GRPCHealthCheck>? grpcHealthCheck, Input<int>? healthyThreshold, Input<HTTP2HealthCheck>? http2HealthCheck, Input<HTTPHealthCheck>? httpHealthCheck, Input<HTTPSHealthCheck>? httpsHealthCheck, Input<String>? kind, Input<HealthCheckLogConfig>? logConfig, Input<String>? name, Input<String>? project, required Input<String> region, Input<String>? requestId, Input<List<String>>? sourceRegions, Input<SSLHealthCheck>? sslHealthCheck, Input<TCPHealthCheck>? tcpHealthCheck, Input<int>? timeoutSec, Input<RegionHealthCheckType>? type, Input<UDPHealthCheck>? udpHealthCheck, Input<int>? unhealthyThreshold})
Creates a new RegionHealthCheckArgs. checkIntervalSec How often (in seconds) to send a health check. The default value is 5 seconds. description An optional description of this resource. Provide this property when you create the resource. grpcHealthCheck Optional. healthyThreshold A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. http2HealthCheck Optional. httpHealthCheck Optional. httpsHealthCheck Optional. kind Type of the resource. logConfig Configure logging on this health check. name Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. project Optional. region Required. requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). sourceRegions The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of GCP regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. sslHealthCheck Optional. tcpHealthCheck Optional. timeoutSec How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. type Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. udpHealthCheck Optional. unhealthyThreshold A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
const
RegionHealthCheckArgs.fromMap(Map<String, dynamic> map)
factory

Properties

checkIntervalSec → Input<int>?
How often (in seconds) to send a health check. The default value is 5 seconds.
final
description → Input<String>?
An optional description of this resource. Provide this property when you create the resource.
final
grpcHealthCheck → Input<GRPCHealthCheck>?
final
hashCode → int
The hash code for this object.
no setterinherited
healthyThreshold → Input<int>?
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
final
http2HealthCheck → Input<HTTP2HealthCheck>?
final
httpHealthCheck → Input<HTTPHealthCheck>?
final
httpsHealthCheck → Input<HTTPSHealthCheck>?
final
kind → Input<String>?
Type of the resource.
final
logConfig → Input<HealthCheckLogConfig>?
Configure logging on this health check.
final
name → Input<String>?
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression [a-z]([-a-z0-9]*[a-z0-9])?, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash.
final
project → Input<String>?
final
region → Input<String>
final
requestId → Input<String>?
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceRegions → Input<List<String>>?
The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of GCP regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing.
final
sslHealthCheck → Input<SSLHealthCheck>?
final
tcpHealthCheck → Input<TCPHealthCheck>?
final
timeoutSec → Input<int>?
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
final
type → Input<RegionHealthCheckType>?
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
final
udpHealthCheck → Input<UDPHealthCheck>?
final
unhealthyThreshold → Input<int>?
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
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