Share via

Probe Class

  • Reference
Package:
com.azure.resourcemanager.appplatform.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-appplatform:2.44.0
  • java.lang.Object
    • com.azure.resourcemanager.appplatform.models.Probe

Implements

JsonSerializable<Probe>

public final class Probe
implements JsonSerializable<Probe>

Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.

Constructor Summary

Constructor Description
Probe()

Creates an instance of Probe class.

Method Summary

Modifier and Type Method and Description
boolean disableProbe()

Get the disableProbe property: Indicate whether the probe is disabled.
Integer failureThreshold()

Get the failureThreshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded.
static Probe fromJson(JsonReader jsonReader)

Reads an instance of Probe from the JsonReader.
Integer initialDelaySeconds()

Get the initialDelaySeconds property: Number of seconds after the App Instance has started before probes are initiated.
Integer periodSeconds()

Get the periodSeconds property: How often (in seconds) to perform the probe.
ProbeAction probeAction()

Get the probeAction property: The action of the probe.
Integer successThreshold()

Get the successThreshold property: Minimum consecutive successes for the probe to be considered successful after having failed.
Integer timeoutSeconds()

Get the timeoutSeconds property: Number of seconds after which the probe times out.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
Probe withDisableProbe(boolean disableProbe)

Set the disableProbe property: Indicate whether the probe is disabled.
Probe withFailureThreshold(Integer failureThreshold)

Set the failureThreshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded.
Probe withInitialDelaySeconds(Integer initialDelaySeconds)

Set the initialDelaySeconds property: Number of seconds after the App Instance has started before probes are initiated.
Probe withPeriodSeconds(Integer periodSeconds)

Set the periodSeconds property: How often (in seconds) to perform the probe.
Probe withProbeAction(ProbeAction probeAction)

Set the probeAction property: The action of the probe.
Probe withSuccessThreshold(Integer successThreshold)

Set the successThreshold property: Minimum consecutive successes for the probe to be considered successful after having failed.
Probe withTimeoutSeconds(Integer timeoutSeconds)

Set the timeoutSeconds property: Number of seconds after which the probe times out.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Probe

public Probe()

Creates an instance of Probe class.

Method Details

disableProbe

public boolean disableProbe()

Get the disableProbe property: Indicate whether the probe is disabled.

Returns:

the disableProbe value.

failureThreshold

public Integer failureThreshold()

Get the failureThreshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.

Returns:

the failureThreshold value.

fromJson

public static Probe fromJson(JsonReader jsonReader)

Reads an instance of Probe from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Probe if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

initialDelaySeconds

public Integer initialDelaySeconds()

Get the initialDelaySeconds property: Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes.

Returns:

the initialDelaySeconds value.

periodSeconds

public Integer periodSeconds()

Get the periodSeconds property: How often (in seconds) to perform the probe. Minimum value is 1.

Returns:

the periodSeconds value.

probeAction

public ProbeAction probeAction()

Get the probeAction property: The action of the probe.

Returns:

the probeAction value.

successThreshold

public Integer successThreshold()

Get the successThreshold property: Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1.

Returns:

the successThreshold value.

timeoutSeconds

public Integer timeoutSeconds()

Get the timeoutSeconds property: Number of seconds after which the probe times out. Minimum value is 1.

Returns:

the timeoutSeconds value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withDisableProbe

public Probe withDisableProbe(boolean disableProbe)

Set the disableProbe property: Indicate whether the probe is disabled.

Parameters:

disableProbe - the disableProbe value to set.

Returns:

the Probe object itself.

withFailureThreshold

public Probe withFailureThreshold(Integer failureThreshold)

Set the failureThreshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1.

Parameters:

failureThreshold - the failureThreshold value to set.

Returns:

the Probe object itself.

withInitialDelaySeconds

public Probe withInitialDelaySeconds(Integer initialDelaySeconds)

Set the initialDelaySeconds property: Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes.

Parameters:

initialDelaySeconds - the initialDelaySeconds value to set.

Returns:

the Probe object itself.

withPeriodSeconds

public Probe withPeriodSeconds(Integer periodSeconds)

Set the periodSeconds property: How often (in seconds) to perform the probe. Minimum value is 1.

Parameters:

periodSeconds - the periodSeconds value to set.

Returns:

the Probe object itself.

withProbeAction

public Probe withProbeAction(ProbeAction probeAction)

Set the probeAction property: The action of the probe.

Parameters:

probeAction - the probeAction value to set.

Returns:

the Probe object itself.

withSuccessThreshold

public Probe withSuccessThreshold(Integer successThreshold)

Set the successThreshold property: Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1.

Parameters:

successThreshold - the successThreshold value to set.

Returns:

the Probe object itself.

withTimeoutSeconds

public Probe withTimeoutSeconds(Integer timeoutSeconds)

Set the timeoutSeconds property: Number of seconds after which the probe times out. Minimum value is 1.

Parameters:

timeoutSeconds - the timeoutSeconds value to set.

Returns:

the Probe object itself.

Applies to