software.amazon.awssdk.services.sagemakergeospatial.model.ExportEarthObservationJobResponse Maven / Gradle / Ivy
Show all versions of sagemakergeospatial 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.sagemakergeospatial.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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.TimestampFormatTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ExportEarthObservationJobResponse extends SageMakerGeospatialResponse implements
ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(ExportEarthObservationJobResponse::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("CreationTime")
.getter(getter(ExportEarthObservationJobResponse::creationTime))
.setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField EXECUTION_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExecutionRoleArn").getter(getter(ExportEarthObservationJobResponse::executionRoleArn))
.setter(setter(Builder::executionRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExecutionRoleArn").build()).build();
private static final SdkField EXPORT_SOURCE_IMAGES_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ExportSourceImages").getter(getter(ExportEarthObservationJobResponse::exportSourceImages))
.setter(setter(Builder::exportSourceImages))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExportSourceImages").build())
.build();
private static final SdkField EXPORT_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExportStatus").getter(getter(ExportEarthObservationJobResponse::exportStatusAsString))
.setter(setter(Builder::exportStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExportStatus").build()).build();
private static final SdkField OUTPUT_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OutputConfig")
.getter(getter(ExportEarthObservationJobResponse::outputConfig)).setter(setter(Builder::outputConfig))
.constructor(OutputConfigInput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputConfig").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD,
CREATION_TIME_FIELD, EXECUTION_ROLE_ARN_FIELD, EXPORT_SOURCE_IMAGES_FIELD, EXPORT_STATUS_FIELD, OUTPUT_CONFIG_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String arn;
private final Instant creationTime;
private final String executionRoleArn;
private final Boolean exportSourceImages;
private final String exportStatus;
private final OutputConfigInput outputConfig;
private ExportEarthObservationJobResponse(BuilderImpl builder) {
super(builder);
this.arn = builder.arn;
this.creationTime = builder.creationTime;
this.executionRoleArn = builder.executionRoleArn;
this.exportSourceImages = builder.exportSourceImages;
this.exportStatus = builder.exportStatus;
this.outputConfig = builder.outputConfig;
}
/**
*
* The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
*
*
* @return The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
*/
public final String arn() {
return arn;
}
/**
*
* The creation time.
*
*
* @return The creation time.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
*/
public final String executionRoleArn() {
return executionRoleArn;
}
/**
*
* The source images provided to the Earth Observation job being exported.
*
*
* @return The source images provided to the Earth Observation job being exported.
*/
public final Boolean exportSourceImages() {
return exportSourceImages;
}
/**
*
* The status of the results of the Earth Observation job being exported.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #exportStatus} will
* return {@link EarthObservationJobExportStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #exportStatusAsString}.
*
*
* @return The status of the results of the Earth Observation job being exported.
* @see EarthObservationJobExportStatus
*/
public final EarthObservationJobExportStatus exportStatus() {
return EarthObservationJobExportStatus.fromValue(exportStatus);
}
/**
*
* The status of the results of the Earth Observation job being exported.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #exportStatus} will
* return {@link EarthObservationJobExportStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #exportStatusAsString}.
*
*
* @return The status of the results of the Earth Observation job being exported.
* @see EarthObservationJobExportStatus
*/
public final String exportStatusAsString() {
return exportStatus;
}
/**
*
* An object containing information about the output file.
*
*
* @return An object containing information about the output file.
*/
public final OutputConfigInput outputConfig() {
return outputConfig;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(executionRoleArn());
hashCode = 31 * hashCode + Objects.hashCode(exportSourceImages());
hashCode = 31 * hashCode + Objects.hashCode(exportStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(outputConfig());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ExportEarthObservationJobResponse)) {
return false;
}
ExportEarthObservationJobResponse other = (ExportEarthObservationJobResponse) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(creationTime(), other.creationTime())
&& Objects.equals(executionRoleArn(), other.executionRoleArn())
&& Objects.equals(exportSourceImages(), other.exportSourceImages())
&& Objects.equals(exportStatusAsString(), other.exportStatusAsString())
&& Objects.equals(outputConfig(), other.outputConfig());
}
/**
* 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("ExportEarthObservationJobResponse").add("Arn", arn()).add("CreationTime", creationTime())
.add("ExecutionRoleArn", executionRoleArn()).add("ExportSourceImages", exportSourceImages())
.add("ExportStatus", exportStatusAsString()).add("OutputConfig", outputConfig()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "ExecutionRoleArn":
return Optional.ofNullable(clazz.cast(executionRoleArn()));
case "ExportSourceImages":
return Optional.ofNullable(clazz.cast(exportSourceImages()));
case "ExportStatus":
return Optional.ofNullable(clazz.cast(exportStatusAsString()));
case "OutputConfig":
return Optional.ofNullable(clazz.cast(outputConfig()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Arn", ARN_FIELD);
map.put("CreationTime", CREATION_TIME_FIELD);
map.put("ExecutionRoleArn", EXECUTION_ROLE_ARN_FIELD);
map.put("ExportSourceImages", EXPORT_SOURCE_IMAGES_FIELD);
map.put("ExportStatus", EXPORT_STATUS_FIELD);
map.put("OutputConfig", OUTPUT_CONFIG_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ExportEarthObservationJobResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerGeospatialResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
*
*
* @param arn
* The output Amazon Resource Name (ARN) of the Earth Observation job being exported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The creation time.
*
*
* @param creationTime
* The creation time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
*
*
* @param executionRoleArn
* The Amazon Resource Name (ARN) of the IAM role that you specified for the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder executionRoleArn(String executionRoleArn);
/**
*
* The source images provided to the Earth Observation job being exported.
*
*
* @param exportSourceImages
* The source images provided to the Earth Observation job being exported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder exportSourceImages(Boolean exportSourceImages);
/**
*
* The status of the results of the Earth Observation job being exported.
*
*
* @param exportStatus
* The status of the results of the Earth Observation job being exported.
* @see EarthObservationJobExportStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see EarthObservationJobExportStatus
*/
Builder exportStatus(String exportStatus);
/**
*
* The status of the results of the Earth Observation job being exported.
*
*
* @param exportStatus
* The status of the results of the Earth Observation job being exported.
* @see EarthObservationJobExportStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see EarthObservationJobExportStatus
*/
Builder exportStatus(EarthObservationJobExportStatus exportStatus);
/**
*
* An object containing information about the output file.
*
*
* @param outputConfig
* An object containing information about the output file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputConfig(OutputConfigInput outputConfig);
/**
*
* An object containing information about the output file.
*
* This is a convenience method that creates an instance of the {@link OutputConfigInput.Builder} avoiding the
* need to create one manually via {@link OutputConfigInput#builder()}.
*
*
* When the {@link Consumer} completes, {@link OutputConfigInput.Builder#build()} is called immediately and its
* result is passed to {@link #outputConfig(OutputConfigInput)}.
*
* @param outputConfig
* a consumer that will call methods on {@link OutputConfigInput.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #outputConfig(OutputConfigInput)
*/
default Builder outputConfig(Consumer outputConfig) {
return outputConfig(OutputConfigInput.builder().applyMutation(outputConfig).build());
}
}
static final class BuilderImpl extends SageMakerGeospatialResponse.BuilderImpl implements Builder {
private String arn;
private Instant creationTime;
private String executionRoleArn;
private Boolean exportSourceImages;
private String exportStatus;
private OutputConfigInput outputConfig;
private BuilderImpl() {
}
private BuilderImpl(ExportEarthObservationJobResponse model) {
super(model);
arn(model.arn);
creationTime(model.creationTime);
executionRoleArn(model.executionRoleArn);
exportSourceImages(model.exportSourceImages);
exportStatus(model.exportStatus);
outputConfig(model.outputConfig);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final Instant getCreationTime() {
return creationTime;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final String getExecutionRoleArn() {
return executionRoleArn;
}
public final void setExecutionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
}
@Override
public final Builder executionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
return this;
}
public final Boolean getExportSourceImages() {
return exportSourceImages;
}
public final void setExportSourceImages(Boolean exportSourceImages) {
this.exportSourceImages = exportSourceImages;
}
@Override
public final Builder exportSourceImages(Boolean exportSourceImages) {
this.exportSourceImages = exportSourceImages;
return this;
}
public final String getExportStatus() {
return exportStatus;
}
public final void setExportStatus(String exportStatus) {
this.exportStatus = exportStatus;
}
@Override
public final Builder exportStatus(String exportStatus) {
this.exportStatus = exportStatus;
return this;
}
@Override
public final Builder exportStatus(EarthObservationJobExportStatus exportStatus) {
this.exportStatus(exportStatus == null ? null : exportStatus.toString());
return this;
}
public final OutputConfigInput.Builder getOutputConfig() {
return outputConfig != null ? outputConfig.toBuilder() : null;
}
public final void setOutputConfig(OutputConfigInput.BuilderImpl outputConfig) {
this.outputConfig = outputConfig != null ? outputConfig.build() : null;
}
@Override
public final Builder outputConfig(OutputConfigInput outputConfig) {
this.outputConfig = outputConfig;
return this;
}
@Override
public ExportEarthObservationJobResponse build() {
return new ExportEarthObservationJobResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}