software.amazon.awssdk.services.sagemaker.model.CreateAppImageConfigRequest 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 CreateAppImageConfigRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField APP_IMAGE_CONFIG_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AppImageConfigName").getter(getter(CreateAppImageConfigRequest::appImageConfigName))
.setter(setter(Builder::appImageConfigName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AppImageConfigName").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateAppImageConfigRequest::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 SdkField KERNEL_GATEWAY_IMAGE_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("KernelGatewayImageConfig")
.getter(getter(CreateAppImageConfigRequest::kernelGatewayImageConfig))
.setter(setter(Builder::kernelGatewayImageConfig)).constructor(KernelGatewayImageConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KernelGatewayImageConfig").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(APP_IMAGE_CONFIG_NAME_FIELD,
TAGS_FIELD, KERNEL_GATEWAY_IMAGE_CONFIG_FIELD));
private final String appImageConfigName;
private final List tags;
private final KernelGatewayImageConfig kernelGatewayImageConfig;
private CreateAppImageConfigRequest(BuilderImpl builder) {
super(builder);
this.appImageConfigName = builder.appImageConfigName;
this.tags = builder.tags;
this.kernelGatewayImageConfig = builder.kernelGatewayImageConfig;
}
/**
*
* The name of the AppImageConfig. Must be unique to your account.
*
*
* @return The name of the AppImageConfig. Must be unique to your account.
*/
public final String appImageConfigName() {
return appImageConfigName;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags to apply to the AppImageConfig.
*
*
* 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 #hasTags} method.
*
*
* @return A list of tags to apply to the AppImageConfig.
*/
public final List tags() {
return tags;
}
/**
*
* The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel will
* be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.
*
*
* @return The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This
* kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in
* JupyterLab.
*/
public final KernelGatewayImageConfig kernelGatewayImageConfig() {
return kernelGatewayImageConfig;
}
@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(appImageConfigName());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(kernelGatewayImageConfig());
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 CreateAppImageConfigRequest)) {
return false;
}
CreateAppImageConfigRequest other = (CreateAppImageConfigRequest) obj;
return Objects.equals(appImageConfigName(), other.appImageConfigName()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags())
&& Objects.equals(kernelGatewayImageConfig(), other.kernelGatewayImageConfig());
}
/**
* 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("CreateAppImageConfigRequest").add("AppImageConfigName", appImageConfigName())
.add("Tags", hasTags() ? tags() : null).add("KernelGatewayImageConfig", kernelGatewayImageConfig()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AppImageConfigName":
return Optional.ofNullable(clazz.cast(appImageConfigName()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "KernelGatewayImageConfig":
return Optional.ofNullable(clazz.cast(kernelGatewayImageConfig()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateAppImageConfigRequest) 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 AppImageConfig. Must be unique to your account.
*
*
* @param appImageConfigName
* The name of the AppImageConfig. Must be unique to your account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder appImageConfigName(String appImageConfigName);
/**
*
* A list of tags to apply to the AppImageConfig.
*
*
* @param tags
* A list of tags to apply to the AppImageConfig.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags to apply to the AppImageConfig.
*
*
* @param tags
* A list of tags to apply to the AppImageConfig.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags to apply to the AppImageConfig.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.sagemaker.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
/**
*
* The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel
* will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.
*
*
* @param kernelGatewayImageConfig
* The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This
* kernel will be shown to users before the image starts. Once the image runs, all kernels are visible in
* JupyterLab.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kernelGatewayImageConfig(KernelGatewayImageConfig kernelGatewayImageConfig);
/**
*
* The KernelGatewayImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel
* will be shown to users before the image starts. Once the image runs, all kernels are visible in JupyterLab.
*
* This is a convenience method that creates an instance of the {@link KernelGatewayImageConfig.Builder}
* avoiding the need to create one manually via {@link KernelGatewayImageConfig#builder()}.
*
*
* When the {@link Consumer} completes, {@link KernelGatewayImageConfig.Builder#build()} is called immediately
* and its result is passed to {@link #kernelGatewayImageConfig(KernelGatewayImageConfig)}.
*
* @param kernelGatewayImageConfig
* a consumer that will call methods on {@link KernelGatewayImageConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #kernelGatewayImageConfig(KernelGatewayImageConfig)
*/
default Builder kernelGatewayImageConfig(Consumer kernelGatewayImageConfig) {
return kernelGatewayImageConfig(KernelGatewayImageConfig.builder().applyMutation(kernelGatewayImageConfig).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String appImageConfigName;
private List tags = DefaultSdkAutoConstructList.getInstance();
private KernelGatewayImageConfig kernelGatewayImageConfig;
private BuilderImpl() {
}
private BuilderImpl(CreateAppImageConfigRequest model) {
super(model);
appImageConfigName(model.appImageConfigName);
tags(model.tags);
kernelGatewayImageConfig(model.kernelGatewayImageConfig);
}
public final String getAppImageConfigName() {
return appImageConfigName;
}
public final void setAppImageConfigName(String appImageConfigName) {
this.appImageConfigName = appImageConfigName;
}
@Override
public final Builder appImageConfigName(String appImageConfigName) {
this.appImageConfigName = appImageConfigName;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@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 KernelGatewayImageConfig.Builder getKernelGatewayImageConfig() {
return kernelGatewayImageConfig != null ? kernelGatewayImageConfig.toBuilder() : null;
}
public final void setKernelGatewayImageConfig(KernelGatewayImageConfig.BuilderImpl kernelGatewayImageConfig) {
this.kernelGatewayImageConfig = kernelGatewayImageConfig != null ? kernelGatewayImageConfig.build() : null;
}
@Override
public final Builder kernelGatewayImageConfig(KernelGatewayImageConfig kernelGatewayImageConfig) {
this.kernelGatewayImageConfig = kernelGatewayImageConfig;
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 CreateAppImageConfigRequest build() {
return new CreateAppImageConfigRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}