HttpHealthCheckArgs class

The set of arguments for HttpHealthCheck. The set of arguments for HttpHealthCheck.

Constructors

HttpHealthCheckArgs({Input<int>? checkIntervalSec, Input<String>? description, Input<int>? healthyThreshold, Input<String>? host, Input<String>? name, Input<int>? port, Input<String>? project, Input<String>? requestId, Input<String>? requestPath, Input<int>? timeoutSec, Input<int>? unhealthyThreshold})
Creates a new HttpHealthCheckArgs. 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. healthyThreshold A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. host The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. 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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. port The TCP port number for the HTTP health check request. The default value is 80. project Optional. 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). requestPath The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986. 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. unhealthyThreshold A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
const
HttpHealthCheckArgs.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
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
host → Input<String>?
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
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. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
final
port → Input<int>?
The TCP port number for the HTTP health check request. The default value is 80.
final
project → 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
requestPath → Input<String>?
The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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
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