software.amazon.awssdk.services.elasticache.model.DescribeUpdateActionsRequest Maven / Gradle / Ivy
Show all versions of elasticache 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.elasticache.model;
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 software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeUpdateActionsRequest extends ElastiCacheRequest implements
ToCopyableBuilder {
private static final SdkField SERVICE_UPDATE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServiceUpdateName").getter(getter(DescribeUpdateActionsRequest::serviceUpdateName))
.setter(setter(Builder::serviceUpdateName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceUpdateName").build()).build();
private static final SdkField> REPLICATION_GROUP_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ReplicationGroupIds")
.getter(getter(DescribeUpdateActionsRequest::replicationGroupIds))
.setter(setter(Builder::replicationGroupIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicationGroupIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> CACHE_CLUSTER_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CacheClusterIds")
.getter(getter(DescribeUpdateActionsRequest::cacheClusterIds))
.setter(setter(Builder::cacheClusterIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CacheClusterIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField ENGINE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Engine")
.getter(getter(DescribeUpdateActionsRequest::engine)).setter(setter(Builder::engine))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Engine").build()).build();
private static final SdkField> SERVICE_UPDATE_STATUS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ServiceUpdateStatus")
.getter(getter(DescribeUpdateActionsRequest::serviceUpdateStatusAsStrings))
.setter(setter(Builder::serviceUpdateStatusWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceUpdateStatus").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SERVICE_UPDATE_TIME_RANGE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ServiceUpdateTimeRange")
.getter(getter(DescribeUpdateActionsRequest::serviceUpdateTimeRange)).setter(setter(Builder::serviceUpdateTimeRange))
.constructor(TimeRangeFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceUpdateTimeRange").build())
.build();
private static final SdkField> UPDATE_ACTION_STATUS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("UpdateActionStatus")
.getter(getter(DescribeUpdateActionsRequest::updateActionStatusAsStrings))
.setter(setter(Builder::updateActionStatusWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UpdateActionStatus").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SHOW_NODE_LEVEL_UPDATE_STATUS_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("ShowNodeLevelUpdateStatus")
.getter(getter(DescribeUpdateActionsRequest::showNodeLevelUpdateStatus))
.setter(setter(Builder::showNodeLevelUpdateStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ShowNodeLevelUpdateStatus").build())
.build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeUpdateActionsRequest::maxRecords))
.setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeUpdateActionsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(SERVICE_UPDATE_NAME_FIELD,
REPLICATION_GROUP_IDS_FIELD, CACHE_CLUSTER_IDS_FIELD, ENGINE_FIELD, SERVICE_UPDATE_STATUS_FIELD,
SERVICE_UPDATE_TIME_RANGE_FIELD, UPDATE_ACTION_STATUS_FIELD, SHOW_NODE_LEVEL_UPDATE_STATUS_FIELD, MAX_RECORDS_FIELD,
MARKER_FIELD));
private final String serviceUpdateName;
private final List replicationGroupIds;
private final List cacheClusterIds;
private final String engine;
private final List serviceUpdateStatus;
private final TimeRangeFilter serviceUpdateTimeRange;
private final List updateActionStatus;
private final Boolean showNodeLevelUpdateStatus;
private final Integer maxRecords;
private final String marker;
private DescribeUpdateActionsRequest(BuilderImpl builder) {
super(builder);
this.serviceUpdateName = builder.serviceUpdateName;
this.replicationGroupIds = builder.replicationGroupIds;
this.cacheClusterIds = builder.cacheClusterIds;
this.engine = builder.engine;
this.serviceUpdateStatus = builder.serviceUpdateStatus;
this.serviceUpdateTimeRange = builder.serviceUpdateTimeRange;
this.updateActionStatus = builder.updateActionStatus;
this.showNodeLevelUpdateStatus = builder.showNodeLevelUpdateStatus;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
}
/**
*
* The unique ID of the service update
*
*
* @return The unique ID of the service update
*/
public final String serviceUpdateName() {
return serviceUpdateName;
}
/**
* For responses, this returns true if the service returned a value for the ReplicationGroupIds 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 hasReplicationGroupIds() {
return replicationGroupIds != null && !(replicationGroupIds instanceof SdkAutoConstructList);
}
/**
*
* The replication group IDs
*
*
* 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 #hasReplicationGroupIds} method.
*
*
* @return The replication group IDs
*/
public final List replicationGroupIds() {
return replicationGroupIds;
}
/**
* For responses, this returns true if the service returned a value for the CacheClusterIds 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 hasCacheClusterIds() {
return cacheClusterIds != null && !(cacheClusterIds instanceof SdkAutoConstructList);
}
/**
*
* The cache cluster IDs
*
*
* 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 #hasCacheClusterIds} method.
*
*
* @return The cache cluster IDs
*/
public final List cacheClusterIds() {
return cacheClusterIds;
}
/**
*
* The Elasticache engine to which the update applies. Either Redis or Memcached
*
*
* @return The Elasticache engine to which the update applies. Either Redis or Memcached
*/
public final String engine() {
return engine;
}
/**
*
* The status of the service update
*
*
* 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 #hasServiceUpdateStatus} method.
*
*
* @return The status of the service update
*/
public final List serviceUpdateStatus() {
return ServiceUpdateStatusListCopier.copyStringToEnum(serviceUpdateStatus);
}
/**
* For responses, this returns true if the service returned a value for the ServiceUpdateStatus 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 hasServiceUpdateStatus() {
return serviceUpdateStatus != null && !(serviceUpdateStatus instanceof SdkAutoConstructList);
}
/**
*
* The status of the service update
*
*
* 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 #hasServiceUpdateStatus} method.
*
*
* @return The status of the service update
*/
public final List serviceUpdateStatusAsStrings() {
return serviceUpdateStatus;
}
/**
*
* The range of time specified to search for service updates that are in available status
*
*
* @return The range of time specified to search for service updates that are in available status
*/
public final TimeRangeFilter serviceUpdateTimeRange() {
return serviceUpdateTimeRange;
}
/**
*
* The status of the update action.
*
*
* 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 #hasUpdateActionStatus} method.
*
*
* @return The status of the update action.
*/
public final List updateActionStatus() {
return UpdateActionStatusListCopier.copyStringToEnum(updateActionStatus);
}
/**
* For responses, this returns true if the service returned a value for the UpdateActionStatus 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 hasUpdateActionStatus() {
return updateActionStatus != null && !(updateActionStatus instanceof SdkAutoConstructList);
}
/**
*
* The status of the update action.
*
*
* 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 #hasUpdateActionStatus} method.
*
*
* @return The status of the update action.
*/
public final List updateActionStatusAsStrings() {
return updateActionStatus;
}
/**
*
* Dictates whether to include node level update status in the response
*
*
* @return Dictates whether to include node level update status in the response
*/
public final Boolean showNodeLevelUpdateStatus() {
return showNodeLevelUpdateStatus;
}
/**
*
* The maximum number of records to include in the response
*
*
* @return The maximum number of records to include in the response
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
* If this parameter is specified, the response includes only records beyond the marker, up to the value specified
* by MaxRecords
.
*
*
* @return An optional marker returned from a prior request. Use this marker for pagination of results from this
* operation. If this parameter is specified, the response includes only records beyond the marker, up to
* the value specified by MaxRecords
.
*/
public final String marker() {
return marker;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(serviceUpdateName());
hashCode = 31 * hashCode + Objects.hashCode(hasReplicationGroupIds() ? replicationGroupIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasCacheClusterIds() ? cacheClusterIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(engine());
hashCode = 31 * hashCode + Objects.hashCode(hasServiceUpdateStatus() ? serviceUpdateStatusAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(serviceUpdateTimeRange());
hashCode = 31 * hashCode + Objects.hashCode(hasUpdateActionStatus() ? updateActionStatusAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(showNodeLevelUpdateStatus());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
hashCode = 31 * hashCode + Objects.hashCode(marker());
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 DescribeUpdateActionsRequest)) {
return false;
}
DescribeUpdateActionsRequest other = (DescribeUpdateActionsRequest) obj;
return Objects.equals(serviceUpdateName(), other.serviceUpdateName())
&& hasReplicationGroupIds() == other.hasReplicationGroupIds()
&& Objects.equals(replicationGroupIds(), other.replicationGroupIds())
&& hasCacheClusterIds() == other.hasCacheClusterIds()
&& Objects.equals(cacheClusterIds(), other.cacheClusterIds()) && Objects.equals(engine(), other.engine())
&& hasServiceUpdateStatus() == other.hasServiceUpdateStatus()
&& Objects.equals(serviceUpdateStatusAsStrings(), other.serviceUpdateStatusAsStrings())
&& Objects.equals(serviceUpdateTimeRange(), other.serviceUpdateTimeRange())
&& hasUpdateActionStatus() == other.hasUpdateActionStatus()
&& Objects.equals(updateActionStatusAsStrings(), other.updateActionStatusAsStrings())
&& Objects.equals(showNodeLevelUpdateStatus(), other.showNodeLevelUpdateStatus())
&& Objects.equals(maxRecords(), other.maxRecords()) && Objects.equals(marker(), other.marker());
}
/**
* 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("DescribeUpdateActionsRequest").add("ServiceUpdateName", serviceUpdateName())
.add("ReplicationGroupIds", hasReplicationGroupIds() ? replicationGroupIds() : null)
.add("CacheClusterIds", hasCacheClusterIds() ? cacheClusterIds() : null).add("Engine", engine())
.add("ServiceUpdateStatus", hasServiceUpdateStatus() ? serviceUpdateStatusAsStrings() : null)
.add("ServiceUpdateTimeRange", serviceUpdateTimeRange())
.add("UpdateActionStatus", hasUpdateActionStatus() ? updateActionStatusAsStrings() : null)
.add("ShowNodeLevelUpdateStatus", showNodeLevelUpdateStatus()).add("MaxRecords", maxRecords())
.add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ServiceUpdateName":
return Optional.ofNullable(clazz.cast(serviceUpdateName()));
case "ReplicationGroupIds":
return Optional.ofNullable(clazz.cast(replicationGroupIds()));
case "CacheClusterIds":
return Optional.ofNullable(clazz.cast(cacheClusterIds()));
case "Engine":
return Optional.ofNullable(clazz.cast(engine()));
case "ServiceUpdateStatus":
return Optional.ofNullable(clazz.cast(serviceUpdateStatusAsStrings()));
case "ServiceUpdateTimeRange":
return Optional.ofNullable(clazz.cast(serviceUpdateTimeRange()));
case "UpdateActionStatus":
return Optional.ofNullable(clazz.cast(updateActionStatusAsStrings()));
case "ShowNodeLevelUpdateStatus":
return Optional.ofNullable(clazz.cast(showNodeLevelUpdateStatus()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function