software.amazon.awssdk.services.redshift.model.DescribeScheduledActionsRequest Maven / Gradle / Ivy
Show all versions of redshift 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.redshift.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 java.util.stream.Collectors;
import java.util.stream.Stream;
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 RedshiftRequest implements
ToCopyableBuilder {
private static final SdkField SCHEDULED_ACTION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ScheduledActionName").getter(getter(DescribeScheduledActionsRequest::scheduledActionName))
.setter(setter(Builder::scheduledActionName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ScheduledActionName").build())
.build();
private static final SdkField TARGET_ACTION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TargetActionType").getter(getter(DescribeScheduledActionsRequest::targetActionTypeAsString))
.setter(setter(Builder::targetActionType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TargetActionType").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 ACTIVE_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("Active").getter(getter(DescribeScheduledActionsRequest::active)).setter(setter(Builder::active))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Active").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeScheduledActionsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName("ScheduledActionFilter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ScheduledActionFilter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("ScheduledActionFilter").build()).build()).build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeScheduledActionsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").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(SCHEDULED_ACTION_NAME_FIELD,
TARGET_ACTION_TYPE_FIELD, START_TIME_FIELD, END_TIME_FIELD, ACTIVE_FIELD, FILTERS_FIELD, MARKER_FIELD,
MAX_RECORDS_FIELD));
private final String scheduledActionName;
private final String targetActionType;
private final Instant startTime;
private final Instant endTime;
private final Boolean active;
private final List filters;
private final String marker;
private final Integer maxRecords;
private DescribeScheduledActionsRequest(BuilderImpl builder) {
super(builder);
this.scheduledActionName = builder.scheduledActionName;
this.targetActionType = builder.targetActionType;
this.startTime = builder.startTime;
this.endTime = builder.endTime;
this.active = builder.active;
this.filters = builder.filters;
this.marker = builder.marker;
this.maxRecords = builder.maxRecords;
}
/**
*
* The name of the scheduled action to retrieve.
*
*
* @return The name of the scheduled action to retrieve.
*/
public final String scheduledActionName() {
return scheduledActionName;
}
/**
*
* The type of the scheduled actions to retrieve.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #targetActionType}
* will return {@link ScheduledActionTypeValues#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #targetActionTypeAsString}.
*
*
* @return The type of the scheduled actions to retrieve.
* @see ScheduledActionTypeValues
*/
public final ScheduledActionTypeValues targetActionType() {
return ScheduledActionTypeValues.fromValue(targetActionType);
}
/**
*
* The type of the scheduled actions to retrieve.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #targetActionType}
* will return {@link ScheduledActionTypeValues#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #targetActionTypeAsString}.
*
*
* @return The type of the scheduled actions to retrieve.
* @see ScheduledActionTypeValues
*/
public final String targetActionTypeAsString() {
return targetActionType;
}
/**
*
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations
* after this time are retrieved.
*
*
* @return The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have
* invocations after this time are retrieved.
*/
public final Instant startTime() {
return startTime;
}
/**
*
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations
* before this time are retrieved.
*
*
* @return The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have
* invocations before this time are retrieved.
*/
public final Instant endTime() {
return endTime;
}
/**
*
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*
*
* @return If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*/
public final Boolean active() {
return active;
}
/**
* For responses, this returns true if the service returned a value for the Filters 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 hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* List of scheduled action filters.
*
*
* 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 #hasFilters} method.
*
*
* @return List of scheduled action filters.
*/
public final List filters() {
return filters;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web
* Services returns a value in the Marker field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker parameter and retrying the
* request.
*
*
* @return An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeScheduledActions request exceed the value specified in
* MaxRecords, Amazon Web Services returns a value in the Marker field of the
* response. You can retrieve the next set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*/
public final String marker() {
return marker;
}
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords value, a value is returned in a marker field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
*
*
* @return The maximum number of response records to return in each call. If the number of remaining response
* records exceeds the specified MaxRecords value, a value is returned in a marker
* field of the response. You can retrieve the next set of records by retrying the command with the returned
* marker value.
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 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(scheduledActionName());
hashCode = 31 * hashCode + Objects.hashCode(targetActionTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(startTime());
hashCode = 31 * hashCode + Objects.hashCode(endTime());
hashCode = 31 * hashCode + Objects.hashCode(active());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(marker());
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(scheduledActionName(), other.scheduledActionName())
&& Objects.equals(targetActionTypeAsString(), other.targetActionTypeAsString())
&& Objects.equals(startTime(), other.startTime()) && Objects.equals(endTime(), other.endTime())
&& Objects.equals(active(), other.active()) && hasFilters() == other.hasFilters()
&& Objects.equals(filters(), other.filters()) && Objects.equals(marker(), other.marker())
&& 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("ScheduledActionName", scheduledActionName())
.add("TargetActionType", targetActionTypeAsString()).add("StartTime", startTime()).add("EndTime", endTime())
.add("Active", active()).add("Filters", hasFilters() ? filters() : null).add("Marker", marker())
.add("MaxRecords", maxRecords()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ScheduledActionName":
return Optional.ofNullable(clazz.cast(scheduledActionName()));
case "TargetActionType":
return Optional.ofNullable(clazz.cast(targetActionTypeAsString()));
case "StartTime":
return Optional.ofNullable(clazz.cast(startTime()));
case "EndTime":
return Optional.ofNullable(clazz.cast(endTime()));
case "Active":
return Optional.ofNullable(clazz.cast(active()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
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 RedshiftRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the scheduled action to retrieve.
*
*
* @param scheduledActionName
* The name of the scheduled action to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder scheduledActionName(String scheduledActionName);
/**
*
* The type of the scheduled actions to retrieve.
*
*
* @param targetActionType
* The type of the scheduled actions to retrieve.
* @see ScheduledActionTypeValues
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScheduledActionTypeValues
*/
Builder targetActionType(String targetActionType);
/**
*
* The type of the scheduled actions to retrieve.
*
*
* @param targetActionType
* The type of the scheduled actions to retrieve.
* @see ScheduledActionTypeValues
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScheduledActionTypeValues
*/
Builder targetActionType(ScheduledActionTypeValues targetActionType);
/**
*
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have
* invocations after this time are retrieved.
*
*
* @param startTime
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have
* invocations after this time are retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startTime(Instant startTime);
/**
*
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations
* before this time are retrieved.
*
*
* @param endTime
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have
* invocations before this time are retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endTime(Instant endTime);
/**
*
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*
*
* @param active
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder active(Boolean active);
/**
*
* List of scheduled action filters.
*
*
* @param filters
* List of scheduled action filters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* List of scheduled action filters.
*
*
* @param filters
* List of scheduled action filters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(ScheduledActionFilter... filters);
/**
*
* List of scheduled action filters.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.redshift.model.ScheduledActionFilter.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.redshift.model.ScheduledActionFilter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.redshift.model.ScheduledActionFilter.Builder#build()} is called
* immediately and its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.redshift.model.ScheduledActionFilter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(java.util.Collection)
*/
Builder filters(Consumer... filters);
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results
* of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon
* Web Services returns a value in the Marker field of the response. You can retrieve the next set
* of response records by providing the returned marker value in the Marker parameter and retrying
* the request.
*
*
* @param marker
* An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeScheduledActions request exceed the value specified in
* MaxRecords, Amazon Web Services returns a value in the Marker field of the
* response. You can retrieve the next set of response records by providing the returned marker value in
* the Marker parameter and retrying the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords value, a value is returned in a marker field of
* the response. You can retrieve the next set of records by retrying the command with the returned marker
* value.
*
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of response records to return in each call. If the number of remaining response
* records exceeds the specified MaxRecords value, a value is returned in a
* marker field of the response. You can retrieve the next set of records by retrying the
* command with the returned marker value.
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 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 RedshiftRequest.BuilderImpl implements Builder {
private String scheduledActionName;
private String targetActionType;
private Instant startTime;
private Instant endTime;
private Boolean active;
private List filters = DefaultSdkAutoConstructList.getInstance();
private String marker;
private Integer maxRecords;
private BuilderImpl() {
}
private BuilderImpl(DescribeScheduledActionsRequest model) {
super(model);
scheduledActionName(model.scheduledActionName);
targetActionType(model.targetActionType);
startTime(model.startTime);
endTime(model.endTime);
active(model.active);
filters(model.filters);
marker(model.marker);
maxRecords(model.maxRecords);
}
public final String getScheduledActionName() {
return scheduledActionName;
}
public final void setScheduledActionName(String scheduledActionName) {
this.scheduledActionName = scheduledActionName;
}
@Override
public final Builder scheduledActionName(String scheduledActionName) {
this.scheduledActionName = scheduledActionName;
return this;
}
public final String getTargetActionType() {
return targetActionType;
}
public final void setTargetActionType(String targetActionType) {
this.targetActionType = targetActionType;
}
@Override
public final Builder targetActionType(String targetActionType) {
this.targetActionType = targetActionType;
return this;
}
@Override
public final Builder targetActionType(ScheduledActionTypeValues targetActionType) {
this.targetActionType(targetActionType == null ? null : targetActionType.toString());
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 Boolean getActive() {
return active;
}
public final void setActive(Boolean active) {
this.active = active;
}
@Override
public final Builder active(Boolean active) {
this.active = active;
return this;
}
public final List getFilters() {
List result = ScheduledActionFilterListCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = ScheduledActionFilterListCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = ScheduledActionFilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(ScheduledActionFilter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> ScheduledActionFilter.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
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;
}
}
}