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

### YamlMime:JavaType
uid: "com.azure.resourcemanager.machinelearning.models.Objective"
fullName: "com.azure.resourcemanager.machinelearning.models.Objective"
name: "Objective"
nameWithType: "Objective"
summary: "Optimization objective."
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 **Objective**</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.Objective?alt=com.azure.resourcemanager.machinelearning.models.Objective&text=Objective\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.machinelearning.models.Objective.Objective()"
  fullName: "com.azure.resourcemanager.machinelearning.models.Objective.Objective()"
  name: "Objective()"
  nameWithType: "Objective.Objective()"
  summary: "Creates an instance of Objective class."
  syntax: "public Objective()"
  desc: "Creates an instance of Objective class."
methods:
- uid: "com.azure.resourcemanager.machinelearning.models.Objective.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.resourcemanager.machinelearning.models.Objective.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "Objective.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Objective 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 Objective 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 Objective from the JsonReader."
  returns:
    description: "An instance of Objective if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.Objective?alt=com.azure.resourcemanager.machinelearning.models.Objective&text=Objective\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.Objective.goal()"
  fullName: "com.azure.resourcemanager.machinelearning.models.Objective.goal()"
  name: "goal()"
  nameWithType: "Objective.goal()"
  summary: "Get the goal property: \\[Required\\] Defines supported metric goals for hyperparameter tuning."
  syntax: "public Goal goal()"
  desc: "Get the goal property: \\[Required\\] Defines supported metric goals for hyperparameter tuning."
  returns:
    description: "the goal value."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.Goal?alt=com.azure.resourcemanager.machinelearning.models.Goal&text=Goal\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.Objective.primaryMetric()"
  fullName: "com.azure.resourcemanager.machinelearning.models.Objective.primaryMetric()"
  name: "primaryMetric()"
  nameWithType: "Objective.primaryMetric()"
  summary: "Get the primary<wbr>Metric property: \\[Required\\] Name of the metric to optimize."
  syntax: "public String primaryMetric()"
  desc: "Get the primaryMetric property: \\[Required\\] Name of the metric to optimize."
  returns:
    description: "the primaryMetric value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.machinelearning.models.Objective.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.resourcemanager.machinelearning.models.Objective.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "Objective.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.Objective.validate()"
  fullName: "com.azure.resourcemanager.machinelearning.models.Objective.validate()"
  name: "validate()"
  nameWithType: "Objective.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.machinelearning.models.Objective.withGoal(com.azure.resourcemanager.machinelearning.models.Goal)"
  fullName: "com.azure.resourcemanager.machinelearning.models.Objective.withGoal(Goal goal)"
  name: "withGoal(Goal goal)"
  nameWithType: "Objective.withGoal(Goal goal)"
  summary: "Set the goal property: \\[Required\\] Defines supported metric goals for hyperparameter tuning."
  parameters:
  - description: "the goal value to set."
    name: "goal"
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.Goal?alt=com.azure.resourcemanager.machinelearning.models.Goal&text=Goal\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Objective withGoal(Goal goal)"
  desc: "Set the goal property: \\[Required\\] Defines supported metric goals for hyperparameter tuning."
  returns:
    description: "the Objective object itself."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.Objective?alt=com.azure.resourcemanager.machinelearning.models.Objective&text=Objective\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.machinelearning.models.Objective.withPrimaryMetric(java.lang.String)"
  fullName: "com.azure.resourcemanager.machinelearning.models.Objective.withPrimaryMetric(String primaryMetric)"
  name: "withPrimaryMetric(String primaryMetric)"
  nameWithType: "Objective.withPrimaryMetric(String primaryMetric)"
  summary: "Set the primary<wbr>Metric property: \\[Required\\] Name of the metric to optimize."
  parameters:
  - description: "the primaryMetric value to set."
    name: "primaryMetric"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Objective withPrimaryMetric(String primaryMetric)"
  desc: "Set the primaryMetric property: \\[Required\\] Name of the metric to optimize."
  returns:
    description: "the Objective object itself."
    type: "<xref href=\"com.azure.resourcemanager.machinelearning.models.Objective?alt=com.azure.resourcemanager.machinelearning.models.Objective&text=Objective\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Optimization objective."
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.Objective?alt=com.azure.resourcemanager.machinelearning.models.Objective&text=Objective\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.machinelearning.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-machinelearning:1.1.0