com.oracle.bmc.generativeai.model.CreateModelDetails Maven / Gradle / Ivy
Show all versions of oci-java-sdk-generativeai Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.generativeai.model;
/**
* The data to create a custom model.
* Note: Objects should always be created or deserialized using the {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #equals(Object)} methods are implemented to take the explicitly set
* fields into account. The constructor, on the other hand, does not take the explicitly set fields
* into account (since the constructor cannot distinguish explicit {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20231130")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(
builder = CreateModelDetails.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class CreateModelDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"displayName",
"compartmentId",
"vendor",
"version",
"description",
"baseModelId",
"fineTuneDetails",
"freeformTags",
"definedTags"
})
public CreateModelDetails(
String displayName,
String compartmentId,
String vendor,
String version,
String description,
String baseModelId,
FineTuneDetails fineTuneDetails,
java.util.Map freeformTags,
java.util.Map> definedTags) {
super();
this.displayName = displayName;
this.compartmentId = compartmentId;
this.vendor = vendor;
this.version = version;
this.description = description;
this.baseModelId = baseModelId;
this.fineTuneDetails = fineTuneDetails;
this.freeformTags = freeformTags;
this.definedTags = definedTags;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/** A user-friendly name. */
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private String displayName;
/**
* A user-friendly name.
*
* @param displayName the value to set
* @return this builder
*/
public Builder displayName(String displayName) {
this.displayName = displayName;
this.__explicitlySet__.add("displayName");
return this;
}
/**
* The compartment OCID for fine-tuned models. For pretrained models, this value is null.
*/
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private String compartmentId;
/**
* The compartment OCID for fine-tuned models. For pretrained models, this value is null.
*
* @param compartmentId the value to set
* @return this builder
*/
public Builder compartmentId(String compartmentId) {
this.compartmentId = compartmentId;
this.__explicitlySet__.add("compartmentId");
return this;
}
/** The provider of the model. */
@com.fasterxml.jackson.annotation.JsonProperty("vendor")
private String vendor;
/**
* The provider of the model.
*
* @param vendor the value to set
* @return this builder
*/
public Builder vendor(String vendor) {
this.vendor = vendor;
this.__explicitlySet__.add("vendor");
return this;
}
/** The version of the model. */
@com.fasterxml.jackson.annotation.JsonProperty("version")
private String version;
/**
* The version of the model.
*
* @param version the value to set
* @return this builder
*/
public Builder version(String version) {
this.version = version;
this.__explicitlySet__.add("version");
return this;
}
/** An optional description of the model. */
@com.fasterxml.jackson.annotation.JsonProperty("description")
private String description;
/**
* An optional description of the model.
*
* @param description the value to set
* @return this builder
*/
public Builder description(String description) {
this.description = description;
this.__explicitlySet__.add("description");
return this;
}
/** The OCID of the base model that's used for fine-tuning. */
@com.fasterxml.jackson.annotation.JsonProperty("baseModelId")
private String baseModelId;
/**
* The OCID of the base model that's used for fine-tuning.
*
* @param baseModelId the value to set
* @return this builder
*/
public Builder baseModelId(String baseModelId) {
this.baseModelId = baseModelId;
this.__explicitlySet__.add("baseModelId");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("fineTuneDetails")
private FineTuneDetails fineTuneDetails;
public Builder fineTuneDetails(FineTuneDetails fineTuneDetails) {
this.fineTuneDetails = fineTuneDetails;
this.__explicitlySet__.add("fineTuneDetails");
return this;
}
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. For more information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Department": "Finance"}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private java.util.Map freeformTags;
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. For more information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Department": "Finance"}}
*
* @param freeformTags the value to set
* @return this builder
*/
public Builder freeformTags(java.util.Map freeformTags) {
this.freeformTags = freeformTags;
this.__explicitlySet__.add("freeformTags");
return this;
}
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For
* more information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Operations": {"CostCenter": "42"}}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private java.util.Map> definedTags;
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For
* more information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Operations": {"CostCenter": "42"}}}
*
* @param definedTags the value to set
* @return this builder
*/
public Builder definedTags(
java.util.Map> definedTags) {
this.definedTags = definedTags;
this.__explicitlySet__.add("definedTags");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public CreateModelDetails build() {
CreateModelDetails model =
new CreateModelDetails(
this.displayName,
this.compartmentId,
this.vendor,
this.version,
this.description,
this.baseModelId,
this.fineTuneDetails,
this.freeformTags,
this.definedTags);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(CreateModelDetails model) {
if (model.wasPropertyExplicitlySet("displayName")) {
this.displayName(model.getDisplayName());
}
if (model.wasPropertyExplicitlySet("compartmentId")) {
this.compartmentId(model.getCompartmentId());
}
if (model.wasPropertyExplicitlySet("vendor")) {
this.vendor(model.getVendor());
}
if (model.wasPropertyExplicitlySet("version")) {
this.version(model.getVersion());
}
if (model.wasPropertyExplicitlySet("description")) {
this.description(model.getDescription());
}
if (model.wasPropertyExplicitlySet("baseModelId")) {
this.baseModelId(model.getBaseModelId());
}
if (model.wasPropertyExplicitlySet("fineTuneDetails")) {
this.fineTuneDetails(model.getFineTuneDetails());
}
if (model.wasPropertyExplicitlySet("freeformTags")) {
this.freeformTags(model.getFreeformTags());
}
if (model.wasPropertyExplicitlySet("definedTags")) {
this.definedTags(model.getDefinedTags());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/** A user-friendly name. */
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private final String displayName;
/**
* A user-friendly name.
*
* @return the value
*/
public String getDisplayName() {
return displayName;
}
/** The compartment OCID for fine-tuned models. For pretrained models, this value is null. */
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private final String compartmentId;
/**
* The compartment OCID for fine-tuned models. For pretrained models, this value is null.
*
* @return the value
*/
public String getCompartmentId() {
return compartmentId;
}
/** The provider of the model. */
@com.fasterxml.jackson.annotation.JsonProperty("vendor")
private final String vendor;
/**
* The provider of the model.
*
* @return the value
*/
public String getVendor() {
return vendor;
}
/** The version of the model. */
@com.fasterxml.jackson.annotation.JsonProperty("version")
private final String version;
/**
* The version of the model.
*
* @return the value
*/
public String getVersion() {
return version;
}
/** An optional description of the model. */
@com.fasterxml.jackson.annotation.JsonProperty("description")
private final String description;
/**
* An optional description of the model.
*
* @return the value
*/
public String getDescription() {
return description;
}
/** The OCID of the base model that's used for fine-tuning. */
@com.fasterxml.jackson.annotation.JsonProperty("baseModelId")
private final String baseModelId;
/**
* The OCID of the base model that's used for fine-tuning.
*
* @return the value
*/
public String getBaseModelId() {
return baseModelId;
}
@com.fasterxml.jackson.annotation.JsonProperty("fineTuneDetails")
private final FineTuneDetails fineTuneDetails;
public FineTuneDetails getFineTuneDetails() {
return fineTuneDetails;
}
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. For more information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Department": "Finance"}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private final java.util.Map freeformTags;
/**
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined
* name, type, or namespace. For more information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Department": "Finance"}}
*
* @return the value
*/
public java.util.Map getFreeformTags() {
return freeformTags;
}
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
* information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Operations": {"CostCenter": "42"}}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private final java.util.Map> definedTags;
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For more
* information, see [Resource
* Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
* Example: {@code {"Operations": {"CostCenter": "42"}}}
*
* @return the value
*/
public java.util.Map> getDefinedTags() {
return definedTags;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("CreateModelDetails(");
sb.append("super=").append(super.toString());
sb.append("displayName=").append(String.valueOf(this.displayName));
sb.append(", compartmentId=").append(String.valueOf(this.compartmentId));
sb.append(", vendor=").append(String.valueOf(this.vendor));
sb.append(", version=").append(String.valueOf(this.version));
sb.append(", description=").append(String.valueOf(this.description));
sb.append(", baseModelId=").append(String.valueOf(this.baseModelId));
sb.append(", fineTuneDetails=").append(String.valueOf(this.fineTuneDetails));
sb.append(", freeformTags=").append(String.valueOf(this.freeformTags));
sb.append(", definedTags=").append(String.valueOf(this.definedTags));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof CreateModelDetails)) {
return false;
}
CreateModelDetails other = (CreateModelDetails) o;
return java.util.Objects.equals(this.displayName, other.displayName)
&& java.util.Objects.equals(this.compartmentId, other.compartmentId)
&& java.util.Objects.equals(this.vendor, other.vendor)
&& java.util.Objects.equals(this.version, other.version)
&& java.util.Objects.equals(this.description, other.description)
&& java.util.Objects.equals(this.baseModelId, other.baseModelId)
&& java.util.Objects.equals(this.fineTuneDetails, other.fineTuneDetails)
&& java.util.Objects.equals(this.freeformTags, other.freeformTags)
&& java.util.Objects.equals(this.definedTags, other.definedTags)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.displayName == null ? 43 : this.displayName.hashCode());
result =
(result * PRIME)
+ (this.compartmentId == null ? 43 : this.compartmentId.hashCode());
result = (result * PRIME) + (this.vendor == null ? 43 : this.vendor.hashCode());
result = (result * PRIME) + (this.version == null ? 43 : this.version.hashCode());
result = (result * PRIME) + (this.description == null ? 43 : this.description.hashCode());
result = (result * PRIME) + (this.baseModelId == null ? 43 : this.baseModelId.hashCode());
result =
(result * PRIME)
+ (this.fineTuneDetails == null ? 43 : this.fineTuneDetails.hashCode());
result = (result * PRIME) + (this.freeformTags == null ? 43 : this.freeformTags.hashCode());
result = (result * PRIME) + (this.definedTags == null ? 43 : this.definedTags.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}