software.amazon.awssdk.services.sagemaker.model.UpdateTrainingJobRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemaker Show documentation
Show all versions of sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating
with Amazon SageMaker Service
/*
* 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.beans.Transient;
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 UpdateTrainingJobRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField TRAINING_JOB_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TrainingJobName").getter(getter(UpdateTrainingJobRequest::trainingJobName))
.setter(setter(Builder::trainingJobName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TrainingJobName").build()).build();
private static final SdkField PROFILER_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ProfilerConfig")
.getter(getter(UpdateTrainingJobRequest::profilerConfig)).setter(setter(Builder::profilerConfig))
.constructor(ProfilerConfigForUpdate::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProfilerConfig").build()).build();
private static final SdkField> PROFILER_RULE_CONFIGURATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ProfilerRuleConfigurations")
.getter(getter(UpdateTrainingJobRequest::profilerRuleConfigurations))
.setter(setter(Builder::profilerRuleConfigurations))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ProfilerRuleConfigurations").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ProfilerRuleConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TRAINING_JOB_NAME_FIELD,
PROFILER_CONFIG_FIELD, PROFILER_RULE_CONFIGURATIONS_FIELD));
private final String trainingJobName;
private final ProfilerConfigForUpdate profilerConfig;
private final List profilerRuleConfigurations;
private UpdateTrainingJobRequest(BuilderImpl builder) {
super(builder);
this.trainingJobName = builder.trainingJobName;
this.profilerConfig = builder.profilerConfig;
this.profilerRuleConfigurations = builder.profilerRuleConfigurations;
}
/**
*
* The name of a training job to update the Debugger profiling configuration.
*
*
* @return The name of a training job to update the Debugger profiling configuration.
*/
public final String trainingJobName() {
return trainingJobName;
}
/**
*
* Configuration information for Debugger system monitoring, framework profiling, and storage paths.
*
*
* @return Configuration information for Debugger system monitoring, framework profiling, and storage paths.
*/
public final ProfilerConfigForUpdate profilerConfig() {
return profilerConfig;
}
/**
* For responses, this returns true if the service returned a value for the ProfilerRuleConfigurations property.
* This DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasProfilerRuleConfigurations() {
return profilerRuleConfigurations != null && !(profilerRuleConfigurations instanceof SdkAutoConstructList);
}
/**
*
* Configuration information for Debugger rules for profiling system and framework metrics.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasProfilerRuleConfigurations} method.
*
*
* @return Configuration information for Debugger rules for profiling system and framework metrics.
*/
public final List profilerRuleConfigurations() {
return profilerRuleConfigurations;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(trainingJobName());
hashCode = 31 * hashCode + Objects.hashCode(profilerConfig());
hashCode = 31 * hashCode + Objects.hashCode(hasProfilerRuleConfigurations() ? profilerRuleConfigurations() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateTrainingJobRequest)) {
return false;
}
UpdateTrainingJobRequest other = (UpdateTrainingJobRequest) obj;
return Objects.equals(trainingJobName(), other.trainingJobName())
&& Objects.equals(profilerConfig(), other.profilerConfig())
&& hasProfilerRuleConfigurations() == other.hasProfilerRuleConfigurations()
&& Objects.equals(profilerRuleConfigurations(), other.profilerRuleConfigurations());
}
/**
* 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("UpdateTrainingJobRequest").add("TrainingJobName", trainingJobName())
.add("ProfilerConfig", profilerConfig())
.add("ProfilerRuleConfigurations", hasProfilerRuleConfigurations() ? profilerRuleConfigurations() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TrainingJobName":
return Optional.ofNullable(clazz.cast(trainingJobName()));
case "ProfilerConfig":
return Optional.ofNullable(clazz.cast(profilerConfig()));
case "ProfilerRuleConfigurations":
return Optional.ofNullable(clazz.cast(profilerRuleConfigurations()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateTrainingJobRequest) 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 a training job to update the Debugger profiling configuration.
*
*
* @param trainingJobName
* The name of a training job to update the Debugger profiling configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder trainingJobName(String trainingJobName);
/**
*
* Configuration information for Debugger system monitoring, framework profiling, and storage paths.
*
*
* @param profilerConfig
* Configuration information for Debugger system monitoring, framework profiling, and storage paths.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder profilerConfig(ProfilerConfigForUpdate profilerConfig);
/**
*
* Configuration information for Debugger system monitoring, framework profiling, and storage paths.
*
* This is a convenience that creates an instance of the {@link ProfilerConfigForUpdate.Builder} avoiding the
* need to create one manually via {@link ProfilerConfigForUpdate#builder()}.
*
* When the {@link Consumer} completes, {@link ProfilerConfigForUpdate.Builder#build()} is called immediately
* and its result is passed to {@link #profilerConfig(ProfilerConfigForUpdate)}.
*
* @param profilerConfig
* a consumer that will call methods on {@link ProfilerConfigForUpdate.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #profilerConfig(ProfilerConfigForUpdate)
*/
default Builder profilerConfig(Consumer profilerConfig) {
return profilerConfig(ProfilerConfigForUpdate.builder().applyMutation(profilerConfig).build());
}
/**
*
* Configuration information for Debugger rules for profiling system and framework metrics.
*
*
* @param profilerRuleConfigurations
* Configuration information for Debugger rules for profiling system and framework metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder profilerRuleConfigurations(Collection profilerRuleConfigurations);
/**
*
* Configuration information for Debugger rules for profiling system and framework metrics.
*
*
* @param profilerRuleConfigurations
* Configuration information for Debugger rules for profiling system and framework metrics.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder profilerRuleConfigurations(ProfilerRuleConfiguration... profilerRuleConfigurations);
/**
*
* Configuration information for Debugger rules for profiling system and framework metrics.
*
* 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 #profilerRuleConfigurations(List)}.
*
* @param profilerRuleConfigurations
* 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 #profilerRuleConfigurations(List)
*/
Builder profilerRuleConfigurations(Consumer... profilerRuleConfigurations);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String trainingJobName;
private ProfilerConfigForUpdate profilerConfig;
private List profilerRuleConfigurations = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpdateTrainingJobRequest model) {
super(model);
trainingJobName(model.trainingJobName);
profilerConfig(model.profilerConfig);
profilerRuleConfigurations(model.profilerRuleConfigurations);
}
public final String getTrainingJobName() {
return trainingJobName;
}
public final void setTrainingJobName(String trainingJobName) {
this.trainingJobName = trainingJobName;
}
@Override
@Transient
public final Builder trainingJobName(String trainingJobName) {
this.trainingJobName = trainingJobName;
return this;
}
public final ProfilerConfigForUpdate.Builder getProfilerConfig() {
return profilerConfig != null ? profilerConfig.toBuilder() : null;
}
public final void setProfilerConfig(ProfilerConfigForUpdate.BuilderImpl profilerConfig) {
this.profilerConfig = profilerConfig != null ? profilerConfig.build() : null;
}
@Override
@Transient
public final Builder profilerConfig(ProfilerConfigForUpdate profilerConfig) {
this.profilerConfig = profilerConfig;
return this;
}
public final List getProfilerRuleConfigurations() {
List result = ProfilerRuleConfigurationsCopier
.copyToBuilder(this.profilerRuleConfigurations);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setProfilerRuleConfigurations(
Collection profilerRuleConfigurations) {
this.profilerRuleConfigurations = ProfilerRuleConfigurationsCopier.copyFromBuilder(profilerRuleConfigurations);
}
@Override
@Transient
public final Builder profilerRuleConfigurations(Collection profilerRuleConfigurations) {
this.profilerRuleConfigurations = ProfilerRuleConfigurationsCopier.copy(profilerRuleConfigurations);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder profilerRuleConfigurations(ProfilerRuleConfiguration... profilerRuleConfigurations) {
profilerRuleConfigurations(Arrays.asList(profilerRuleConfigurations));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder profilerRuleConfigurations(Consumer... profilerRuleConfigurations) {
profilerRuleConfigurations(Stream.of(profilerRuleConfigurations)
.map(c -> ProfilerRuleConfiguration.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateTrainingJobRequest build() {
return new UpdateTrainingJobRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy