software.amazon.awssdk.services.rekognition.model.TrainingDataResult Maven / Gradle / Ivy
/*
* 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.rekognition.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created
* during testing.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TrainingDataResult implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField INPUT_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Input").getter(getter(TrainingDataResult::input)).setter(setter(Builder::input))
.constructor(TrainingData::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Input").build()).build();
private static final SdkField OUTPUT_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Output").getter(getter(TrainingDataResult::output)).setter(setter(Builder::output))
.constructor(TrainingData::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Output").build()).build();
private static final SdkField VALIDATION_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Validation").getter(getter(TrainingDataResult::validation)).setter(setter(Builder::validation))
.constructor(ValidationData::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Validation").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INPUT_FIELD, OUTPUT_FIELD,
VALIDATION_FIELD));
private static final long serialVersionUID = 1L;
private final TrainingData input;
private final TrainingData output;
private final ValidationData validation;
private TrainingDataResult(BuilderImpl builder) {
this.input = builder.input;
this.output = builder.output;
this.validation = builder.validation;
}
/**
*
* The training assets that you supplied for training.
*
*
* @return The training assets that you supplied for training.
*/
public final TrainingData input() {
return input;
}
/**
*
* The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
*
*
* @return The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
*/
public final TrainingData output() {
return output;
}
/**
*
* The location of the data validation manifest. The data validation manifest is created for the training dataset
* during model training.
*
*
* @return The location of the data validation manifest. The data validation manifest is created for the training
* dataset during model training.
*/
public final ValidationData validation() {
return validation;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(input());
hashCode = 31 * hashCode + Objects.hashCode(output());
hashCode = 31 * hashCode + Objects.hashCode(validation());
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 TrainingDataResult)) {
return false;
}
TrainingDataResult other = (TrainingDataResult) obj;
return Objects.equals(input(), other.input()) && Objects.equals(output(), other.output())
&& Objects.equals(validation(), other.validation());
}
/**
* 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("TrainingDataResult").add("Input", input()).add("Output", output())
.add("Validation", validation()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Input":
return Optional.ofNullable(clazz.cast(input()));
case "Output":
return Optional.ofNullable(clazz.cast(output()));
case "Validation":
return Optional.ofNullable(clazz.cast(validation()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TrainingDataResult) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The training assets that you supplied for training.
*
*
* @param input
* The training assets that you supplied for training.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder input(TrainingData input);
/**
*
* The training assets that you supplied for training.
*
* This is a convenience method that creates an instance of the {@link TrainingData.Builder} avoiding the need
* to create one manually via {@link TrainingData#builder()}.
*
*
* When the {@link Consumer} completes, {@link TrainingData.Builder#build()} is called immediately and its
* result is passed to {@link #input(TrainingData)}.
*
* @param input
* a consumer that will call methods on {@link TrainingData.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #input(TrainingData)
*/
default Builder input(Consumer input) {
return input(TrainingData.builder().applyMutation(input).build());
}
/**
*
* The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
*
*
* @param output
* The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder output(TrainingData output);
/**
*
* The images (assets) that were actually trained by Amazon Rekognition Custom Labels.
*
* This is a convenience method that creates an instance of the {@link TrainingData.Builder} avoiding the need
* to create one manually via {@link TrainingData#builder()}.
*
*
* When the {@link Consumer} completes, {@link TrainingData.Builder#build()} is called immediately and its
* result is passed to {@link #output(TrainingData)}.
*
* @param output
* a consumer that will call methods on {@link TrainingData.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #output(TrainingData)
*/
default Builder output(Consumer output) {
return output(TrainingData.builder().applyMutation(output).build());
}
/**
*
* The location of the data validation manifest. The data validation manifest is created for the training
* dataset during model training.
*
*
* @param validation
* The location of the data validation manifest. The data validation manifest is created for the training
* dataset during model training.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder validation(ValidationData validation);
/**
*
* The location of the data validation manifest. The data validation manifest is created for the training
* dataset during model training.
*
* This is a convenience method that creates an instance of the {@link ValidationData.Builder} avoiding the need
* to create one manually via {@link ValidationData#builder()}.
*
*
* When the {@link Consumer} completes, {@link ValidationData.Builder#build()} is called immediately and its
* result is passed to {@link #validation(ValidationData)}.
*
* @param validation
* a consumer that will call methods on {@link ValidationData.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #validation(ValidationData)
*/
default Builder validation(Consumer validation) {
return validation(ValidationData.builder().applyMutation(validation).build());
}
}
static final class BuilderImpl implements Builder {
private TrainingData input;
private TrainingData output;
private ValidationData validation;
private BuilderImpl() {
}
private BuilderImpl(TrainingDataResult model) {
input(model.input);
output(model.output);
validation(model.validation);
}
public final TrainingData.Builder getInput() {
return input != null ? input.toBuilder() : null;
}
public final void setInput(TrainingData.BuilderImpl input) {
this.input = input != null ? input.build() : null;
}
@Override
public final Builder input(TrainingData input) {
this.input = input;
return this;
}
public final TrainingData.Builder getOutput() {
return output != null ? output.toBuilder() : null;
}
public final void setOutput(TrainingData.BuilderImpl output) {
this.output = output != null ? output.build() : null;
}
@Override
public final Builder output(TrainingData output) {
this.output = output;
return this;
}
public final ValidationData.Builder getValidation() {
return validation != null ? validation.toBuilder() : null;
}
public final void setValidation(ValidationData.BuilderImpl validation) {
this.validation = validation != null ? validation.build() : null;
}
@Override
public final Builder validation(ValidationData validation) {
this.validation = validation;
return this;
}
@Override
public TrainingDataResult build() {
return new TrainingDataResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}