software.amazon.awssdk.services.sagemaker.model.NotebookInstanceLifecycleHook 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.io.Serializable;
import java.util.Arrays;
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.Function;
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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains the notebook instance lifecycle configuration script.
*
*
* Each lifecycle configuration script has a limit of 16384 characters.
*
*
* The value of the $PATH environment variable that is available to both scripts is
* /sbin:bin:/usr/sbin:/usr/bin.
*
*
* View Amazon CloudWatch Logs for notebook instance lifecycle configurations in log group
* /aws/sagemaker/NotebookInstances in log stream
* [notebook-instance-name]/[LifecycleConfigHook].
*
*
* Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it
* fails and the notebook instance is not created or started.
*
*
* For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize
* a Notebook Instance.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class NotebookInstanceLifecycleHook implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CONTENT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Content")
.getter(getter(NotebookInstanceLifecycleHook::content)).setter(setter(Builder::content))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Content").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONTENT_FIELD));
private static final long serialVersionUID = 1L;
private final String content;
private NotebookInstanceLifecycleHook(BuilderImpl builder) {
this.content = builder.content;
}
/**
*
* A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
*
*
* @return A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
*/
public final String content() {
return content;
}
@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(content());
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 NotebookInstanceLifecycleHook)) {
return false;
}
NotebookInstanceLifecycleHook other = (NotebookInstanceLifecycleHook) obj;
return Objects.equals(content(), other.content());
}
/**
* 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("NotebookInstanceLifecycleHook").add("Content", content()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Content":
return Optional.ofNullable(clazz.cast(content()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((NotebookInstanceLifecycleHook) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
*
*
* @param content
* A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder content(String content);
}
static final class BuilderImpl implements Builder {
private String content;
private BuilderImpl() {
}
private BuilderImpl(NotebookInstanceLifecycleHook model) {
content(model.content);
}
public final String getContent() {
return content;
}
public final void setContent(String content) {
this.content = content;
}
@Override
public final Builder content(String content) {
this.content = content;
return this;
}
@Override
public NotebookInstanceLifecycleHook build() {
return new NotebookInstanceLifecycleHook(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}