software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest Maven / Gradle / Ivy
Show all versions of autoscaling 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.autoscaling.model;
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 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 DescribeScheduledActionsRequest extends AutoScalingRequest implements
ToCopyableBuilder {
private static final SdkField AUTO_SCALING_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AutoScalingGroupName").getter(getter(DescribeScheduledActionsRequest::autoScalingGroupName))
.setter(setter(Builder::autoScalingGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AutoScalingGroupName").build())
.build();
private static final SdkField> SCHEDULED_ACTION_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ScheduledActionNames")
.getter(getter(DescribeScheduledActionsRequest::scheduledActionNames))
.setter(setter(Builder::scheduledActionNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScheduledActionNames").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 START_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("StartTime").getter(getter(DescribeScheduledActionsRequest::startTime))
.setter(setter(Builder::startTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartTime").build()).build();
private static final SdkField END_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("EndTime").getter(getter(DescribeScheduledActionsRequest::endTime)).setter(setter(Builder::endTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndTime").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeScheduledActionsRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeScheduledActionsRequest::maxRecords))
.setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTO_SCALING_GROUP_NAME_FIELD,
SCHEDULED_ACTION_NAMES_FIELD, START_TIME_FIELD, END_TIME_FIELD, NEXT_TOKEN_FIELD, MAX_RECORDS_FIELD));
private final String autoScalingGroupName;
private final List scheduledActionNames;
private final Instant startTime;
private final Instant endTime;
private final String nextToken;
private final Integer maxRecords;
private DescribeScheduledActionsRequest(BuilderImpl builder) {
super(builder);
this.autoScalingGroupName = builder.autoScalingGroupName;
this.scheduledActionNames = builder.scheduledActionNames;
this.startTime = builder.startTime;
this.endTime = builder.endTime;
this.nextToken = builder.nextToken;
this.maxRecords = builder.maxRecords;
}
/**
*
* The name of the Auto Scaling group.
*
*
* @return The name of the Auto Scaling group.
*/
public final String autoScalingGroupName() {
return autoScalingGroupName;
}
/**
* For responses, this returns true if the service returned a value for the ScheduledActionNames 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 hasScheduledActionNames() {
return scheduledActionNames != null && !(scheduledActionNames instanceof SdkAutoConstructList);
}
/**
*
* The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If
* you specify an unknown scheduled action, it is ignored with no error.
*
*
* Array Members: Maximum number of 50 actions.
*
*
* 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 #hasScheduledActionNames} method.
*
*
* @return The names of one or more scheduled actions. If you omit this property, all scheduled actions are
* described. If you specify an unknown scheduled action, it is ignored with no error.
*
* Array Members: Maximum number of 50 actions.
*/
public final List scheduledActionNames() {
return scheduledActionNames;
}
/**
*
* The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored.
*
*
* @return The earliest scheduled start time to return. If scheduled action names are provided, this property is
* ignored.
*/
public final Instant startTime() {
return startTime;
}
/**
*
* The latest scheduled start time to return. If scheduled action names are provided, this property is ignored.
*
*
* @return The latest scheduled start time to return. If scheduled action names are provided, this property is
* ignored.
*/
public final Instant endTime() {
return endTime;
}
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @return The token for the next set of items to return. (You received this token from a previous call.)
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of items to return with this call. The default value is 50 and the maximum value
* is 100.
*
*
* @return The maximum number of items to return with this call. The default value is 50 and the
* maximum value is 100.
*/
public final Integer maxRecords() {
return maxRecords;
}
@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(autoScalingGroupName());
hashCode = 31 * hashCode + Objects.hashCode(hasScheduledActionNames() ? scheduledActionNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(startTime());
hashCode = 31 * hashCode + Objects.hashCode(endTime());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
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 DescribeScheduledActionsRequest)) {
return false;
}
DescribeScheduledActionsRequest other = (DescribeScheduledActionsRequest) obj;
return Objects.equals(autoScalingGroupName(), other.autoScalingGroupName())
&& hasScheduledActionNames() == other.hasScheduledActionNames()
&& Objects.equals(scheduledActionNames(), other.scheduledActionNames())
&& Objects.equals(startTime(), other.startTime()) && Objects.equals(endTime(), other.endTime())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxRecords(), other.maxRecords());
}
/**
* 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("DescribeScheduledActionsRequest").add("AutoScalingGroupName", autoScalingGroupName())
.add("ScheduledActionNames", hasScheduledActionNames() ? scheduledActionNames() : null)
.add("StartTime", startTime()).add("EndTime", endTime()).add("NextToken", nextToken())
.add("MaxRecords", maxRecords()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AutoScalingGroupName":
return Optional.ofNullable(clazz.cast(autoScalingGroupName()));
case "ScheduledActionNames":
return Optional.ofNullable(clazz.cast(scheduledActionNames()));
case "StartTime":
return Optional.ofNullable(clazz.cast(startTime()));
case "EndTime":
return Optional.ofNullable(clazz.cast(endTime()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeScheduledActionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AutoScalingRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The name of the Auto Scaling group.
*
*
* @param autoScalingGroupName
* The name of the Auto Scaling group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder autoScalingGroupName(String autoScalingGroupName);
/**
*
* The names of one or more scheduled actions. If you omit this property, all scheduled actions are described.
* If you specify an unknown scheduled action, it is ignored with no error.
*
*
* Array Members: Maximum number of 50 actions.
*
*
* @param scheduledActionNames
* The names of one or more scheduled actions. If you omit this property, all scheduled actions are
* described. If you specify an unknown scheduled action, it is ignored with no error.
*
* Array Members: Maximum number of 50 actions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scheduledActionNames(Collection scheduledActionNames);
/**
*
* The names of one or more scheduled actions. If you omit this property, all scheduled actions are described.
* If you specify an unknown scheduled action, it is ignored with no error.
*
*
* Array Members: Maximum number of 50 actions.
*
*
* @param scheduledActionNames
* The names of one or more scheduled actions. If you omit this property, all scheduled actions are
* described. If you specify an unknown scheduled action, it is ignored with no error.
*
* Array Members: Maximum number of 50 actions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scheduledActionNames(String... scheduledActionNames);
/**
*
* The earliest scheduled start time to return. If scheduled action names are provided, this property is
* ignored.
*
*
* @param startTime
* The earliest scheduled start time to return. If scheduled action names are provided, this property is
* ignored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startTime(Instant startTime);
/**
*
* The latest scheduled start time to return. If scheduled action names are provided, this property is ignored.
*
*
* @param endTime
* The latest scheduled start time to return. If scheduled action names are provided, this property is
* ignored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endTime(Instant endTime);
/**
*
* The token for the next set of items to return. (You received this token from a previous call.)
*
*
* @param nextToken
* The token for the next set of items to return. (You received this token from a previous call.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of items to return with this call. The default value is 50 and the maximum
* value is 100.
*
*
* @param maxRecords
* The maximum number of items to return with this call. The default value is 50 and the
* maximum value is 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRecords(Integer maxRecords);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AutoScalingRequest.BuilderImpl implements Builder {
private String autoScalingGroupName;
private List scheduledActionNames = DefaultSdkAutoConstructList.getInstance();
private Instant startTime;
private Instant endTime;
private String nextToken;
private Integer maxRecords;
private BuilderImpl() {
}
private BuilderImpl(DescribeScheduledActionsRequest model) {
super(model);
autoScalingGroupName(model.autoScalingGroupName);
scheduledActionNames(model.scheduledActionNames);
startTime(model.startTime);
endTime(model.endTime);
nextToken(model.nextToken);
maxRecords(model.maxRecords);
}
public final String getAutoScalingGroupName() {
return autoScalingGroupName;
}
public final void setAutoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
}
@Override
public final Builder autoScalingGroupName(String autoScalingGroupName) {
this.autoScalingGroupName = autoScalingGroupName;
return this;
}
public final Collection getScheduledActionNames() {
if (scheduledActionNames instanceof SdkAutoConstructList) {
return null;
}
return scheduledActionNames;
}
public final void setScheduledActionNames(Collection scheduledActionNames) {
this.scheduledActionNames = ScheduledActionNamesCopier.copy(scheduledActionNames);
}
@Override
public final Builder scheduledActionNames(Collection scheduledActionNames) {
this.scheduledActionNames = ScheduledActionNamesCopier.copy(scheduledActionNames);
return this;
}
@Override
@SafeVarargs
public final Builder scheduledActionNames(String... scheduledActionNames) {
scheduledActionNames(Arrays.asList(scheduledActionNames));
return this;
}
public final Instant getStartTime() {
return startTime;
}
public final void setStartTime(Instant startTime) {
this.startTime = startTime;
}
@Override
public final Builder startTime(Instant startTime) {
this.startTime = startTime;
return this;
}
public final Instant getEndTime() {
return endTime;
}
public final void setEndTime(Instant endTime) {
this.endTime = endTime;
}
@Override
public final Builder endTime(Instant endTime) {
this.endTime = endTime;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxRecords() {
return maxRecords;
}
public final void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
@Override
public final Builder maxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeScheduledActionsRequest build() {
return new DescribeScheduledActionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}