software.amazon.awssdk.services.sagemaker.model.ProcessingOutputConfig 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.io.Serializable;
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;
/**
*
* Configuration for uploading output from the processing container.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ProcessingOutputConfig implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> OUTPUTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Outputs")
.getter(getter(ProcessingOutputConfig::outputs))
.setter(setter(Builder::outputs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Outputs").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ProcessingOutput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KmsKeyId").getter(getter(ProcessingOutputConfig::kmsKeyId)).setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKeyId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OUTPUTS_FIELD,
KMS_KEY_ID_FIELD));
private static final long serialVersionUID = 1L;
private final List outputs;
private final String kmsKeyId;
private ProcessingOutputConfig(BuilderImpl builder) {
this.outputs = builder.outputs;
this.kmsKeyId = builder.kmsKeyId;
}
/**
* For responses, this returns true if the service returned a value for the Outputs 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 hasOutputs() {
return outputs != null && !(outputs instanceof SdkAutoConstructList);
}
/**
*
* An array of outputs configuring the data to upload from the processing container.
*
*
* 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 #hasOutputs} method.
*
*
* @return An array of outputs configuring the data to upload from the processing container.
*/
public final List outputs() {
return outputs;
}
/**
*
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to
* encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a
* KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
*
*
* @return The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses
* to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key,
* alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
*/
public final String kmsKeyId() {
return kmsKeyId;
}
@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(hasOutputs() ? outputs() : null);
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
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 ProcessingOutputConfig)) {
return false;
}
ProcessingOutputConfig other = (ProcessingOutputConfig) obj;
return hasOutputs() == other.hasOutputs() && Objects.equals(outputs(), other.outputs())
&& Objects.equals(kmsKeyId(), other.kmsKeyId());
}
/**
* 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("ProcessingOutputConfig").add("Outputs", hasOutputs() ? outputs() : null)
.add("KmsKeyId", kmsKeyId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Outputs":
return Optional.ofNullable(clazz.cast(outputs()));
case "KmsKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ProcessingOutputConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An array of outputs configuring the data to upload from the processing container.
*
*
* @param outputs
* An array of outputs configuring the data to upload from the processing container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputs(Collection outputs);
/**
*
* An array of outputs configuring the data to upload from the processing container.
*
*
* @param outputs
* An array of outputs configuring the data to upload from the processing container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputs(ProcessingOutput... outputs);
/**
*
* An array of outputs configuring the data to upload from the processing container.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.sagemaker.model.ProcessingOutput.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.sagemaker.model.ProcessingOutput#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.sagemaker.model.ProcessingOutput.Builder#build()} is called
* immediately and its result is passed to {@link #outputs(List)}.
*
* @param outputs
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.sagemaker.model.ProcessingOutput.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #outputs(java.util.Collection)
*/
Builder outputs(Consumer... outputs);
/**
*
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to
* encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias
* of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.
*
*
* @param kmsKeyId
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker
* uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a
* KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all
* outputs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
}
static final class BuilderImpl implements Builder {
private List outputs = DefaultSdkAutoConstructList.getInstance();
private String kmsKeyId;
private BuilderImpl() {
}
private BuilderImpl(ProcessingOutputConfig model) {
outputs(model.outputs);
kmsKeyId(model.kmsKeyId);
}
public final List getOutputs() {
List result = ProcessingOutputsCopier.copyToBuilder(this.outputs);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOutputs(Collection outputs) {
this.outputs = ProcessingOutputsCopier.copyFromBuilder(outputs);
}
@Override
public final Builder outputs(Collection outputs) {
this.outputs = ProcessingOutputsCopier.copy(outputs);
return this;
}
@Override
@SafeVarargs
public final Builder outputs(ProcessingOutput... outputs) {
outputs(Arrays.asList(outputs));
return this;
}
@Override
@SafeVarargs
public final Builder outputs(Consumer... outputs) {
outputs(Stream.of(outputs).map(c -> ProcessingOutput.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getKmsKeyId() {
return kmsKeyId;
}
public final void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
@Override
public final Builder kmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
return this;
}
@Override
public ProcessingOutputConfig build() {
return new ProcessingOutputConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}