software.amazon.awssdk.services.sagemaker.model.ModelArtifacts Maven / Gradle / Ivy

Go to download
/*
 * 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;

/**
 * 
 * Provides information about the location that is configured for storing model artifacts.
 * 
 * 
 * Model artifacts are the output that results from training a model, and typically consist of trained parameters, a
 * model defintion that describes how to compute inferences, and other metadata.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class ModelArtifacts implements SdkPojo, Serializable, ToCopyableBuilder {
    private static final SdkField S3_MODEL_ARTIFACTS_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("S3ModelArtifacts").getter(getter(ModelArtifacts::s3ModelArtifacts))
            .setter(setter(Builder::s3ModelArtifacts))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("S3ModelArtifacts").build()).build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(S3_MODEL_ARTIFACTS_FIELD));

    private static final long serialVersionUID = 1L;

    private final String s3ModelArtifacts;

    private ModelArtifacts(BuilderImpl builder) {
        this.s3ModelArtifacts = builder.s3ModelArtifacts;
    }

    /**
     * 
     * The path of the S3 object that contains the model artifacts. For example,
     * s3://bucket-name/keynameprefix/model.tar.gz.
     * 
     * 
     * @return The path of the S3 object that contains the model artifacts. For example,
     *         s3://bucket-name/keynameprefix/model.tar.gz.
     */
    public final String s3ModelArtifacts() {
        return s3ModelArtifacts;
    }

    @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(s3ModelArtifacts());
        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 ModelArtifacts)) {
            return false;
        }
        ModelArtifacts other = (ModelArtifacts) obj;
        return Objects.equals(s3ModelArtifacts(), other.s3ModelArtifacts());
    }

    /**
     * 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("ModelArtifacts").add("S3ModelArtifacts", s3ModelArtifacts()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "S3ModelArtifacts":
            return Optional.ofNullable(clazz.cast(s3ModelArtifacts()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((ModelArtifacts) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The path of the S3 object that contains the model artifacts. For example,
         * s3://bucket-name/keynameprefix/model.tar.gz.
         * 
         * 
         * @param s3ModelArtifacts
         *        The path of the S3 object that contains the model artifacts. For example,
         *        s3://bucket-name/keynameprefix/model.tar.gz.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder s3ModelArtifacts(String s3ModelArtifacts);
    }

    static final class BuilderImpl implements Builder {
        private String s3ModelArtifacts;

        private BuilderImpl() {
        }

        private BuilderImpl(ModelArtifacts model) {
            s3ModelArtifacts(model.s3ModelArtifacts);
        }

        public final String getS3ModelArtifacts() {
            return s3ModelArtifacts;
        }

        @Override
        public final Builder s3ModelArtifacts(String s3ModelArtifacts) {
            this.s3ModelArtifacts = s3ModelArtifacts;
            return this;
        }

        public final void setS3ModelArtifacts(String s3ModelArtifacts) {
            this.s3ModelArtifacts = s3ModelArtifacts;
        }

        @Override
        public ModelArtifacts build() {
            return new ModelArtifacts(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}