software.amazon.awssdk.services.sagemaker.model.CreateTrialRequest 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.sagemaker.model;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateTrialRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField TRIAL_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateTrialRequest::trialName)).setter(setter(Builder::trialName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TrialName").build()).build();
private static final SdkField DISPLAY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateTrialRequest::displayName)).setter(setter(Builder::displayName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DisplayName").build()).build();
private static final SdkField EXPERIMENT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateTrialRequest::experimentName)).setter(setter(Builder::experimentName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExperimentName").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(CreateTrialRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TRIAL_NAME_FIELD,
DISPLAY_NAME_FIELD, EXPERIMENT_NAME_FIELD, TAGS_FIELD));
private final String trialName;
private final String displayName;
private final String experimentName;
private final List tags;
private CreateTrialRequest(BuilderImpl builder) {
super(builder);
this.trialName = builder.trialName;
this.displayName = builder.displayName;
this.experimentName = builder.experimentName;
this.tags = builder.tags;
}
/**
*
* The name of the trial. The name must be unique in your AWS account and is not case-sensitive.
*
*
* @return The name of the trial. The name must be unique in your AWS account and is not case-sensitive.
*/
public String trialName() {
return trialName;
}
/**
*
* The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't
* specified, TrialName is displayed.
*
*
* @return The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't
* specified, TrialName is displayed.
*/
public String displayName() {
return displayName;
}
/**
*
* The name of the experiment to associate the trial with.
*
*
* @return The name of the experiment to associate the trial with.
*/
public String experimentName() {
return experimentName;
}
/**
* Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags to associate with the trial. You can use Search API to search on the tags.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasTags()} to see if a value was sent in this field.
*
*
* @return A list of tags to associate with the trial. You can use Search API to search on the tags.
*/
public List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(trialName());
hashCode = 31 * hashCode + Objects.hashCode(displayName());
hashCode = 31 * hashCode + Objects.hashCode(experimentName());
hashCode = 31 * hashCode + Objects.hashCode(tags());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateTrialRequest)) {
return false;
}
CreateTrialRequest other = (CreateTrialRequest) obj;
return Objects.equals(trialName(), other.trialName()) && Objects.equals(displayName(), other.displayName())
&& Objects.equals(experimentName(), other.experimentName()) && Objects.equals(tags(), other.tags());
}
/**
* 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 String toString() {
return ToString.builder("CreateTrialRequest").add("TrialName", trialName()).add("DisplayName", displayName())
.add("ExperimentName", experimentName()).add("Tags", tags()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TrialName":
return Optional.ofNullable(clazz.cast(trialName()));
case "DisplayName":
return Optional.ofNullable(clazz.cast(displayName()));
case "ExperimentName":
return Optional.ofNullable(clazz.cast(experimentName()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateTrialRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the trial. The name must be unique in your AWS account and is not case-sensitive.
*
*
* @param trialName
* The name of the trial. The name must be unique in your AWS account and is not case-sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trialName(String trialName);
/**
*
* The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't
* specified, TrialName is displayed.
*
*
* @param displayName
* The name of the trial as displayed. The name doesn't need to be unique. If DisplayName
* isn't specified, TrialName is displayed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder displayName(String displayName);
/**
*
* The name of the experiment to associate the trial with.
*
*
* @param experimentName
* The name of the experiment to associate the trial with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder experimentName(String experimentName);
/**
*
* A list of tags to associate with the trial. You can use Search API to search on the tags.
*
*
* @param tags
* A list of tags to associate with the trial. You can use Search API to search on the tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags to associate with the trial. You can use Search API to search on the tags.
*
*
* @param tags
* A list of tags to associate with the trial. You can use Search API to search on the tags.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags to associate with the trial. You can use Search API to search on the tags.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create
* one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String trialName;
private String displayName;
private String experimentName;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateTrialRequest model) {
super(model);
trialName(model.trialName);
displayName(model.displayName);
experimentName(model.experimentName);
tags(model.tags);
}
public final String getTrialName() {
return trialName;
}
@Override
public final Builder trialName(String trialName) {
this.trialName = trialName;
return this;
}
public final void setTrialName(String trialName) {
this.trialName = trialName;
}
public final String getDisplayName() {
return displayName;
}
@Override
public final Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
public final void setDisplayName(String displayName) {
this.displayName = displayName;
}
public final String getExperimentName() {
return experimentName;
}
@Override
public final Builder experimentName(String experimentName) {
this.experimentName = experimentName;
return this;
}
public final void setExperimentName(String experimentName) {
this.experimentName = experimentName;
}
public final Collection getTags() {
return tags != null ? tags.stream().map(Tag::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateTrialRequest build() {
return new CreateTrialRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy