software.amazon.awssdk.services.sagemakerruntime.model.PayloadPart Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemakerruntime Show documentation
The AWS Java SDK for SageMaker Runtime module holds the client classes that are used for communicating with SageMaker Runtime.
There is a newer version: 2.29.39
Show newest version
/*
 * 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.sagemakerruntime.model;

import java.io.Serializable;
import java.nio.ByteBuffer;
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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkBytes;
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.core.traits.PayloadTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * A wrapper for pieces of the payload that's returned in response to a streaming inference request. A streaming
 * inference response consists of one or more payload parts.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public class PayloadPart implements SdkPojo, Serializable, ToCopyableBuilder, ResponseStream {
    private static final SdkField BYTES_FIELD = SdkField
            . builder(MarshallingType.SDK_BYTES)
            .memberName("Bytes")
            .getter(getter(PayloadPart::bytes))
            .setter(setter(Builder::bytes))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Bytes").build(),
                    PayloadTrait.create()).build();

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

    private static final long serialVersionUID = 1L;

    private final SdkBytes bytes;

    protected PayloadPart(BuilderImpl builder) {
        this.bytes = builder.bytes;
    }

    /**
     * 
     * A blob that contains part of the response for your streaming inference request.
     * 
     * 
     * @return A blob that contains part of the response for your streaming inference request.
     */
    public final SdkBytes bytes() {
        return bytes;
    }

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

    /**
     * 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("PayloadPart").add("Bytes", bytes() == null ? null : "*** Sensitive Data Redacted ***").build();
    }

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

    @Override
    public final PayloadPart copy(Consumer modifier) {
        return ToCopyableBuilder.super.copy(modifier);
    }

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

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

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

    /**
     * Calls the appropriate visit method depending on the subtype of {@link PayloadPart}.
     *
     * @param visitor
     *        Visitor to invoke.
     */
    @Override
    public void accept(InvokeEndpointWithResponseStreamResponseHandler.Visitor visitor) {
        throw new UnsupportedOperationException();
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * A blob that contains part of the response for your streaming inference request.
         * 
         * 
         * @param bytes
         *        A blob that contains part of the response for your streaming inference request.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder bytes(SdkBytes bytes);
    }

    protected static class BuilderImpl implements Builder {
        private SdkBytes bytes;

        protected BuilderImpl() {
        }

        protected BuilderImpl(PayloadPart model) {
            bytes(model.bytes);
        }

        public final ByteBuffer getBytes() {
            return bytes == null ? null : bytes.asByteBuffer();
        }

        public final void setBytes(ByteBuffer bytes) {
            bytes(bytes == null ? null : SdkBytes.fromByteBuffer(bytes));
        }

        @Override
        public final Builder bytes(SdkBytes bytes) {
            this.bytes = bytes;
            return this;
        }

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

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