
software.amazon.awssdk.services.cleanroomsml.model.TrainedModelInferenceJobSummary Maven / Gradle / Ivy
Show all versions of cleanroomsml Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.cleanroomsml.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.TimestampFormatTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides information about the trained model inference job.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TrainedModelInferenceJobSummary implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TRAINED_MODEL_INFERENCE_JOB_ARN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("trainedModelInferenceJobArn")
.getter(getter(TrainedModelInferenceJobSummary::trainedModelInferenceJobArn))
.setter(setter(Builder::trainedModelInferenceJobArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("trainedModelInferenceJobArn")
.build()).build();
private static final SdkField CONFIGURED_MODEL_ALGORITHM_ASSOCIATION_ARN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("configuredModelAlgorithmAssociationArn")
.getter(getter(TrainedModelInferenceJobSummary::configuredModelAlgorithmAssociationArn))
.setter(setter(Builder::configuredModelAlgorithmAssociationArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("configuredModelAlgorithmAssociationArn").build()).build();
private static final SdkField MEMBERSHIP_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("membershipIdentifier").getter(getter(TrainedModelInferenceJobSummary::membershipIdentifier))
.setter(setter(Builder::membershipIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("membershipIdentifier").build())
.build();
private static final SdkField TRAINED_MODEL_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("trainedModelArn").getter(getter(TrainedModelInferenceJobSummary::trainedModelArn))
.setter(setter(Builder::trainedModelArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("trainedModelArn").build()).build();
private static final SdkField COLLABORATION_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("collaborationIdentifier").getter(getter(TrainedModelInferenceJobSummary::collaborationIdentifier))
.setter(setter(Builder::collaborationIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("collaborationIdentifier").build())
.build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(TrainedModelInferenceJobSummary::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final SdkField OUTPUT_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("outputConfiguration")
.getter(getter(TrainedModelInferenceJobSummary::outputConfiguration)).setter(setter(Builder::outputConfiguration))
.constructor(InferenceOutputConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("outputConfiguration").build())
.build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(TrainedModelInferenceJobSummary::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("description").getter(getter(TrainedModelInferenceJobSummary::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField METRICS_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("metricsStatus").getter(getter(TrainedModelInferenceJobSummary::metricsStatusAsString))
.setter(setter(Builder::metricsStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metricsStatus").build()).build();
private static final SdkField METRICS_STATUS_DETAILS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("metricsStatusDetails").getter(getter(TrainedModelInferenceJobSummary::metricsStatusDetails))
.setter(setter(Builder::metricsStatusDetails))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metricsStatusDetails").build())
.build();
private static final SdkField LOGS_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("logsStatus").getter(getter(TrainedModelInferenceJobSummary::logsStatusAsString))
.setter(setter(Builder::logsStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("logsStatus").build()).build();
private static final SdkField LOGS_STATUS_DETAILS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("logsStatusDetails").getter(getter(TrainedModelInferenceJobSummary::logsStatusDetails))
.setter(setter(Builder::logsStatusDetails))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("logsStatusDetails").build()).build();
private static final SdkField CREATE_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("createTime")
.getter(getter(TrainedModelInferenceJobSummary::createTime))
.setter(setter(Builder::createTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("createTime").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField UPDATE_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("updateTime")
.getter(getter(TrainedModelInferenceJobSummary::updateTime))
.setter(setter(Builder::updateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("updateTime").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
TRAINED_MODEL_INFERENCE_JOB_ARN_FIELD, CONFIGURED_MODEL_ALGORITHM_ASSOCIATION_ARN_FIELD, MEMBERSHIP_IDENTIFIER_FIELD,
TRAINED_MODEL_ARN_FIELD, COLLABORATION_IDENTIFIER_FIELD, STATUS_FIELD, OUTPUT_CONFIGURATION_FIELD, NAME_FIELD,
DESCRIPTION_FIELD, METRICS_STATUS_FIELD, METRICS_STATUS_DETAILS_FIELD, LOGS_STATUS_FIELD, LOGS_STATUS_DETAILS_FIELD,
CREATE_TIME_FIELD, UPDATE_TIME_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("trainedModelInferenceJobArn", TRAINED_MODEL_INFERENCE_JOB_ARN_FIELD);
put("configuredModelAlgorithmAssociationArn", CONFIGURED_MODEL_ALGORITHM_ASSOCIATION_ARN_FIELD);
put("membershipIdentifier", MEMBERSHIP_IDENTIFIER_FIELD);
put("trainedModelArn", TRAINED_MODEL_ARN_FIELD);
put("collaborationIdentifier", COLLABORATION_IDENTIFIER_FIELD);
put("status", STATUS_FIELD);
put("outputConfiguration", OUTPUT_CONFIGURATION_FIELD);
put("name", NAME_FIELD);
put("description", DESCRIPTION_FIELD);
put("metricsStatus", METRICS_STATUS_FIELD);
put("metricsStatusDetails", METRICS_STATUS_DETAILS_FIELD);
put("logsStatus", LOGS_STATUS_FIELD);
put("logsStatusDetails", LOGS_STATUS_DETAILS_FIELD);
put("createTime", CREATE_TIME_FIELD);
put("updateTime", UPDATE_TIME_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String trainedModelInferenceJobArn;
private final String configuredModelAlgorithmAssociationArn;
private final String membershipIdentifier;
private final String trainedModelArn;
private final String collaborationIdentifier;
private final String status;
private final InferenceOutputConfiguration outputConfiguration;
private final String name;
private final String description;
private final String metricsStatus;
private final String metricsStatusDetails;
private final String logsStatus;
private final String logsStatusDetails;
private final Instant createTime;
private final Instant updateTime;
private TrainedModelInferenceJobSummary(BuilderImpl builder) {
this.trainedModelInferenceJobArn = builder.trainedModelInferenceJobArn;
this.configuredModelAlgorithmAssociationArn = builder.configuredModelAlgorithmAssociationArn;
this.membershipIdentifier = builder.membershipIdentifier;
this.trainedModelArn = builder.trainedModelArn;
this.collaborationIdentifier = builder.collaborationIdentifier;
this.status = builder.status;
this.outputConfiguration = builder.outputConfiguration;
this.name = builder.name;
this.description = builder.description;
this.metricsStatus = builder.metricsStatus;
this.metricsStatusDetails = builder.metricsStatusDetails;
this.logsStatus = builder.logsStatus;
this.logsStatusDetails = builder.logsStatusDetails;
this.createTime = builder.createTime;
this.updateTime = builder.updateTime;
}
/**
*
* The Amazon Resource Name (ARN) of the trained model inference job.
*
*
* @return The Amazon Resource Name (ARN) of the trained model inference job.
*/
public final String trainedModelInferenceJobArn() {
return trainedModelInferenceJobArn;
}
/**
*
* The Amazon Resource Name (ARN) of the configured model algorithm association that is used for the trained model
* inference job.
*
*
* @return The Amazon Resource Name (ARN) of the configured model algorithm association that is used for the trained
* model inference job.
*/
public final String configuredModelAlgorithmAssociationArn() {
return configuredModelAlgorithmAssociationArn;
}
/**
*
* The membership ID of the membership that contains the trained model inference job.
*
*
* @return The membership ID of the membership that contains the trained model inference job.
*/
public final String membershipIdentifier() {
return membershipIdentifier;
}
/**
*
* The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job.
*
*
* @return The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job.
*/
public final String trainedModelArn() {
return trainedModelArn;
}
/**
*
* The collaboration ID of the collaboration that contains the trained model inference job.
*
*
* @return The collaboration ID of the collaboration that contains the trained model inference job.
*/
public final String collaborationIdentifier() {
return collaborationIdentifier;
}
/**
*
* The status of the trained model inference job.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link TrainedModelInferenceJobStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #statusAsString}.
*
*
* @return The status of the trained model inference job.
* @see TrainedModelInferenceJobStatus
*/
public final TrainedModelInferenceJobStatus status() {
return TrainedModelInferenceJobStatus.fromValue(status);
}
/**
*
* The status of the trained model inference job.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link TrainedModelInferenceJobStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #statusAsString}.
*
*
* @return The status of the trained model inference job.
* @see TrainedModelInferenceJobStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* The output configuration information of the trained model job.
*
*
* @return The output configuration information of the trained model job.
*/
public final InferenceOutputConfiguration outputConfiguration() {
return outputConfiguration;
}
/**
*
* The name of the trained model inference job.
*
*
* @return The name of the trained model inference job.
*/
public final String name() {
return name;
}
/**
*
* The description of the trained model inference job.
*
*
* @return The description of the trained model inference job.
*/
public final String description() {
return description;
}
/**
*
* The metric status of the trained model inference job.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #metricsStatus}
* will return {@link MetricsStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #metricsStatusAsString}.
*
*
* @return The metric status of the trained model inference job.
* @see MetricsStatus
*/
public final MetricsStatus metricsStatus() {
return MetricsStatus.fromValue(metricsStatus);
}
/**
*
* The metric status of the trained model inference job.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #metricsStatus}
* will return {@link MetricsStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #metricsStatusAsString}.
*
*
* @return The metric status of the trained model inference job.
* @see MetricsStatus
*/
public final String metricsStatusAsString() {
return metricsStatus;
}
/**
*
* Details about the metrics status for the trained model inference job.
*
*
* @return Details about the metrics status for the trained model inference job.
*/
public final String metricsStatusDetails() {
return metricsStatusDetails;
}
/**
*
* The log status of the trained model inference job.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #logsStatus} will
* return {@link LogsStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #logsStatusAsString}.
*
*
* @return The log status of the trained model inference job.
* @see LogsStatus
*/
public final LogsStatus logsStatus() {
return LogsStatus.fromValue(logsStatus);
}
/**
*
* The log status of the trained model inference job.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #logsStatus} will
* return {@link LogsStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #logsStatusAsString}.
*
*
* @return The log status of the trained model inference job.
* @see LogsStatus
*/
public final String logsStatusAsString() {
return logsStatus;
}
/**
*
* Details about the log status for the trained model inference job.
*
*
* @return Details about the log status for the trained model inference job.
*/
public final String logsStatusDetails() {
return logsStatusDetails;
}
/**
*
* The time at which the trained model inference job was created.
*
*
* @return The time at which the trained model inference job was created.
*/
public final Instant createTime() {
return createTime;
}
/**
*
* The most recent time at which the trained model inference job was updated.
*
*
* @return The most recent time at which the trained model inference job was updated.
*/
public final Instant updateTime() {
return updateTime;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(trainedModelInferenceJobArn());
hashCode = 31 * hashCode + Objects.hashCode(configuredModelAlgorithmAssociationArn());
hashCode = 31 * hashCode + Objects.hashCode(membershipIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(trainedModelArn());
hashCode = 31 * hashCode + Objects.hashCode(collaborationIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(outputConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(metricsStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(metricsStatusDetails());
hashCode = 31 * hashCode + Objects.hashCode(logsStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(logsStatusDetails());
hashCode = 31 * hashCode + Objects.hashCode(createTime());
hashCode = 31 * hashCode + Objects.hashCode(updateTime());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof TrainedModelInferenceJobSummary)) {
return false;
}
TrainedModelInferenceJobSummary other = (TrainedModelInferenceJobSummary) obj;
return Objects.equals(trainedModelInferenceJobArn(), other.trainedModelInferenceJobArn())
&& Objects.equals(configuredModelAlgorithmAssociationArn(), other.configuredModelAlgorithmAssociationArn())
&& Objects.equals(membershipIdentifier(), other.membershipIdentifier())
&& Objects.equals(trainedModelArn(), other.trainedModelArn())
&& Objects.equals(collaborationIdentifier(), other.collaborationIdentifier())
&& Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(outputConfiguration(), other.outputConfiguration()) && Objects.equals(name(), other.name())
&& Objects.equals(description(), other.description())
&& Objects.equals(metricsStatusAsString(), other.metricsStatusAsString())
&& Objects.equals(metricsStatusDetails(), other.metricsStatusDetails())
&& Objects.equals(logsStatusAsString(), other.logsStatusAsString())
&& Objects.equals(logsStatusDetails(), other.logsStatusDetails())
&& Objects.equals(createTime(), other.createTime()) && Objects.equals(updateTime(), other.updateTime());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("TrainedModelInferenceJobSummary")
.add("TrainedModelInferenceJobArn", trainedModelInferenceJobArn())
.add("ConfiguredModelAlgorithmAssociationArn", configuredModelAlgorithmAssociationArn())
.add("MembershipIdentifier", membershipIdentifier()).add("TrainedModelArn", trainedModelArn())
.add("CollaborationIdentifier", collaborationIdentifier()).add("Status", statusAsString())
.add("OutputConfiguration", outputConfiguration()).add("Name", name()).add("Description", description())
.add("MetricsStatus", metricsStatusAsString()).add("MetricsStatusDetails", metricsStatusDetails())
.add("LogsStatus", logsStatusAsString()).add("LogsStatusDetails", logsStatusDetails())
.add("CreateTime", createTime()).add("UpdateTime", updateTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "trainedModelInferenceJobArn":
return Optional.ofNullable(clazz.cast(trainedModelInferenceJobArn()));
case "configuredModelAlgorithmAssociationArn":
return Optional.ofNullable(clazz.cast(configuredModelAlgorithmAssociationArn()));
case "membershipIdentifier":
return Optional.ofNullable(clazz.cast(membershipIdentifier()));
case "trainedModelArn":
return Optional.ofNullable(clazz.cast(trainedModelArn()));
case "collaborationIdentifier":
return Optional.ofNullable(clazz.cast(collaborationIdentifier()));
case "status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "outputConfiguration":
return Optional.ofNullable(clazz.cast(outputConfiguration()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "description":
return Optional.ofNullable(clazz.cast(description()));
case "metricsStatus":
return Optional.ofNullable(clazz.cast(metricsStatusAsString()));
case "metricsStatusDetails":
return Optional.ofNullable(clazz.cast(metricsStatusDetails()));
case "logsStatus":
return Optional.ofNullable(clazz.cast(logsStatusAsString()));
case "logsStatusDetails":
return Optional.ofNullable(clazz.cast(logsStatusDetails()));
case "createTime":
return Optional.ofNullable(clazz.cast(createTime()));
case "updateTime":
return Optional.ofNullable(clazz.cast(updateTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function