class CheckOptions extends AnyRef
Options used to register checks in Consul.
- Alphabetic
- By Inheritance
- CheckOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new CheckOptions(_asJava: ext.consul.CheckOptions)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def asJava: ext.consul.CheckOptions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDeregisterAfter: String
- def getGrpc: String
- def getHttp: String
- def getId: String
- def getInterval: String
- def getName: String
- def getNotes: String
- def getScriptArgs: Buffer[String]
- def getServiceId: String
- def getStatus: CheckStatus
- def getTcp: String
- def getTtl: String
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isGrpcTls: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isTlsSkipVerify: Boolean
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
setDeregisterAfter(value: String): CheckOptions
Set deregister timeout.
Set deregister timeout. This is optional field, which is a timeout in the same time format as Interval and TTL. If a check is associated with a service and has the critical state for more than this configured value, then its associated service (and all of its associated checks) will automatically be deregistered. The minimum timeout is 1 minute, and the process that reaps critical services runs every 30 seconds, so it may take slightly longer than the configured timeout to trigger the deregistration. This should generally be configured with a timeout that's much, much longer than any expected recoverable outage for the given service.
-
def
setGrpc(value: String): CheckOptions
Specifies a gRPC check's endpoint that supports the standard gRPC health checking protocol.
Specifies a gRPC check's endpoint that supports the standard gRPC health checking protocol. The state of the check will be updated at the given Interval by probing the configured endpoint. The endpoint must be represented as
address:port/service
-
def
setGrpcTls(value: Boolean): CheckOptions
Specifies whether to use TLS for this gRPC health check.
Specifies whether to use TLS for this gRPC health check. If TLS is enabled, then by default, a valid TLS certificate is expected. Certificate verification can be turned off by setting
TLSSkipVerify
totrue
. -
def
setHttp(value: String): CheckOptions
Set HTTP address to check.
Set HTTP address to check. Also you should set checking interval
-
def
setId(value: String): CheckOptions
Set check ID
-
def
setInterval(value: String): CheckOptions
Set checking interval
-
def
setName(value: String): CheckOptions
Set check name.
Set check name. This is mandatory field
-
def
setNotes(value: String): CheckOptions
Set check notes
-
def
setScriptArgs(value: Buffer[String]): CheckOptions
Set scriptArgs.
Set scriptArgs. Also you should set checking interval
-
def
setServiceId(value: String): CheckOptions
Set the service ID to associate the registered check with an existing service provided by the agent.
-
def
setStatus(value: CheckStatus): CheckOptions
Set the check status to specify the initial state of the health check.
-
def
setTcp(value: String): CheckOptions
Set TCP address to check.
Set TCP address to check. Also you should set checking interval
-
def
setTlsSkipVerify(value: Boolean): CheckOptions
Specifies if the certificate for an HTTPS check should not be verified.
-
def
setTtl(value: String): CheckOptions
Set Time to Live of check.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )