software.amazon.awssdk.services.sagemaker.model.FileSystemConfig 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.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;
/**
*
* The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class FileSystemConfig implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MOUNT_PATH_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MountPath").getter(getter(FileSystemConfig::mountPath)).setter(setter(Builder::mountPath))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MountPath").build()).build();
private static final SdkField DEFAULT_UID_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("DefaultUid").getter(getter(FileSystemConfig::defaultUid)).setter(setter(Builder::defaultUid))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultUid").build()).build();
private static final SdkField DEFAULT_GID_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("DefaultGid").getter(getter(FileSystemConfig::defaultGid)).setter(setter(Builder::defaultGid))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DefaultGid").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MOUNT_PATH_FIELD,
DEFAULT_UID_FIELD, DEFAULT_GID_FIELD));
private static final long serialVersionUID = 1L;
private final String mountPath;
private final Integer defaultUid;
private final Integer defaultGid;
private FileSystemConfig(BuilderImpl builder) {
this.mountPath = builder.mountPath;
this.defaultUid = builder.defaultUid;
this.defaultGid = builder.defaultGid;
}
/**
*
* The path within the image to mount the user's EFS home directory. The directory should be empty. If not
* specified, defaults to /home/sagemaker-user.
*
*
* @return The path within the image to mount the user's EFS home directory. The directory should be empty. If not
* specified, defaults to /home/sagemaker-user.
*/
public String mountPath() {
return mountPath;
}
/**
*
* The default POSIX user ID (UID). If not specified, defaults to 1000.
*
*
* @return The default POSIX user ID (UID). If not specified, defaults to 1000.
*/
public Integer defaultUid() {
return defaultUid;
}
/**
*
* The default POSIX group ID (GID). If not specified, defaults to 100.
*
*
* @return The default POSIX group ID (GID). If not specified, defaults to 100.
*/
public Integer defaultGid() {
return defaultGid;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(mountPath());
hashCode = 31 * hashCode + Objects.hashCode(defaultUid());
hashCode = 31 * hashCode + Objects.hashCode(defaultGid());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof FileSystemConfig)) {
return false;
}
FileSystemConfig other = (FileSystemConfig) obj;
return Objects.equals(mountPath(), other.mountPath()) && Objects.equals(defaultUid(), other.defaultUid())
&& Objects.equals(defaultGid(), other.defaultGid());
}
/**
* 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 String toString() {
return ToString.builder("FileSystemConfig").add("MountPath", mountPath()).add("DefaultUid", defaultUid())
.add("DefaultGid", defaultGid()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MountPath":
return Optional.ofNullable(clazz.cast(mountPath()));
case "DefaultUid":
return Optional.ofNullable(clazz.cast(defaultUid()));
case "DefaultGid":
return Optional.ofNullable(clazz.cast(defaultGid()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((FileSystemConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The path within the image to mount the user's EFS home directory. The directory should be empty. If not
* specified, defaults to /home/sagemaker-user.
*
*
* @param mountPath
* The path within the image to mount the user's EFS home directory. The directory should be empty. If
* not specified, defaults to /home/sagemaker-user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mountPath(String mountPath);
/**
*
* The default POSIX user ID (UID). If not specified, defaults to 1000.
*
*
* @param defaultUid
* The default POSIX user ID (UID). If not specified, defaults to 1000.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultUid(Integer defaultUid);
/**
*
* The default POSIX group ID (GID). If not specified, defaults to 100.
*
*
* @param defaultGid
* The default POSIX group ID (GID). If not specified, defaults to 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultGid(Integer defaultGid);
}
static final class BuilderImpl implements Builder {
private String mountPath;
private Integer defaultUid;
private Integer defaultGid;
private BuilderImpl() {
}
private BuilderImpl(FileSystemConfig model) {
mountPath(model.mountPath);
defaultUid(model.defaultUid);
defaultGid(model.defaultGid);
}
public final String getMountPath() {
return mountPath;
}
@Override
public final Builder mountPath(String mountPath) {
this.mountPath = mountPath;
return this;
}
public final void setMountPath(String mountPath) {
this.mountPath = mountPath;
}
public final Integer getDefaultUid() {
return defaultUid;
}
@Override
public final Builder defaultUid(Integer defaultUid) {
this.defaultUid = defaultUid;
return this;
}
public final void setDefaultUid(Integer defaultUid) {
this.defaultUid = defaultUid;
}
public final Integer getDefaultGid() {
return defaultGid;
}
@Override
public final Builder defaultGid(Integer defaultGid) {
this.defaultGid = defaultGid;
return this;
}
public final void setDefaultGid(Integer defaultGid) {
this.defaultGid = defaultGid;
}
@Override
public FileSystemConfig build() {
return new FileSystemConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy