software.amazon.awssdk.services.sagemaker.model.KernelGatewayAppSettings Maven / Gradle / Ivy
Show all versions of sagemaker 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.sagemaker.model;
import java.io.Serializable;
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.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;
/**
*
* The KernelGateway app settings.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class KernelGatewayAppSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField DEFAULT_RESOURCE_SPEC_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DefaultResourceSpec")
.getter(getter(KernelGatewayAppSettings::defaultResourceSpec)).setter(setter(Builder::defaultResourceSpec))
.constructor(ResourceSpec::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultResourceSpec").build())
.build();
private static final SdkField> CUSTOM_IMAGES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CustomImages")
.getter(getter(KernelGatewayAppSettings::customImages))
.setter(setter(Builder::customImages))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomImages").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CustomImage::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> LIFECYCLE_CONFIG_ARNS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("LifecycleConfigArns")
.getter(getter(KernelGatewayAppSettings::lifecycleConfigArns))
.setter(setter(Builder::lifecycleConfigArns))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LifecycleConfigArns").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DEFAULT_RESOURCE_SPEC_FIELD,
CUSTOM_IMAGES_FIELD, LIFECYCLE_CONFIG_ARNS_FIELD));
private static final long serialVersionUID = 1L;
private final ResourceSpec defaultResourceSpec;
private final List customImages;
private final List lifecycleConfigArns;
private KernelGatewayAppSettings(BuilderImpl builder) {
this.defaultResourceSpec = builder.defaultResourceSpec;
this.customImages = builder.customImages;
this.lifecycleConfigArns = builder.lifecycleConfigArns;
}
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
*
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type
* set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter value is
* not passed.
*
*
*
* @return The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default
* instance type set here is used when Apps are created using the CLI or CloudFormation and the instance
* type parameter value is not passed.
*
*/
public final ResourceSpec defaultResourceSpec() {
return defaultResourceSpec;
}
/**
* For responses, this returns true if the service returned a value for the CustomImages 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 hasCustomImages() {
return customImages != null && !(customImages instanceof SdkAutoConstructList);
}
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
*
* 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 #hasCustomImages} method.
*
*
* @return A list of custom SageMaker images that are configured to run as a KernelGateway app.
*/
public final List customImages() {
return customImages;
}
/**
* For responses, this returns true if the service returned a value for the LifecycleConfigArns 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 hasLifecycleConfigArns() {
return lifecycleConfigArns != null && !(lifecycleConfigArns instanceof SdkAutoConstructList);
}
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*
* 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 #hasLifecycleConfigArns} method.
*
*
* @return The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or
* domain.
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*/
public final List lifecycleConfigArns() {
return lifecycleConfigArns;
}
@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(defaultResourceSpec());
hashCode = 31 * hashCode + Objects.hashCode(hasCustomImages() ? customImages() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasLifecycleConfigArns() ? lifecycleConfigArns() : null);
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 KernelGatewayAppSettings)) {
return false;
}
KernelGatewayAppSettings other = (KernelGatewayAppSettings) obj;
return Objects.equals(defaultResourceSpec(), other.defaultResourceSpec()) && hasCustomImages() == other.hasCustomImages()
&& Objects.equals(customImages(), other.customImages())
&& hasLifecycleConfigArns() == other.hasLifecycleConfigArns()
&& Objects.equals(lifecycleConfigArns(), other.lifecycleConfigArns());
}
/**
* 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("KernelGatewayAppSettings").add("DefaultResourceSpec", defaultResourceSpec())
.add("CustomImages", hasCustomImages() ? customImages() : null)
.add("LifecycleConfigArns", hasLifecycleConfigArns() ? lifecycleConfigArns() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DefaultResourceSpec":
return Optional.ofNullable(clazz.cast(defaultResourceSpec()));
case "CustomImages":
return Optional.ofNullable(clazz.cast(customImages()));
case "LifecycleConfigArns":
return Optional.ofNullable(clazz.cast(lifecycleConfigArns()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((KernelGatewayAppSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
*
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance
* type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter
* value is not passed.
*
*
*
* @param defaultResourceSpec
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by
* the KernelGateway app.
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default
* instance type set here is used when Apps are created using the CLI or CloudFormation and the instance
* type parameter value is not passed.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultResourceSpec(ResourceSpec defaultResourceSpec);
/**
*
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the
* KernelGateway app.
*
*
*
* The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance
* type set here is used when Apps are created using the CLI or CloudFormation and the instance type parameter
* value is not passed.
*
* This is a convenience method that creates an instance of the {@link ResourceSpec.Builder} avoiding
* the need to create one manually via {@link ResourceSpec#builder()}.
*
*
* When the {@link Consumer} completes, {@link ResourceSpec.Builder#build()} is called immediately and its
* result is passed to {@link #defaultResourceSpec(ResourceSpec)}.
*
* @param defaultResourceSpec
* a consumer that will call methods on {@link ResourceSpec.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #defaultResourceSpec(ResourceSpec)
*/
default Builder defaultResourceSpec(Consumer defaultResourceSpec) {
return defaultResourceSpec(ResourceSpec.builder().applyMutation(defaultResourceSpec).build());
}
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
*
* @param customImages
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customImages(Collection customImages);
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
*
* @param customImages
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customImages(CustomImage... customImages);
/**
*
* A list of custom SageMaker images that are configured to run as a KernelGateway app.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.CustomImage.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.sagemaker.model.CustomImage#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.CustomImage.Builder#build()} is called immediately and
* its result is passed to {@link #customImages(List)}.
*
* @param customImages
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.CustomImage.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #customImages(java.util.Collection)
*/
Builder customImages(Consumer... customImages);
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*
* @param lifecycleConfigArns
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or
* domain.
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lifecycleConfigArns(Collection lifecycleConfigArns);
/**
*
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
*
*
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
*
*
* @param lifecycleConfigArns
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or
* domain.
*
* To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lifecycleConfigArns(String... lifecycleConfigArns);
}
static final class BuilderImpl implements Builder {
private ResourceSpec defaultResourceSpec;
private List customImages = DefaultSdkAutoConstructList.getInstance();
private List lifecycleConfigArns = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(KernelGatewayAppSettings model) {
defaultResourceSpec(model.defaultResourceSpec);
customImages(model.customImages);
lifecycleConfigArns(model.lifecycleConfigArns);
}
public final ResourceSpec.Builder getDefaultResourceSpec() {
return defaultResourceSpec != null ? defaultResourceSpec.toBuilder() : null;
}
public final void setDefaultResourceSpec(ResourceSpec.BuilderImpl defaultResourceSpec) {
this.defaultResourceSpec = defaultResourceSpec != null ? defaultResourceSpec.build() : null;
}
@Override
public final Builder defaultResourceSpec(ResourceSpec defaultResourceSpec) {
this.defaultResourceSpec = defaultResourceSpec;
return this;
}
public final List getCustomImages() {
List result = CustomImagesCopier.copyToBuilder(this.customImages);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCustomImages(Collection customImages) {
this.customImages = CustomImagesCopier.copyFromBuilder(customImages);
}
@Override
public final Builder customImages(Collection customImages) {
this.customImages = CustomImagesCopier.copy(customImages);
return this;
}
@Override
@SafeVarargs
public final Builder customImages(CustomImage... customImages) {
customImages(Arrays.asList(customImages));
return this;
}
@Override
@SafeVarargs
public final Builder customImages(Consumer... customImages) {
customImages(Stream.of(customImages).map(c -> CustomImage.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Collection getLifecycleConfigArns() {
if (lifecycleConfigArns instanceof SdkAutoConstructList) {
return null;
}
return lifecycleConfigArns;
}
public final void setLifecycleConfigArns(Collection lifecycleConfigArns) {
this.lifecycleConfigArns = LifecycleConfigArnsCopier.copy(lifecycleConfigArns);
}
@Override
public final Builder lifecycleConfigArns(Collection lifecycleConfigArns) {
this.lifecycleConfigArns = LifecycleConfigArnsCopier.copy(lifecycleConfigArns);
return this;
}
@Override
@SafeVarargs
public final Builder lifecycleConfigArns(String... lifecycleConfigArns) {
lifecycleConfigArns(Arrays.asList(lifecycleConfigArns));
return this;
}
@Override
public KernelGatewayAppSettings build() {
return new KernelGatewayAppSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}