kubernetes_asyncio.client.models.v1_probe module

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501

The version of the OpenAPI document: v1.34.3 Generated by: https://openapi-generator.tech

class kubernetes_asyncio.client.models.v1_probe.V1Probe(_exec=None, failure_threshold=None, grpc=None, http_get=None, initial_delay_seconds=None, period_seconds=None, success_threshold=None, tcp_socket=None, termination_grace_period_seconds=None, timeout_seconds=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

attribute_map = {'_exec': 'exec', 'failure_threshold': 'failureThreshold', 'grpc': 'grpc', 'http_get': 'httpGet', 'initial_delay_seconds': 'initialDelaySeconds', 'period_seconds': 'periodSeconds', 'success_threshold': 'successThreshold', 'tcp_socket': 'tcpSocket', 'termination_grace_period_seconds': 'terminationGracePeriodSeconds', 'timeout_seconds': 'timeoutSeconds'}

property failure_threshold

Gets the failure_threshold of this V1Probe. # noqa: E501

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. # noqa: E501

Returns:: The failure_threshold of this V1Probe. # noqa: E501
Return type:: int

property grpc

Gets the grpc of this V1Probe. # noqa: E501

Returns:: The grpc of this V1Probe. # noqa: E501
Return type:: V1GRPCAction

property http_get

Gets the http_get of this V1Probe. # noqa: E501

Returns:: The http_get of this V1Probe. # noqa: E501
Return type:: V1HTTPGetAction

property initial_delay_seconds

Gets the initial_delay_seconds of this V1Probe. # noqa: E501

Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes # noqa: E501

Returns:: The initial_delay_seconds of this V1Probe. # noqa: E501
Return type:: int

openapi_types = {'_exec': 'V1ExecAction', 'failure_threshold': 'int', 'grpc': 'V1GRPCAction', 'http_get': 'V1HTTPGetAction', 'initial_delay_seconds': 'int', 'period_seconds': 'int', 'success_threshold': 'int', 'tcp_socket': 'V1TCPSocketAction', 'termination_grace_period_seconds': 'int', 'timeout_seconds': 'int'}

property period_seconds

Gets the period_seconds of this V1Probe. # noqa: E501

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. # noqa: E501

Returns:: The period_seconds of this V1Probe. # noqa: E501
Return type:: int

property success_threshold

Gets the success_threshold of this V1Probe. # noqa: E501

Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. # noqa: E501

Returns:: The success_threshold of this V1Probe. # noqa: E501
Return type:: int

property tcp_socket

Gets the tcp_socket of this V1Probe. # noqa: E501

Returns:: The tcp_socket of this V1Probe. # noqa: E501
Return type:: V1TCPSocketAction

property termination_grace_period_seconds

Gets the termination_grace_period_seconds of this V1Probe. # noqa: E501

Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. # noqa: E501

Returns:: The termination_grace_period_seconds of this V1Probe. # noqa: E501
Return type:: int

property timeout_seconds

Gets the timeout_seconds of this V1Probe. # noqa: E501

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes # noqa: E501

Returns:: The timeout_seconds of this V1Probe. # noqa: E501
Return type:: int

to_dict(serialize=False): Returns the model properties as a dict

to_str(): Returns the string representation of the model