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

com.oracle.bmc.datalabelingservicedataplane.model.Annotation Maven / Gradle / Ivy

/**
 * 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.datalabelingservicedataplane.model;

/**
 * An annotation represents a user- or machine-generated annotation for a given record. The details
 * of the annotation are captured in the RecordAnnotationDetails. 
* 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: 20211001") @com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = Annotation.Builder.class) @com.fasterxml.jackson.annotation.JsonFilter( com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME) public final class Annotation extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel { @Deprecated @java.beans.ConstructorProperties({ "id", "timeCreated", "timeUpdated", "createdBy", "updatedBy", "recordId", "entities", "compartmentId", "lifecycleState", "freeformTags", "definedTags" }) public Annotation( String id, java.util.Date timeCreated, java.util.Date timeUpdated, String createdBy, String updatedBy, String recordId, java.util.List entities, String compartmentId, LifecycleState lifecycleState, java.util.Map freeformTags, java.util.Map> definedTags) { super(); this.id = id; this.timeCreated = timeCreated; this.timeUpdated = timeUpdated; this.createdBy = createdBy; this.updatedBy = updatedBy; this.recordId = recordId; this.entities = entities; this.compartmentId = compartmentId; this.lifecycleState = lifecycleState; this.freeformTags = freeformTags; this.definedTags = definedTags; } @com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "") public static class Builder { /** The OCID of the annotation. */ @com.fasterxml.jackson.annotation.JsonProperty("id") private String id; /** * The OCID of the annotation. * * @param id the value to set * @return this builder */ public Builder id(String id) { this.id = id; this.__explicitlySet__.add("id"); return this; } /** * The date and time the annotation was created, in the timestamp format defined by RFC3339. */ @com.fasterxml.jackson.annotation.JsonProperty("timeCreated") private java.util.Date timeCreated; /** * The date and time the annotation was created, in the timestamp format defined by RFC3339. * * @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 the resource was updated, in the timestamp format defined by RFC3339. */ @com.fasterxml.jackson.annotation.JsonProperty("timeUpdated") private java.util.Date timeUpdated; /** * The date and time the resource was updated, in the timestamp format defined by RFC3339. * * @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 OCID of the principal which created the annotation. */ @com.fasterxml.jackson.annotation.JsonProperty("createdBy") private String createdBy; /** * The OCID of the principal which created the annotation. * * @param createdBy the value to set * @return this builder */ public Builder createdBy(String createdBy) { this.createdBy = createdBy; this.__explicitlySet__.add("createdBy"); return this; } /** The OCID of the principal which updated the annotation. */ @com.fasterxml.jackson.annotation.JsonProperty("updatedBy") private String updatedBy; /** * The OCID of the principal which updated the annotation. * * @param updatedBy the value to set * @return this builder */ public Builder updatedBy(String updatedBy) { this.updatedBy = updatedBy; this.__explicitlySet__.add("updatedBy"); return this; } /** The OCID of the record annotated. */ @com.fasterxml.jackson.annotation.JsonProperty("recordId") private String recordId; /** * The OCID of the record annotated. * * @param recordId the value to set * @return this builder */ public Builder recordId(String recordId) { this.recordId = recordId; this.__explicitlySet__.add("recordId"); return this; } /** The entity types are validated against the dataset to ensure consistency. */ @com.fasterxml.jackson.annotation.JsonProperty("entities") private java.util.List entities; /** * The entity types are validated against the dataset to ensure consistency. * * @param entities the value to set * @return this builder */ public Builder entities(java.util.List entities) { this.entities = entities; this.__explicitlySet__.add("entities"); return this; } /** * The OCID of the compartment for the annotation. This is tied to the dataset. It is not * changeable on the record itself. */ @com.fasterxml.jackson.annotation.JsonProperty("compartmentId") private String compartmentId; /** * The OCID of the compartment for the annotation. This is tied to the dataset. It is not * changeable on the record itself. * * @param compartmentId the value to set * @return this builder */ public Builder compartmentId(String compartmentId) { this.compartmentId = compartmentId; this.__explicitlySet__.add("compartmentId"); return this; } /** * The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for * labeling. INACTIVE - The annotation has been marked as inactive and should not be used * for labeling. DELETED - Tha annotation been deleted and no longer available for labeling. */ @com.fasterxml.jackson.annotation.JsonProperty("lifecycleState") private LifecycleState lifecycleState; /** * The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for * labeling. INACTIVE - The annotation has been marked as inactive and should not be used * for labeling. DELETED - Tha annotation been deleted and no longer available for labeling. * * @param lifecycleState the value to set * @return this builder */ public Builder lifecycleState(LifecycleState lifecycleState) { this.lifecycleState = lifecycleState; this.__explicitlySet__.add("lifecycleState"); return this; } /** * A simple key-value pair that is applied without any predefined name, type, or scope. It * exists for cross-compatibility only. For example: {@code {"bar-key": "value"}} */ @com.fasterxml.jackson.annotation.JsonProperty("freeformTags") private java.util.Map freeformTags; /** * A simple key-value pair that is applied without any predefined name, type, or scope. It * exists for cross-compatibility only. For example: {@code {"bar-key": "value"}} * * @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; } /** * The defined tags for this resource. Each key is predefined and scoped to a namespace. For * example: {@code {"foo-namespace": {"bar-key": "value"}}} */ @com.fasterxml.jackson.annotation.JsonProperty("definedTags") private java.util.Map> definedTags; /** * The defined tags for this resource. Each key is predefined and scoped to a namespace. For * example: {@code {"foo-namespace": {"bar-key": "value"}}} * * @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 Annotation build() { Annotation model = new Annotation( this.id, this.timeCreated, this.timeUpdated, this.createdBy, this.updatedBy, this.recordId, this.entities, this.compartmentId, this.lifecycleState, this.freeformTags, this.definedTags); for (String explicitlySetProperty : this.__explicitlySet__) { model.markPropertyAsExplicitlySet(explicitlySetProperty); } return model; } @com.fasterxml.jackson.annotation.JsonIgnore public Builder copy(Annotation model) { if (model.wasPropertyExplicitlySet("id")) { this.id(model.getId()); } if (model.wasPropertyExplicitlySet("timeCreated")) { this.timeCreated(model.getTimeCreated()); } if (model.wasPropertyExplicitlySet("timeUpdated")) { this.timeUpdated(model.getTimeUpdated()); } if (model.wasPropertyExplicitlySet("createdBy")) { this.createdBy(model.getCreatedBy()); } if (model.wasPropertyExplicitlySet("updatedBy")) { this.updatedBy(model.getUpdatedBy()); } if (model.wasPropertyExplicitlySet("recordId")) { this.recordId(model.getRecordId()); } if (model.wasPropertyExplicitlySet("entities")) { this.entities(model.getEntities()); } if (model.wasPropertyExplicitlySet("compartmentId")) { this.compartmentId(model.getCompartmentId()); } if (model.wasPropertyExplicitlySet("lifecycleState")) { this.lifecycleState(model.getLifecycleState()); } 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); } /** The OCID of the annotation. */ @com.fasterxml.jackson.annotation.JsonProperty("id") private final String id; /** * The OCID of the annotation. * * @return the value */ public String getId() { return id; } /** The date and time the annotation was created, in the timestamp format defined by RFC3339. */ @com.fasterxml.jackson.annotation.JsonProperty("timeCreated") private final java.util.Date timeCreated; /** * The date and time the annotation was created, in the timestamp format defined by RFC3339. * * @return the value */ public java.util.Date getTimeCreated() { return timeCreated; } /** The date and time the resource was updated, in the timestamp format defined by RFC3339. */ @com.fasterxml.jackson.annotation.JsonProperty("timeUpdated") private final java.util.Date timeUpdated; /** * The date and time the resource was updated, in the timestamp format defined by RFC3339. * * @return the value */ public java.util.Date getTimeUpdated() { return timeUpdated; } /** The OCID of the principal which created the annotation. */ @com.fasterxml.jackson.annotation.JsonProperty("createdBy") private final String createdBy; /** * The OCID of the principal which created the annotation. * * @return the value */ public String getCreatedBy() { return createdBy; } /** The OCID of the principal which updated the annotation. */ @com.fasterxml.jackson.annotation.JsonProperty("updatedBy") private final String updatedBy; /** * The OCID of the principal which updated the annotation. * * @return the value */ public String getUpdatedBy() { return updatedBy; } /** The OCID of the record annotated. */ @com.fasterxml.jackson.annotation.JsonProperty("recordId") private final String recordId; /** * The OCID of the record annotated. * * @return the value */ public String getRecordId() { return recordId; } /** The entity types are validated against the dataset to ensure consistency. */ @com.fasterxml.jackson.annotation.JsonProperty("entities") private final java.util.List entities; /** * The entity types are validated against the dataset to ensure consistency. * * @return the value */ public java.util.List getEntities() { return entities; } /** * The OCID of the compartment for the annotation. This is tied to the dataset. It is not * changeable on the record itself. */ @com.fasterxml.jackson.annotation.JsonProperty("compartmentId") private final String compartmentId; /** * The OCID of the compartment for the annotation. This is tied to the dataset. It is not * changeable on the record itself. * * @return the value */ public String getCompartmentId() { return compartmentId; } /** * The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for * labeling. INACTIVE - The annotation has been marked as inactive and should not be used for * labeling. DELETED - Tha annotation been deleted and no longer available for labeling. */ public enum LifecycleState implements com.oracle.bmc.http.internal.BmcEnum { Active("ACTIVE"), Inactive("INACTIVE"), Deleted("DELETED"), /** * 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 lifecycle state of an annotation. ACTIVE - The annotation is active to be used for * labeling. INACTIVE - The annotation has been marked as inactive and should not be used for * labeling. DELETED - Tha annotation been deleted and no longer available for labeling. */ @com.fasterxml.jackson.annotation.JsonProperty("lifecycleState") private final LifecycleState lifecycleState; /** * The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for * labeling. INACTIVE - The annotation has been marked as inactive and should not be used for * labeling. DELETED - Tha annotation been deleted and no longer available for labeling. * * @return the value */ public LifecycleState getLifecycleState() { return lifecycleState; } /** * A simple key-value pair that is applied without any predefined name, type, or scope. It * exists for cross-compatibility only. For example: {@code {"bar-key": "value"}} */ @com.fasterxml.jackson.annotation.JsonProperty("freeformTags") private final java.util.Map freeformTags; /** * A simple key-value pair that is applied without any predefined name, type, or scope. It * exists for cross-compatibility only. For example: {@code {"bar-key": "value"}} * * @return the value */ public java.util.Map getFreeformTags() { return freeformTags; } /** * The defined tags for this resource. Each key is predefined and scoped to a namespace. For * example: {@code {"foo-namespace": {"bar-key": "value"}}} */ @com.fasterxml.jackson.annotation.JsonProperty("definedTags") private final java.util.Map> definedTags; /** * The defined tags for this resource. Each key is predefined and scoped to a namespace. For * example: {@code {"foo-namespace": {"bar-key": "value"}}} * * @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("Annotation("); sb.append("super=").append(super.toString()); sb.append("id=").append(String.valueOf(this.id)); sb.append(", timeCreated=").append(String.valueOf(this.timeCreated)); sb.append(", timeUpdated=").append(String.valueOf(this.timeUpdated)); sb.append(", createdBy=").append(String.valueOf(this.createdBy)); sb.append(", updatedBy=").append(String.valueOf(this.updatedBy)); sb.append(", recordId=").append(String.valueOf(this.recordId)); sb.append(", entities=").append(String.valueOf(this.entities)); sb.append(", compartmentId=").append(String.valueOf(this.compartmentId)); sb.append(", lifecycleState=").append(String.valueOf(this.lifecycleState)); 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 Annotation)) { return false; } Annotation other = (Annotation) o; return java.util.Objects.equals(this.id, other.id) && java.util.Objects.equals(this.timeCreated, other.timeCreated) && java.util.Objects.equals(this.timeUpdated, other.timeUpdated) && java.util.Objects.equals(this.createdBy, other.createdBy) && java.util.Objects.equals(this.updatedBy, other.updatedBy) && java.util.Objects.equals(this.recordId, other.recordId) && java.util.Objects.equals(this.entities, other.entities) && java.util.Objects.equals(this.compartmentId, other.compartmentId) && java.util.Objects.equals(this.lifecycleState, other.lifecycleState) && 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.id == null ? 43 : this.id.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.createdBy == null ? 43 : this.createdBy.hashCode()); result = (result * PRIME) + (this.updatedBy == null ? 43 : this.updatedBy.hashCode()); result = (result * PRIME) + (this.recordId == null ? 43 : this.recordId.hashCode()); result = (result * PRIME) + (this.entities == null ? 43 : this.entities.hashCode()); result = (result * PRIME) + (this.compartmentId == null ? 43 : this.compartmentId.hashCode()); result = (result * PRIME) + (this.lifecycleState == null ? 43 : this.lifecycleState.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; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy