### YamlMime:JavaType
uid: "com.azure.resourcemanager.appplatform.models.Probe"
fullName: "com.azure.resourcemanager.appplatform.models.Probe"
name: "Probe"
nameWithType: "Probe"
summary: "Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **Probe**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.appplatform.models.Probe.Probe()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.Probe()"
  name: "Probe()"
  nameWithType: "Probe.Probe()"
  summary: "Creates an instance of Probe class."
  syntax: "public Probe()"
  desc: "Creates an instance of Probe class."
methods:
- uid: "com.azure.resourcemanager.appplatform.models.Probe.disableProbe()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.disableProbe()"
  name: "disableProbe()"
  nameWithType: "Probe.disableProbe()"
  summary: "Get the disable<wbr>Probe property: Indicate whether the probe is disabled."
  syntax: "public boolean disableProbe()"
  desc: "Get the disableProbe property: Indicate whether the probe is disabled."
  returns:
    description: "the disableProbe value."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.failureThreshold()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.failureThreshold()"
  name: "failureThreshold()"
  nameWithType: "Probe.failureThreshold()"
  summary: "Get the failure<wbr>Threshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded."
  syntax: "public Integer failureThreshold()"
  desc: "Get the failureThreshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1."
  returns:
    description: "the failureThreshold value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "Probe.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Probe from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static Probe fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of Probe from the JsonReader."
  returns:
    description: "An instance of Probe if the JsonReader was pointing to an instance of it, or null if it was pointing to\n JSON null."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.initialDelaySeconds()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.initialDelaySeconds()"
  name: "initialDelaySeconds()"
  nameWithType: "Probe.initialDelaySeconds()"
  summary: "Get the initial<wbr>Delay<wbr>Seconds property: Number of seconds after the App Instance has started before probes are initiated."
  syntax: "public Integer initialDelaySeconds()"
  desc: "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:
    description: "the initialDelaySeconds value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.periodSeconds()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.periodSeconds()"
  name: "periodSeconds()"
  nameWithType: "Probe.periodSeconds()"
  summary: "Get the period<wbr>Seconds property: How often (in seconds) to perform the probe."
  syntax: "public Integer periodSeconds()"
  desc: "Get the periodSeconds property: How often (in seconds) to perform the probe. Minimum value is 1."
  returns:
    description: "the periodSeconds value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.probeAction()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.probeAction()"
  name: "probeAction()"
  nameWithType: "Probe.probeAction()"
  summary: "Get the probe<wbr>Action property: The action of the probe."
  syntax: "public ProbeAction probeAction()"
  desc: "Get the probeAction property: The action of the probe."
  returns:
    description: "the probeAction value."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.ProbeAction?alt=com.azure.resourcemanager.appplatform.models.ProbeAction&text=ProbeAction\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.successThreshold()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.successThreshold()"
  name: "successThreshold()"
  nameWithType: "Probe.successThreshold()"
  summary: "Get the success<wbr>Threshold property: Minimum consecutive successes for the probe to be considered successful after having failed."
  syntax: "public Integer successThreshold()"
  desc: "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:
    description: "the successThreshold value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.timeoutSeconds()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.timeoutSeconds()"
  name: "timeoutSeconds()"
  nameWithType: "Probe.timeoutSeconds()"
  summary: "Get the timeout<wbr>Seconds property: Number of seconds after which the probe times out."
  syntax: "public Integer timeoutSeconds()"
  desc: "Get the timeoutSeconds property: Number of seconds after which the probe times out. Minimum value is 1."
  returns:
    description: "the timeoutSeconds value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "Probe.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.validate()"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.validate()"
  name: "validate()"
  nameWithType: "Probe.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.appplatform.models.Probe.withDisableProbe(boolean)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.withDisableProbe(boolean disableProbe)"
  name: "withDisableProbe(boolean disableProbe)"
  nameWithType: "Probe.withDisableProbe(boolean disableProbe)"
  summary: "Set the disable<wbr>Probe property: Indicate whether the probe is disabled."
  parameters:
  - description: "the disableProbe value to set."
    name: "disableProbe"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Probe withDisableProbe(boolean disableProbe)"
  desc: "Set the disableProbe property: Indicate whether the probe is disabled."
  returns:
    description: "the Probe object itself."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.withFailureThreshold(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.withFailureThreshold(Integer failureThreshold)"
  name: "withFailureThreshold(Integer failureThreshold)"
  nameWithType: "Probe.withFailureThreshold(Integer failureThreshold)"
  summary: "Set the failure<wbr>Threshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded."
  parameters:
  - description: "the failureThreshold value to set."
    name: "failureThreshold"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Probe withFailureThreshold(Integer failureThreshold)"
  desc: "Set the failureThreshold property: Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1."
  returns:
    description: "the Probe object itself."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.withInitialDelaySeconds(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.withInitialDelaySeconds(Integer initialDelaySeconds)"
  name: "withInitialDelaySeconds(Integer initialDelaySeconds)"
  nameWithType: "Probe.withInitialDelaySeconds(Integer initialDelaySeconds)"
  summary: "Set the initial<wbr>Delay<wbr>Seconds property: Number of seconds after the App Instance has started before probes are initiated."
  parameters:
  - description: "the initialDelaySeconds value to set."
    name: "initialDelaySeconds"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Probe withInitialDelaySeconds(Integer initialDelaySeconds)"
  desc: "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."
  returns:
    description: "the Probe object itself."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.withPeriodSeconds(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.withPeriodSeconds(Integer periodSeconds)"
  name: "withPeriodSeconds(Integer periodSeconds)"
  nameWithType: "Probe.withPeriodSeconds(Integer periodSeconds)"
  summary: "Set the period<wbr>Seconds property: How often (in seconds) to perform the probe."
  parameters:
  - description: "the periodSeconds value to set."
    name: "periodSeconds"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Probe withPeriodSeconds(Integer periodSeconds)"
  desc: "Set the periodSeconds property: How often (in seconds) to perform the probe. Minimum value is 1."
  returns:
    description: "the Probe object itself."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.withProbeAction(com.azure.resourcemanager.appplatform.models.ProbeAction)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.withProbeAction(ProbeAction probeAction)"
  name: "withProbeAction(ProbeAction probeAction)"
  nameWithType: "Probe.withProbeAction(ProbeAction probeAction)"
  summary: "Set the probe<wbr>Action property: The action of the probe."
  parameters:
  - description: "the probeAction value to set."
    name: "probeAction"
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.ProbeAction?alt=com.azure.resourcemanager.appplatform.models.ProbeAction&text=ProbeAction\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Probe withProbeAction(ProbeAction probeAction)"
  desc: "Set the probeAction property: The action of the probe."
  returns:
    description: "the Probe object itself."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.withSuccessThreshold(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.withSuccessThreshold(Integer successThreshold)"
  name: "withSuccessThreshold(Integer successThreshold)"
  nameWithType: "Probe.withSuccessThreshold(Integer successThreshold)"
  summary: "Set the success<wbr>Threshold property: Minimum consecutive successes for the probe to be considered successful after having failed."
  parameters:
  - description: "the successThreshold value to set."
    name: "successThreshold"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Probe withSuccessThreshold(Integer successThreshold)"
  desc: "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."
  returns:
    description: "the Probe object itself."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appplatform.models.Probe.withTimeoutSeconds(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.appplatform.models.Probe.withTimeoutSeconds(Integer timeoutSeconds)"
  name: "withTimeoutSeconds(Integer timeoutSeconds)"
  nameWithType: "Probe.withTimeoutSeconds(Integer timeoutSeconds)"
  summary: "Set the timeout<wbr>Seconds property: Number of seconds after which the probe times out."
  parameters:
  - description: "the timeoutSeconds value to set."
    name: "timeoutSeconds"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public Probe withTimeoutSeconds(Integer timeoutSeconds)"
  desc: "Set the timeoutSeconds property: Number of seconds after which the probe times out. Minimum value is 1."
  returns:
    description: "the Probe object itself."
    type: "<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.appplatform.models.Probe?alt=com.azure.resourcemanager.appplatform.models.Probe&text=Probe\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.appplatform.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-appplatform:2.44.0