# App Engine Admin V1 API - Class Google::Cloud::AppEngine::V1::ReadinessCheck (v1.8.0)

1.8.0 (latest) 1.7.0 1.6.0 1.5.1 1.4.0 1.3.0 1.2.1 1.1.0 1.0.1 0.10.0 0.9.2 0.8.0 0.7.0 0.6.1 0.5.0 0.4.0 0.3.6 Reference documentation and code samples for the App Engine Admin V1 API class Google::Cloud::AppEngine::V1::ReadinessCheck.

Readiness checking configuration for VM instances. Unhealthy instances
are removed from traffic rotation.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #app_start_timeout

    def app_start_timeout() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

### #app_start_timeout=

    def app_start_timeout=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.

### #check_interval

    def check_interval() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- Interval between health checks.

### #check_interval=

    def check_interval=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- Interval between health checks.
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- Interval between health checks.

### #failure_threshold

    def failure_threshold() -> ::Integer

**Returns**

- (::Integer) --- Number of consecutive failed checks required before removing traffic.

### #failure_threshold=

    def failure_threshold=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Number of consecutive failed checks required before removing traffic.
**Returns**

- (::Integer) --- Number of consecutive failed checks required before removing traffic.

### #host

    def host() -> ::String

**Returns**

- (::String) --- Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"

### #host=

    def host=(value) -> ::String

**Parameter**

- **value** (::String) --- Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
**Returns**

- (::String) --- Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"

### #path

    def path() -> ::String

**Returns**

- (::String) --- The request path.

### #path=

    def path=(value) -> ::String

**Parameter**

- **value** (::String) --- The request path.
**Returns**

- (::String) --- The request path.

### #success_threshold

    def success_threshold() -> ::Integer

**Returns**

- (::Integer) --- Number of consecutive successful checks required before receiving traffic.

### #success_threshold=

    def success_threshold=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Number of consecutive successful checks required before receiving traffic.
**Returns**

- (::Integer) --- Number of consecutive successful checks required before receiving traffic.

### #timeout

    def timeout() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- Time before the check is considered failed.

### #timeout=

    def timeout=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- Time before the check is considered failed.
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-app_engine-v1/latest/Google-Protobuf-Duration)) --- Time before the check is considered failed.