azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.machinelearning.models.ProbeSettings.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings"
fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings"
name: "ProbeSettings"
nameWithType: "ProbeSettings"
summary: "Deployment container liveness/readiness probe configuration."
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 **ProbeSettings**</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.machinelearning.models.ProbeSettings?alt=com.azure.resourcemanager.machinelearning.models.ProbeSettings&text=ProbeSettings\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.ProbeSettings()"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.ProbeSettings()"
  name: "ProbeSettings()"
  nameWithType: "ProbeSettings.ProbeSettings()"
  summary: "Creates an instance of Probe<wbr>Settings class."
  syntax: "public ProbeSettings()"
  desc: "Creates an instance of ProbeSettings class."
methods:
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.failureThreshold()"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.failureThreshold()"
  name: "failureThreshold()"
  nameWithType: "ProbeSettings.failureThreshold()"
  summary: "Get the failure<wbr>Threshold property: The number of failures to allow before returning an unhealthy status."
  syntax: "public Integer failureThreshold()"
  desc: "Get the failureThreshold property: The number of failures to allow before returning an unhealthy status."
  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.machinelearning.models.ProbeSettings.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "ProbeSettings.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Probe<wbr>Settings 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 ProbeSettings fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the ProbeSettings."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of ProbeSettings from the JsonReader."
  returns:
    description: "An instance of ProbeSettings if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.ProbeSettings?alt=com.azure.resourcemanager.machinelearning.models.ProbeSettings&text=ProbeSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.initialDelay()"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.initialDelay()"
  name: "initialDelay()"
  nameWithType: "ProbeSettings.initialDelay()"
  summary: "Get the initial<wbr>Delay property: The delay before the first probe in ISO 8601 format."
  syntax: "public Duration initialDelay()"
  desc: "Get the initialDelay property: The delay before the first probe in ISO 8601 format."
  returns:
    description: "the initialDelay value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.period()"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.period()"
  name: "period()"
  nameWithType: "ProbeSettings.period()"
  summary: "Get the period property: The length of time between probes in ISO 8601 format."
  syntax: "public Duration period()"
  desc: "Get the period property: The length of time between probes in ISO 8601 format."
  returns:
    description: "the period value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.successThreshold()"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.successThreshold()"
  name: "successThreshold()"
  nameWithType: "ProbeSettings.successThreshold()"
  summary: "Get the success<wbr>Threshold property: The number of successful probes before returning a healthy status."
  syntax: "public Integer successThreshold()"
  desc: "Get the successThreshold property: The number of successful probes before returning a healthy status."
  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.machinelearning.models.ProbeSettings.timeout()"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.timeout()"
  name: "timeout()"
  nameWithType: "ProbeSettings.timeout()"
  summary: "Get the timeout property: The probe timeout in ISO 8601 format."
  syntax: "public Duration timeout()"
  desc: "Get the timeout property: The probe timeout in ISO 8601 format."
  returns:
    description: "the timeout value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "ProbeSettings.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.machinelearning.models.ProbeSettings.validate()"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.validate()"
  name: "validate()"
  nameWithType: "ProbeSettings.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withFailureThreshold(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withFailureThreshold(Integer failureThreshold)"
  name: "withFailureThreshold(Integer failureThreshold)"
  nameWithType: "ProbeSettings.withFailureThreshold(Integer failureThreshold)"
  summary: "Set the failure<wbr>Threshold property: The number of failures to allow before returning an unhealthy status."
  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 ProbeSettings withFailureThreshold(Integer failureThreshold)"
  desc: "Set the failureThreshold property: The number of failures to allow before returning an unhealthy status."
  returns:
    description: "the ProbeSettings object itself."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.ProbeSettings?alt=com.azure.resourcemanager.machinelearning.models.ProbeSettings&text=ProbeSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withInitialDelay(java.time.Duration)"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withInitialDelay(Duration initialDelay)"
  name: "withInitialDelay(Duration initialDelay)"
  nameWithType: "ProbeSettings.withInitialDelay(Duration initialDelay)"
  summary: "Set the initial<wbr>Delay property: The delay before the first probe in ISO 8601 format."
  parameters:
  - description: "the initialDelay value to set."
    name: "initialDelay"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
  syntax: "public ProbeSettings withInitialDelay(Duration initialDelay)"
  desc: "Set the initialDelay property: The delay before the first probe in ISO 8601 format."
  returns:
    description: "the ProbeSettings object itself."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.ProbeSettings?alt=com.azure.resourcemanager.machinelearning.models.ProbeSettings&text=ProbeSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withPeriod(java.time.Duration)"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withPeriod(Duration period)"
  name: "withPeriod(Duration period)"
  nameWithType: "ProbeSettings.withPeriod(Duration period)"
  summary: "Set the period property: The length of time between probes in ISO 8601 format."
  parameters:
  - description: "the period value to set."
    name: "period"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
  syntax: "public ProbeSettings withPeriod(Duration period)"
  desc: "Set the period property: The length of time between probes in ISO 8601 format."
  returns:
    description: "the ProbeSettings object itself."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.ProbeSettings?alt=com.azure.resourcemanager.machinelearning.models.ProbeSettings&text=ProbeSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withSuccessThreshold(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withSuccessThreshold(Integer successThreshold)"
  name: "withSuccessThreshold(Integer successThreshold)"
  nameWithType: "ProbeSettings.withSuccessThreshold(Integer successThreshold)"
  summary: "Set the success<wbr>Threshold property: The number of successful probes before returning a healthy status."
  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 ProbeSettings withSuccessThreshold(Integer successThreshold)"
  desc: "Set the successThreshold property: The number of successful probes before returning a healthy status."
  returns:
    description: "the ProbeSettings object itself."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.ProbeSettings?alt=com.azure.resourcemanager.machinelearning.models.ProbeSettings&text=ProbeSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withTimeout(java.time.Duration)"
  fullName: "com.azure.resourcemanager.machinelearning.models.ProbeSettings.withTimeout(Duration timeout)"
  name: "withTimeout(Duration timeout)"
  nameWithType: "ProbeSettings.withTimeout(Duration timeout)"
  summary: "Set the timeout property: The probe timeout in ISO 8601 format."
  parameters:
  - description: "the timeout value to set."
    name: "timeout"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
  syntax: "public ProbeSettings withTimeout(Duration timeout)"
  desc: "Set the timeout property: The probe timeout in ISO 8601 format."
  returns:
    description: "the ProbeSettings object itself."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.ProbeSettings?alt=com.azure.resourcemanager.machinelearning.models.ProbeSettings&text=ProbeSettings\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Deployment container liveness/readiness probe configuration."
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.machinelearning.models.ProbeSettings?alt=com.azure.resourcemanager.machinelearning.models.ProbeSettings&text=ProbeSettings\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.machinelearning.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0