software.amazon.awssdk.services.elasticsearch.model.UpgradeHistory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
The AWS Java SDK for Amazon Elasticsearch Service module holds the client classes that are used for
communicating with Amazon Elasticsearch 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.elasticsearch.model;
import java.io.Serializable;
import java.time.Instant;
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;
/**
*
* History of the last 10 Upgrades and Upgrade Eligibility Checks.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpgradeHistory implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField UPGRADE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UpgradeName").getter(getter(UpgradeHistory::upgradeName)).setter(setter(Builder::upgradeName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpgradeName").build()).build();
private static final SdkField START_TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("StartTimestamp").getter(getter(UpgradeHistory::startTimestamp)).setter(setter(Builder::startTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartTimestamp").build()).build();
private static final SdkField UPGRADE_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UpgradeStatus").getter(getter(UpgradeHistory::upgradeStatusAsString))
.setter(setter(Builder::upgradeStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpgradeStatus").build()).build();
private static final SdkField> STEPS_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("StepsList")
.getter(getter(UpgradeHistory::stepsList))
.setter(setter(Builder::stepsList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StepsList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(UpgradeStepItem::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(UPGRADE_NAME_FIELD,
START_TIMESTAMP_FIELD, UPGRADE_STATUS_FIELD, STEPS_LIST_FIELD));
private static final long serialVersionUID = 1L;
private final String upgradeName;
private final Instant startTimestamp;
private final String upgradeStatus;
private final List stepsList;
private UpgradeHistory(BuilderImpl builder) {
this.upgradeName = builder.upgradeName;
this.startTimestamp = builder.startTimestamp;
this.upgradeStatus = builder.upgradeStatus;
this.stepsList = builder.stepsList;
}
/**
*
* A string that describes the update briefly
*
*
* @return A string that describes the update briefly
*/
public String upgradeName() {
return upgradeName;
}
/**
*
* UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
*
*
* @return UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
*/
public Instant startTimestamp() {
return startTimestamp;
}
/**
*
* The overall status of the update. The status can take one of the following values:
*
* - In Progress
* - Succeeded
* - Succeeded with Issues
* - Failed
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #upgradeStatus}
* will return {@link UpgradeStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #upgradeStatusAsString}.
*
*
* @return The overall status of the update. The status can take one of the following values:
*
* - In Progress
* - Succeeded
* - Succeeded with Issues
* - Failed
*
* @see UpgradeStatus
*/
public UpgradeStatus upgradeStatus() {
return UpgradeStatus.fromValue(upgradeStatus);
}
/**
*
* The overall status of the update. The status can take one of the following values:
*
* - In Progress
* - Succeeded
* - Succeeded with Issues
* - Failed
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #upgradeStatus}
* will return {@link UpgradeStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #upgradeStatusAsString}.
*
*
* @return The overall status of the update. The status can take one of the following values:
*
* - In Progress
* - Succeeded
* - Succeeded with Issues
* - Failed
*
* @see UpgradeStatus
*/
public String upgradeStatusAsString() {
return upgradeStatus;
}
/**
* Returns true if the StepsList property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasStepsList() {
return stepsList != null && !(stepsList instanceof SdkAutoConstructList);
}
/**
*
* A list of UpgradeStepItem s representing information about each step performed as pard of a
* specific Upgrade or Upgrade Eligibility Check.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasStepsList()} to see if a value was sent in this field.
*
*
* @return A list of UpgradeStepItem s representing information about each step performed as
* pard of a specific Upgrade or Upgrade Eligibility Check.
*/
public List stepsList() {
return stepsList;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(upgradeName());
hashCode = 31 * hashCode + Objects.hashCode(startTimestamp());
hashCode = 31 * hashCode + Objects.hashCode(upgradeStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(stepsList());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpgradeHistory)) {
return false;
}
UpgradeHistory other = (UpgradeHistory) obj;
return Objects.equals(upgradeName(), other.upgradeName()) && Objects.equals(startTimestamp(), other.startTimestamp())
&& Objects.equals(upgradeStatusAsString(), other.upgradeStatusAsString())
&& Objects.equals(stepsList(), other.stepsList());
}
/**
* 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 String toString() {
return ToString.builder("UpgradeHistory").add("UpgradeName", upgradeName()).add("StartTimestamp", startTimestamp())
.add("UpgradeStatus", upgradeStatusAsString()).add("StepsList", stepsList()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "UpgradeName":
return Optional.ofNullable(clazz.cast(upgradeName()));
case "StartTimestamp":
return Optional.ofNullable(clazz.cast(startTimestamp()));
case "UpgradeStatus":
return Optional.ofNullable(clazz.cast(upgradeStatusAsString()));
case "StepsList":
return Optional.ofNullable(clazz.cast(stepsList()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpgradeHistory) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A string that describes the update briefly
*
*
* @param upgradeName
* A string that describes the update briefly
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder upgradeName(String upgradeName);
/**
*
* UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
*
*
* @param startTimestamp
* UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startTimestamp(Instant startTimestamp);
/**
*
* The overall status of the update. The status can take one of the following values:
*
* - In Progress
* - Succeeded
* - Succeeded with Issues
* - Failed
*
*
*
* @param upgradeStatus
* The overall status of the update. The status can take one of the following values:
*
* - In Progress
* - Succeeded
* - Succeeded with Issues
* - Failed
*
* @see UpgradeStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see UpgradeStatus
*/
Builder upgradeStatus(String upgradeStatus);
/**
*
* The overall status of the update. The status can take one of the following values:
*
* - In Progress
* - Succeeded
* - Succeeded with Issues
* - Failed
*
*
*
* @param upgradeStatus
* The overall status of the update. The status can take one of the following values:
*
* - In Progress
* - Succeeded
* - Succeeded with Issues
* - Failed
*
* @see UpgradeStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see UpgradeStatus
*/
Builder upgradeStatus(UpgradeStatus upgradeStatus);
/**
*
* A list of UpgradeStepItem s representing information about each step performed as pard
* of a specific Upgrade or Upgrade Eligibility Check.
*
*
* @param stepsList
* A list of UpgradeStepItem s representing information about each step performed
* as pard of a specific Upgrade or Upgrade Eligibility Check.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stepsList(Collection stepsList);
/**
*
* A list of UpgradeStepItem s representing information about each step performed as pard
* of a specific Upgrade or Upgrade Eligibility Check.
*
*
* @param stepsList
* A list of UpgradeStepItem s representing information about each step performed
* as pard of a specific Upgrade or Upgrade Eligibility Check.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stepsList(UpgradeStepItem... stepsList);
/**
*
* A list of UpgradeStepItem s representing information about each step performed as pard
* of a specific Upgrade or Upgrade Eligibility Check.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #stepsList(List)}.
*
* @param stepsList
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #stepsList(List)
*/
Builder stepsList(Consumer... stepsList);
}
static final class BuilderImpl implements Builder {
private String upgradeName;
private Instant startTimestamp;
private String upgradeStatus;
private List stepsList = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpgradeHistory model) {
upgradeName(model.upgradeName);
startTimestamp(model.startTimestamp);
upgradeStatus(model.upgradeStatus);
stepsList(model.stepsList);
}
public final String getUpgradeName() {
return upgradeName;
}
@Override
public final Builder upgradeName(String upgradeName) {
this.upgradeName = upgradeName;
return this;
}
public final void setUpgradeName(String upgradeName) {
this.upgradeName = upgradeName;
}
public final Instant getStartTimestamp() {
return startTimestamp;
}
@Override
public final Builder startTimestamp(Instant startTimestamp) {
this.startTimestamp = startTimestamp;
return this;
}
public final void setStartTimestamp(Instant startTimestamp) {
this.startTimestamp = startTimestamp;
}
public final String getUpgradeStatus() {
return upgradeStatus;
}
@Override
public final Builder upgradeStatus(String upgradeStatus) {
this.upgradeStatus = upgradeStatus;
return this;
}
@Override
public final Builder upgradeStatus(UpgradeStatus upgradeStatus) {
this.upgradeStatus(upgradeStatus == null ? null : upgradeStatus.toString());
return this;
}
public final void setUpgradeStatus(String upgradeStatus) {
this.upgradeStatus = upgradeStatus;
}
public final Collection getStepsList() {
return stepsList != null ? stepsList.stream().map(UpgradeStepItem::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder stepsList(Collection stepsList) {
this.stepsList = UpgradeStepsListCopier.copy(stepsList);
return this;
}
@Override
@SafeVarargs
public final Builder stepsList(UpgradeStepItem... stepsList) {
stepsList(Arrays.asList(stepsList));
return this;
}
@Override
@SafeVarargs
public final Builder stepsList(Consumer... stepsList) {
stepsList(Stream.of(stepsList).map(c -> UpgradeStepItem.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setStepsList(Collection stepsList) {
this.stepsList = UpgradeStepsListCopier.copyFromBuilder(stepsList);
}
@Override
public UpgradeHistory build() {
return new UpgradeHistory(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy