software.amazon.awssdk.services.sagemaker.model.AlgorithmStatusItem Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemaker Show documentation
Show all versions of sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating
with Amazon SageMaker Service
/*
* 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.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.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;
/**
*
* Represents the overall status of an algorithm.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AlgorithmStatusItem implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(AlgorithmStatusItem::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(AlgorithmStatusItem::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField FAILURE_REASON_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FailureReason").getter(getter(AlgorithmStatusItem::failureReason))
.setter(setter(Builder::failureReason))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FailureReason").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, STATUS_FIELD,
FAILURE_REASON_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String name;
private final String status;
private final String failureReason;
private AlgorithmStatusItem(BuilderImpl builder) {
this.name = builder.name;
this.status = builder.status;
this.failureReason = builder.failureReason;
}
/**
*
* The name of the algorithm for which the overall status is being reported.
*
*
* @return The name of the algorithm for which the overall status is being reported.
*/
public final String name() {
return name;
}
/**
*
* The current status.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link DetailedAlgorithmStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The current status.
* @see DetailedAlgorithmStatus
*/
public final DetailedAlgorithmStatus status() {
return DetailedAlgorithmStatus.fromValue(status);
}
/**
*
* The current status.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link DetailedAlgorithmStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The current status.
* @see DetailedAlgorithmStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* if the overall status is Failed, the reason for the failure.
*
*
* @return if the overall status is Failed, the reason for the failure.
*/
public final String failureReason() {
return failureReason;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(failureReason());
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 AlgorithmStatusItem)) {
return false;
}
AlgorithmStatusItem other = (AlgorithmStatusItem) obj;
return Objects.equals(name(), other.name()) && Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(failureReason(), other.failureReason());
}
/**
* 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("AlgorithmStatusItem").add("Name", name()).add("Status", statusAsString())
.add("FailureReason", failureReason()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "FailureReason":
return Optional.ofNullable(clazz.cast(failureReason()));
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("Name", NAME_FIELD);
map.put("Status", STATUS_FIELD);
map.put("FailureReason", FAILURE_REASON_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((AlgorithmStatusItem) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the algorithm for which the overall status is being reported.
*
*
* @param name
* The name of the algorithm for which the overall status is being reported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The current status.
*
*
* @param status
* The current status.
* @see DetailedAlgorithmStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see DetailedAlgorithmStatus
*/
Builder status(String status);
/**
*
* The current status.
*
*
* @param status
* The current status.
* @see DetailedAlgorithmStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see DetailedAlgorithmStatus
*/
Builder status(DetailedAlgorithmStatus status);
/**
*
* if the overall status is Failed, the reason for the failure.
*
*
* @param failureReason
* if the overall status is Failed, the reason for the failure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder failureReason(String failureReason);
}
static final class BuilderImpl implements Builder {
private String name;
private String status;
private String failureReason;
private BuilderImpl() {
}
private BuilderImpl(AlgorithmStatusItem model) {
name(model.name);
status(model.status);
failureReason(model.failureReason);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(DetailedAlgorithmStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getFailureReason() {
return failureReason;
}
public final void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
@Override
public final Builder failureReason(String failureReason) {
this.failureReason = failureReason;
return this;
}
@Override
public AlgorithmStatusItem build() {
return new AlgorithmStatusItem(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy