software.amazon.awssdk.services.sagemaker.model.DescribeNotebookInstanceLifecycleConfigResponse 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.time.Instant;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeNotebookInstanceLifecycleConfigResponse extends SageMakerResponse
implements
ToCopyableBuilder {
private static final SdkField NOTEBOOK_INSTANCE_LIFECYCLE_CONFIG_ARN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NotebookInstanceLifecycleConfigArn")
.getter(getter(DescribeNotebookInstanceLifecycleConfigResponse::notebookInstanceLifecycleConfigArn))
.setter(setter(Builder::notebookInstanceLifecycleConfigArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NotebookInstanceLifecycleConfigArn")
.build()).build();
private static final SdkField NOTEBOOK_INSTANCE_LIFECYCLE_CONFIG_NAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NotebookInstanceLifecycleConfigName")
.getter(getter(DescribeNotebookInstanceLifecycleConfigResponse::notebookInstanceLifecycleConfigName))
.setter(setter(Builder::notebookInstanceLifecycleConfigName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("NotebookInstanceLifecycleConfigName").build()).build();
private static final SdkField> ON_CREATE_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OnCreate")
.getter(getter(DescribeNotebookInstanceLifecycleConfigResponse::onCreate))
.setter(setter(Builder::onCreate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OnCreate").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(NotebookInstanceLifecycleHook::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ON_START_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OnStart")
.getter(getter(DescribeNotebookInstanceLifecycleConfigResponse::onStart))
.setter(setter(Builder::onStart))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OnStart").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(NotebookInstanceLifecycleHook::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField LAST_MODIFIED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastModifiedTime").getter(getter(DescribeNotebookInstanceLifecycleConfigResponse::lastModifiedTime))
.setter(setter(Builder::lastModifiedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastModifiedTime").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(DescribeNotebookInstanceLifecycleConfigResponse::creationTime))
.setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
NOTEBOOK_INSTANCE_LIFECYCLE_CONFIG_ARN_FIELD, NOTEBOOK_INSTANCE_LIFECYCLE_CONFIG_NAME_FIELD, ON_CREATE_FIELD,
ON_START_FIELD, LAST_MODIFIED_TIME_FIELD, CREATION_TIME_FIELD));
private final String notebookInstanceLifecycleConfigArn;
private final String notebookInstanceLifecycleConfigName;
private final List onCreate;
private final List onStart;
private final Instant lastModifiedTime;
private final Instant creationTime;
private DescribeNotebookInstanceLifecycleConfigResponse(BuilderImpl builder) {
super(builder);
this.notebookInstanceLifecycleConfigArn = builder.notebookInstanceLifecycleConfigArn;
this.notebookInstanceLifecycleConfigName = builder.notebookInstanceLifecycleConfigName;
this.onCreate = builder.onCreate;
this.onStart = builder.onStart;
this.lastModifiedTime = builder.lastModifiedTime;
this.creationTime = builder.creationTime;
}
/**
*
* The Amazon Resource Name (ARN) of the lifecycle configuration.
*
*
* @return The Amazon Resource Name (ARN) of the lifecycle configuration.
*/
public final String notebookInstanceLifecycleConfigArn() {
return notebookInstanceLifecycleConfigArn;
}
/**
*
* The name of the lifecycle configuration.
*
*
* @return The name of the lifecycle configuration.
*/
public final String notebookInstanceLifecycleConfigName() {
return notebookInstanceLifecycleConfigName;
}
/**
* For responses, this returns true if the service returned a value for the OnCreate 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 hasOnCreate() {
return onCreate != null && !(onCreate instanceof SdkAutoConstructList);
}
/**
*
* The shell script that runs only once, when you create a notebook instance.
*
*
* 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 #hasOnCreate} method.
*
*
* @return The shell script that runs only once, when you create a notebook instance.
*/
public final List onCreate() {
return onCreate;
}
/**
* For responses, this returns true if the service returned a value for the OnStart 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 hasOnStart() {
return onStart != null && !(onStart instanceof SdkAutoConstructList);
}
/**
*
* The shell script that runs every time you start a notebook instance, including when you create the notebook
* instance.
*
*
* 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 #hasOnStart} method.
*
*
* @return The shell script that runs every time you start a notebook instance, including when you create the
* notebook instance.
*/
public final List onStart() {
return onStart;
}
/**
*
* A timestamp that tells when the lifecycle configuration was last modified.
*
*
* @return A timestamp that tells when the lifecycle configuration was last modified.
*/
public final Instant lastModifiedTime() {
return lastModifiedTime;
}
/**
*
* A timestamp that tells when the lifecycle configuration was created.
*
*
* @return A timestamp that tells when the lifecycle configuration was created.
*/
public final Instant creationTime() {
return creationTime;
}
@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(notebookInstanceLifecycleConfigArn());
hashCode = 31 * hashCode + Objects.hashCode(notebookInstanceLifecycleConfigName());
hashCode = 31 * hashCode + Objects.hashCode(hasOnCreate() ? onCreate() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasOnStart() ? onStart() : null);
hashCode = 31 * hashCode + Objects.hashCode(lastModifiedTime());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
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 DescribeNotebookInstanceLifecycleConfigResponse)) {
return false;
}
DescribeNotebookInstanceLifecycleConfigResponse other = (DescribeNotebookInstanceLifecycleConfigResponse) obj;
return Objects.equals(notebookInstanceLifecycleConfigArn(), other.notebookInstanceLifecycleConfigArn())
&& Objects.equals(notebookInstanceLifecycleConfigName(), other.notebookInstanceLifecycleConfigName())
&& hasOnCreate() == other.hasOnCreate() && Objects.equals(onCreate(), other.onCreate())
&& hasOnStart() == other.hasOnStart() && Objects.equals(onStart(), other.onStart())
&& Objects.equals(lastModifiedTime(), other.lastModifiedTime())
&& Objects.equals(creationTime(), other.creationTime());
}
/**
* 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("DescribeNotebookInstanceLifecycleConfigResponse")
.add("NotebookInstanceLifecycleConfigArn", notebookInstanceLifecycleConfigArn())
.add("NotebookInstanceLifecycleConfigName", notebookInstanceLifecycleConfigName())
.add("OnCreate", hasOnCreate() ? onCreate() : null).add("OnStart", hasOnStart() ? onStart() : null)
.add("LastModifiedTime", lastModifiedTime()).add("CreationTime", creationTime()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NotebookInstanceLifecycleConfigArn":
return Optional.ofNullable(clazz.cast(notebookInstanceLifecycleConfigArn()));
case "NotebookInstanceLifecycleConfigName":
return Optional.ofNullable(clazz.cast(notebookInstanceLifecycleConfigName()));
case "OnCreate":
return Optional.ofNullable(clazz.cast(onCreate()));
case "OnStart":
return Optional.ofNullable(clazz.cast(onStart()));
case "LastModifiedTime":
return Optional.ofNullable(clazz.cast(lastModifiedTime()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeNotebookInstanceLifecycleConfigResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the lifecycle configuration.
*
*
* @param notebookInstanceLifecycleConfigArn
* The Amazon Resource Name (ARN) of the lifecycle configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder notebookInstanceLifecycleConfigArn(String notebookInstanceLifecycleConfigArn);
/**
*
* The name of the lifecycle configuration.
*
*
* @param notebookInstanceLifecycleConfigName
* The name of the lifecycle configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder notebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName);
/**
*
* The shell script that runs only once, when you create a notebook instance.
*
*
* @param onCreate
* The shell script that runs only once, when you create a notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder onCreate(Collection onCreate);
/**
*
* The shell script that runs only once, when you create a notebook instance.
*
*
* @param onCreate
* The shell script that runs only once, when you create a notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder onCreate(NotebookInstanceLifecycleHook... onCreate);
/**
*
* The shell script that runs only once, when you create a notebook instance.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook.Builder#build()} is
* called immediately and its result is passed to {@link #onCreate(List)}.
*
* @param onCreate
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #onCreate(java.util.Collection)
*/
Builder onCreate(Consumer... onCreate);
/**
*
* The shell script that runs every time you start a notebook instance, including when you create the notebook
* instance.
*
*
* @param onStart
* The shell script that runs every time you start a notebook instance, including when you create the
* notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder onStart(Collection onStart);
/**
*
* The shell script that runs every time you start a notebook instance, including when you create the notebook
* instance.
*
*
* @param onStart
* The shell script that runs every time you start a notebook instance, including when you create the
* notebook instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder onStart(NotebookInstanceLifecycleHook... onStart);
/**
*
* The shell script that runs every time you start a notebook instance, including when you create the notebook
* instance.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook.Builder#build()} is
* called immediately and its result is passed to {@link #onStart(List)}.
*
* @param onStart
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #onStart(java.util.Collection)
*/
Builder onStart(Consumer... onStart);
/**
*
* A timestamp that tells when the lifecycle configuration was last modified.
*
*
* @param lastModifiedTime
* A timestamp that tells when the lifecycle configuration was last modified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastModifiedTime(Instant lastModifiedTime);
/**
*
* A timestamp that tells when the lifecycle configuration was created.
*
*
* @param creationTime
* A timestamp that tells when the lifecycle configuration was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
}
static final class BuilderImpl extends SageMakerResponse.BuilderImpl implements Builder {
private String notebookInstanceLifecycleConfigArn;
private String notebookInstanceLifecycleConfigName;
private List onCreate = DefaultSdkAutoConstructList.getInstance();
private List onStart = DefaultSdkAutoConstructList.getInstance();
private Instant lastModifiedTime;
private Instant creationTime;
private BuilderImpl() {
}
private BuilderImpl(DescribeNotebookInstanceLifecycleConfigResponse model) {
super(model);
notebookInstanceLifecycleConfigArn(model.notebookInstanceLifecycleConfigArn);
notebookInstanceLifecycleConfigName(model.notebookInstanceLifecycleConfigName);
onCreate(model.onCreate);
onStart(model.onStart);
lastModifiedTime(model.lastModifiedTime);
creationTime(model.creationTime);
}
public final String getNotebookInstanceLifecycleConfigArn() {
return notebookInstanceLifecycleConfigArn;
}
public final void setNotebookInstanceLifecycleConfigArn(String notebookInstanceLifecycleConfigArn) {
this.notebookInstanceLifecycleConfigArn = notebookInstanceLifecycleConfigArn;
}
@Override
public final Builder notebookInstanceLifecycleConfigArn(String notebookInstanceLifecycleConfigArn) {
this.notebookInstanceLifecycleConfigArn = notebookInstanceLifecycleConfigArn;
return this;
}
public final String getNotebookInstanceLifecycleConfigName() {
return notebookInstanceLifecycleConfigName;
}
public final void setNotebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName) {
this.notebookInstanceLifecycleConfigName = notebookInstanceLifecycleConfigName;
}
@Override
public final Builder notebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName) {
this.notebookInstanceLifecycleConfigName = notebookInstanceLifecycleConfigName;
return this;
}
public final List getOnCreate() {
List result = NotebookInstanceLifecycleConfigListCopier
.copyToBuilder(this.onCreate);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOnCreate(Collection onCreate) {
this.onCreate = NotebookInstanceLifecycleConfigListCopier.copyFromBuilder(onCreate);
}
@Override
public final Builder onCreate(Collection onCreate) {
this.onCreate = NotebookInstanceLifecycleConfigListCopier.copy(onCreate);
return this;
}
@Override
@SafeVarargs
public final Builder onCreate(NotebookInstanceLifecycleHook... onCreate) {
onCreate(Arrays.asList(onCreate));
return this;
}
@Override
@SafeVarargs
public final Builder onCreate(Consumer... onCreate) {
onCreate(Stream.of(onCreate).map(c -> NotebookInstanceLifecycleHook.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getOnStart() {
List result = NotebookInstanceLifecycleConfigListCopier
.copyToBuilder(this.onStart);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOnStart(Collection onStart) {
this.onStart = NotebookInstanceLifecycleConfigListCopier.copyFromBuilder(onStart);
}
@Override
public final Builder onStart(Collection onStart) {
this.onStart = NotebookInstanceLifecycleConfigListCopier.copy(onStart);
return this;
}
@Override
@SafeVarargs
public final Builder onStart(NotebookInstanceLifecycleHook... onStart) {
onStart(Arrays.asList(onStart));
return this;
}
@Override
@SafeVarargs
public final Builder onStart(Consumer... onStart) {
onStart(Stream.of(onStart).map(c -> NotebookInstanceLifecycleHook.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Instant getLastModifiedTime() {
return lastModifiedTime;
}
public final void setLastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
@Override
public final Builder lastModifiedTime(Instant lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
@Override
public DescribeNotebookInstanceLifecycleConfigResponse build() {
return new DescribeNotebookInstanceLifecycleConfigResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}