All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.oracle.bmc.generativeai.model.Endpoint Maven / Gradle / Ivy

There is a newer version: 3.53.1
Show newest version
/**
 * 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;

/**
 * To host a custom model for inference, create an endpoint for that model on a dedicated AI cluster
 * of type HOSTING.
 *
 * 

To use any of the API operations, you must be authorized in an IAM policy. If you're not * authorized, talk to an administrator who gives OCI resource access to users. See [Getting Started * with * Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm) * and [Getting Access to Generative AI * Resouces](https://docs.cloud.oracle.com/iaas/Content/generative-ai/iam-policies.htm).
* 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 = Endpoint.Builder.class) @com.fasterxml.jackson.annotation.JsonFilter( com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME) public final class Endpoint extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel { @Deprecated @java.beans.ConstructorProperties({ "id", "displayName", "description", "modelId", "compartmentId", "dedicatedAiClusterId", "timeCreated", "timeUpdated", "lifecycleState", "lifecycleDetails", "contentModerationConfig", "previousState", "freeformTags", "definedTags", "systemTags" }) public Endpoint( String id, String displayName, String description, String modelId, String compartmentId, String dedicatedAiClusterId, java.util.Date timeCreated, java.util.Date timeUpdated, LifecycleState lifecycleState, String lifecycleDetails, ContentModerationConfig contentModerationConfig, Endpoint previousState, java.util.Map freeformTags, java.util.Map> definedTags, java.util.Map> systemTags) { super(); this.id = id; this.displayName = displayName; this.description = description; this.modelId = modelId; this.compartmentId = compartmentId; this.dedicatedAiClusterId = dedicatedAiClusterId; this.timeCreated = timeCreated; this.timeUpdated = timeUpdated; this.lifecycleState = lifecycleState; this.lifecycleDetails = lifecycleDetails; this.contentModerationConfig = contentModerationConfig; this.previousState = previousState; this.freeformTags = freeformTags; this.definedTags = definedTags; this.systemTags = systemTags; } @com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "") public static class Builder { /** An OCID that uniquely identifies this endpoint resource. */ @com.fasterxml.jackson.annotation.JsonProperty("id") private String id; /** * An OCID that uniquely identifies this endpoint resource. * * @param id the value to set * @return this builder */ public Builder id(String id) { this.id = id; this.__explicitlySet__.add("id"); return this; } /** A user-friendly name. Does not have to be unique, and it's changeable. */ @com.fasterxml.jackson.annotation.JsonProperty("displayName") private String displayName; /** * A user-friendly name. Does not have to be unique, and it's changeable. * * @param displayName the value to set * @return this builder */ public Builder displayName(String displayName) { this.displayName = displayName; this.__explicitlySet__.add("displayName"); return this; } /** An optional description of the endpoint. */ @com.fasterxml.jackson.annotation.JsonProperty("description") private String description; /** * An optional description of the endpoint. * * @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 model that's used to create this endpoint. */ @com.fasterxml.jackson.annotation.JsonProperty("modelId") private String modelId; /** * The OCID of the model that's used to create this endpoint. * * @param modelId the value to set * @return this builder */ public Builder modelId(String modelId) { this.modelId = modelId; this.__explicitlySet__.add("modelId"); return this; } /** The compartment OCID to create the endpoint in. */ @com.fasterxml.jackson.annotation.JsonProperty("compartmentId") private String compartmentId; /** * The compartment OCID to create the endpoint in. * * @param compartmentId the value to set * @return this builder */ public Builder compartmentId(String compartmentId) { this.compartmentId = compartmentId; this.__explicitlySet__.add("compartmentId"); return this; } /** The OCID of the dedicated AI cluster on which the model will be deployed to. */ @com.fasterxml.jackson.annotation.JsonProperty("dedicatedAiClusterId") private String dedicatedAiClusterId; /** * The OCID of the dedicated AI cluster on which the model will be deployed to. * * @param dedicatedAiClusterId the value to set * @return this builder */ public Builder dedicatedAiClusterId(String dedicatedAiClusterId) { this.dedicatedAiClusterId = dedicatedAiClusterId; this.__explicitlySet__.add("dedicatedAiClusterId"); return this; } /** * The date and time that the endpoint was created in the format of an RFC3339 datetime * string. */ @com.fasterxml.jackson.annotation.JsonProperty("timeCreated") private java.util.Date timeCreated; /** * The date and time that the endpoint was created in the format of an RFC3339 datetime * string. * * @param timeCreated the value to set * @return this builder */ public Builder timeCreated(java.util.Date timeCreated) { this.timeCreated = timeCreated; this.__explicitlySet__.add("timeCreated"); return this; } /** * The date and time that the endpoint was updated in the format of an RFC3339 datetime * string. */ @com.fasterxml.jackson.annotation.JsonProperty("timeUpdated") private java.util.Date timeUpdated; /** * The date and time that the endpoint was updated in the format of an RFC3339 datetime * string. * * @param timeUpdated the value to set * @return this builder */ public Builder timeUpdated(java.util.Date timeUpdated) { this.timeUpdated = timeUpdated; this.__explicitlySet__.add("timeUpdated"); return this; } /** The current state of the endpoint. */ @com.fasterxml.jackson.annotation.JsonProperty("lifecycleState") private LifecycleState lifecycleState; /** * The current state of the endpoint. * * @param lifecycleState the value to set * @return this builder */ public Builder lifecycleState(LifecycleState lifecycleState) { this.lifecycleState = lifecycleState; this.__explicitlySet__.add("lifecycleState"); return this; } /** * A message describing the current state of the endpoint in more detail that can provide * actionable information. */ @com.fasterxml.jackson.annotation.JsonProperty("lifecycleDetails") private String lifecycleDetails; /** * A message describing the current state of the endpoint in more detail that can provide * actionable information. * * @param lifecycleDetails the value to set * @return this builder */ public Builder lifecycleDetails(String lifecycleDetails) { this.lifecycleDetails = lifecycleDetails; this.__explicitlySet__.add("lifecycleDetails"); return this; } @com.fasterxml.jackson.annotation.JsonProperty("contentModerationConfig") private ContentModerationConfig contentModerationConfig; public Builder contentModerationConfig(ContentModerationConfig contentModerationConfig) { this.contentModerationConfig = contentModerationConfig; this.__explicitlySet__.add("contentModerationConfig"); return this; } @com.fasterxml.jackson.annotation.JsonProperty("previousState") private Endpoint previousState; public Builder previousState(Endpoint previousState) { this.previousState = previousState; this.__explicitlySet__.add("previousState"); 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; } /** * System tags for this resource. Each key is predefined and scoped to a namespace. * *

Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}} */ @com.fasterxml.jackson.annotation.JsonProperty("systemTags") private java.util.Map> systemTags; /** * System tags for this resource. Each key is predefined and scoped to a namespace. * *

Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}} * * @param systemTags the value to set * @return this builder */ public Builder systemTags(java.util.Map> systemTags) { this.systemTags = systemTags; this.__explicitlySet__.add("systemTags"); return this; } @com.fasterxml.jackson.annotation.JsonIgnore private final java.util.Set __explicitlySet__ = new java.util.HashSet(); public Endpoint build() { Endpoint model = new Endpoint( this.id, this.displayName, this.description, this.modelId, this.compartmentId, this.dedicatedAiClusterId, this.timeCreated, this.timeUpdated, this.lifecycleState, this.lifecycleDetails, this.contentModerationConfig, this.previousState, this.freeformTags, this.definedTags, this.systemTags); for (String explicitlySetProperty : this.__explicitlySet__) { model.markPropertyAsExplicitlySet(explicitlySetProperty); } return model; } @com.fasterxml.jackson.annotation.JsonIgnore public Builder copy(Endpoint model) { if (model.wasPropertyExplicitlySet("id")) { this.id(model.getId()); } if (model.wasPropertyExplicitlySet("displayName")) { this.displayName(model.getDisplayName()); } if (model.wasPropertyExplicitlySet("description")) { this.description(model.getDescription()); } if (model.wasPropertyExplicitlySet("modelId")) { this.modelId(model.getModelId()); } if (model.wasPropertyExplicitlySet("compartmentId")) { this.compartmentId(model.getCompartmentId()); } if (model.wasPropertyExplicitlySet("dedicatedAiClusterId")) { this.dedicatedAiClusterId(model.getDedicatedAiClusterId()); } if (model.wasPropertyExplicitlySet("timeCreated")) { this.timeCreated(model.getTimeCreated()); } if (model.wasPropertyExplicitlySet("timeUpdated")) { this.timeUpdated(model.getTimeUpdated()); } if (model.wasPropertyExplicitlySet("lifecycleState")) { this.lifecycleState(model.getLifecycleState()); } if (model.wasPropertyExplicitlySet("lifecycleDetails")) { this.lifecycleDetails(model.getLifecycleDetails()); } if (model.wasPropertyExplicitlySet("contentModerationConfig")) { this.contentModerationConfig(model.getContentModerationConfig()); } if (model.wasPropertyExplicitlySet("previousState")) { this.previousState(model.getPreviousState()); } if (model.wasPropertyExplicitlySet("freeformTags")) { this.freeformTags(model.getFreeformTags()); } if (model.wasPropertyExplicitlySet("definedTags")) { this.definedTags(model.getDefinedTags()); } if (model.wasPropertyExplicitlySet("systemTags")) { this.systemTags(model.getSystemTags()); } return this; } } /** Create a new builder. */ public static Builder builder() { return new Builder(); } public Builder toBuilder() { return new Builder().copy(this); } /** An OCID that uniquely identifies this endpoint resource. */ @com.fasterxml.jackson.annotation.JsonProperty("id") private final String id; /** * An OCID that uniquely identifies this endpoint resource. * * @return the value */ public String getId() { return id; } /** A user-friendly name. Does not have to be unique, and it's changeable. */ @com.fasterxml.jackson.annotation.JsonProperty("displayName") private final String displayName; /** * A user-friendly name. Does not have to be unique, and it's changeable. * * @return the value */ public String getDisplayName() { return displayName; } /** An optional description of the endpoint. */ @com.fasterxml.jackson.annotation.JsonProperty("description") private final String description; /** * An optional description of the endpoint. * * @return the value */ public String getDescription() { return description; } /** The OCID of the model that's used to create this endpoint. */ @com.fasterxml.jackson.annotation.JsonProperty("modelId") private final String modelId; /** * The OCID of the model that's used to create this endpoint. * * @return the value */ public String getModelId() { return modelId; } /** The compartment OCID to create the endpoint in. */ @com.fasterxml.jackson.annotation.JsonProperty("compartmentId") private final String compartmentId; /** * The compartment OCID to create the endpoint in. * * @return the value */ public String getCompartmentId() { return compartmentId; } /** The OCID of the dedicated AI cluster on which the model will be deployed to. */ @com.fasterxml.jackson.annotation.JsonProperty("dedicatedAiClusterId") private final String dedicatedAiClusterId; /** * The OCID of the dedicated AI cluster on which the model will be deployed to. * * @return the value */ public String getDedicatedAiClusterId() { return dedicatedAiClusterId; } /** * The date and time that the endpoint was created in the format of an RFC3339 datetime string. */ @com.fasterxml.jackson.annotation.JsonProperty("timeCreated") private final java.util.Date timeCreated; /** * The date and time that the endpoint was created in the format of an RFC3339 datetime string. * * @return the value */ public java.util.Date getTimeCreated() { return timeCreated; } /** * The date and time that the endpoint was updated in the format of an RFC3339 datetime string. */ @com.fasterxml.jackson.annotation.JsonProperty("timeUpdated") private final java.util.Date timeUpdated; /** * The date and time that the endpoint was updated in the format of an RFC3339 datetime string. * * @return the value */ public java.util.Date getTimeUpdated() { return timeUpdated; } /** The current state of the endpoint. */ public enum LifecycleState implements com.oracle.bmc.http.internal.BmcEnum { Active("ACTIVE"), Creating("CREATING"), Updating("UPDATING"), Deleting("DELETING"), Deleted("DELETED"), Failed("FAILED"), /** * This value is used if a service returns a value for this enum that is not recognized by * this version of the SDK. */ UnknownEnumValue(null); private static final org.slf4j.Logger LOG = org.slf4j.LoggerFactory.getLogger(LifecycleState.class); private final String value; private static java.util.Map map; static { map = new java.util.HashMap<>(); for (LifecycleState v : LifecycleState.values()) { if (v != UnknownEnumValue) { map.put(v.getValue(), v); } } } LifecycleState(String value) { this.value = value; } @com.fasterxml.jackson.annotation.JsonValue public String getValue() { return value; } @com.fasterxml.jackson.annotation.JsonCreator public static LifecycleState create(String key) { if (map.containsKey(key)) { return map.get(key); } LOG.warn( "Received unknown value '{}' for enum 'LifecycleState', returning UnknownEnumValue", key); return UnknownEnumValue; } }; /** The current state of the endpoint. */ @com.fasterxml.jackson.annotation.JsonProperty("lifecycleState") private final LifecycleState lifecycleState; /** * The current state of the endpoint. * * @return the value */ public LifecycleState getLifecycleState() { return lifecycleState; } /** * A message describing the current state of the endpoint in more detail that can provide * actionable information. */ @com.fasterxml.jackson.annotation.JsonProperty("lifecycleDetails") private final String lifecycleDetails; /** * A message describing the current state of the endpoint in more detail that can provide * actionable information. * * @return the value */ public String getLifecycleDetails() { return lifecycleDetails; } @com.fasterxml.jackson.annotation.JsonProperty("contentModerationConfig") private final ContentModerationConfig contentModerationConfig; public ContentModerationConfig getContentModerationConfig() { return contentModerationConfig; } @com.fasterxml.jackson.annotation.JsonProperty("previousState") private final Endpoint previousState; public Endpoint getPreviousState() { return previousState; } /** * 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; } /** * System tags for this resource. Each key is predefined and scoped to a namespace. * *

Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}} */ @com.fasterxml.jackson.annotation.JsonProperty("systemTags") private final java.util.Map> systemTags; /** * System tags for this resource. Each key is predefined and scoped to a namespace. * *

Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}} * * @return the value */ public java.util.Map> getSystemTags() { return systemTags; } @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("Endpoint("); sb.append("super=").append(super.toString()); sb.append("id=").append(String.valueOf(this.id)); sb.append(", displayName=").append(String.valueOf(this.displayName)); sb.append(", description=").append(String.valueOf(this.description)); sb.append(", modelId=").append(String.valueOf(this.modelId)); sb.append(", compartmentId=").append(String.valueOf(this.compartmentId)); sb.append(", dedicatedAiClusterId=").append(String.valueOf(this.dedicatedAiClusterId)); sb.append(", timeCreated=").append(String.valueOf(this.timeCreated)); sb.append(", timeUpdated=").append(String.valueOf(this.timeUpdated)); sb.append(", lifecycleState=").append(String.valueOf(this.lifecycleState)); sb.append(", lifecycleDetails=").append(String.valueOf(this.lifecycleDetails)); sb.append(", contentModerationConfig=") .append(String.valueOf(this.contentModerationConfig)); sb.append(", previousState=").append(String.valueOf(this.previousState)); sb.append(", freeformTags=").append(String.valueOf(this.freeformTags)); sb.append(", definedTags=").append(String.valueOf(this.definedTags)); sb.append(", systemTags=").append(String.valueOf(this.systemTags)); sb.append(")"); return sb.toString(); } @Override public boolean equals(Object o) { if (this == o) { return true; } if (!(o instanceof Endpoint)) { return false; } Endpoint other = (Endpoint) o; return java.util.Objects.equals(this.id, other.id) && java.util.Objects.equals(this.displayName, other.displayName) && java.util.Objects.equals(this.description, other.description) && java.util.Objects.equals(this.modelId, other.modelId) && java.util.Objects.equals(this.compartmentId, other.compartmentId) && java.util.Objects.equals(this.dedicatedAiClusterId, other.dedicatedAiClusterId) && java.util.Objects.equals(this.timeCreated, other.timeCreated) && java.util.Objects.equals(this.timeUpdated, other.timeUpdated) && java.util.Objects.equals(this.lifecycleState, other.lifecycleState) && java.util.Objects.equals(this.lifecycleDetails, other.lifecycleDetails) && java.util.Objects.equals( this.contentModerationConfig, other.contentModerationConfig) && java.util.Objects.equals(this.previousState, other.previousState) && java.util.Objects.equals(this.freeformTags, other.freeformTags) && java.util.Objects.equals(this.definedTags, other.definedTags) && java.util.Objects.equals(this.systemTags, other.systemTags) && super.equals(other); } @Override public int hashCode() { final int PRIME = 59; int result = 1; result = (result * PRIME) + (this.id == null ? 43 : this.id.hashCode()); result = (result * PRIME) + (this.displayName == null ? 43 : this.displayName.hashCode()); result = (result * PRIME) + (this.description == null ? 43 : this.description.hashCode()); result = (result * PRIME) + (this.modelId == null ? 43 : this.modelId.hashCode()); result = (result * PRIME) + (this.compartmentId == null ? 43 : this.compartmentId.hashCode()); result = (result * PRIME) + (this.dedicatedAiClusterId == null ? 43 : this.dedicatedAiClusterId.hashCode()); result = (result * PRIME) + (this.timeCreated == null ? 43 : this.timeCreated.hashCode()); result = (result * PRIME) + (this.timeUpdated == null ? 43 : this.timeUpdated.hashCode()); result = (result * PRIME) + (this.lifecycleState == null ? 43 : this.lifecycleState.hashCode()); result = (result * PRIME) + (this.lifecycleDetails == null ? 43 : this.lifecycleDetails.hashCode()); result = (result * PRIME) + (this.contentModerationConfig == null ? 43 : this.contentModerationConfig.hashCode()); result = (result * PRIME) + (this.previousState == null ? 43 : this.previousState.hashCode()); result = (result * PRIME) + (this.freeformTags == null ? 43 : this.freeformTags.hashCode()); result = (result * PRIME) + (this.definedTags == null ? 43 : this.definedTags.hashCode()); result = (result * PRIME) + (this.systemTags == null ? 43 : this.systemTags.hashCode()); result = (result * PRIME) + super.hashCode(); return result; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy