software.amazon.awssdk.services.databasemigration.model.DescribeEventsRequest Maven / Gradle / Ivy
Show all versions of databasemigration 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.databasemigration.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 DescribeEventsRequest extends DatabaseMigrationRequest implements
ToCopyableBuilder {
private static final SdkField SOURCE_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceIdentifier").getter(getter(DescribeEventsRequest::sourceIdentifier))
.setter(setter(Builder::sourceIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceIdentifier").build()).build();
private static final SdkField SOURCE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SourceType").getter(getter(DescribeEventsRequest::sourceTypeAsString))
.setter(setter(Builder::sourceType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceType").build()).build();
private static final SdkField START_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("StartTime").getter(getter(DescribeEventsRequest::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(DescribeEventsRequest::endTime)).setter(setter(Builder::endTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndTime").build()).build();
private static final SdkField DURATION_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("Duration").getter(getter(DescribeEventsRequest::duration)).setter(setter(Builder::duration))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Duration").build()).build();
private static final SdkField> EVENT_CATEGORIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EventCategories")
.getter(getter(DescribeEventsRequest::eventCategories))
.setter(setter(Builder::eventCategories))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EventCategories").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> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeEventsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filters").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeEventsRequest::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(DescribeEventsRequest::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(SOURCE_IDENTIFIER_FIELD,
SOURCE_TYPE_FIELD, START_TIME_FIELD, END_TIME_FIELD, DURATION_FIELD, EVENT_CATEGORIES_FIELD, FILTERS_FIELD,
MAX_RECORDS_FIELD, MARKER_FIELD));
private final String sourceIdentifier;
private final String sourceType;
private final Instant startTime;
private final Instant endTime;
private final Integer duration;
private final List eventCategories;
private final List filters;
private final Integer maxRecords;
private final String marker;
private DescribeEventsRequest(BuilderImpl builder) {
super(builder);
this.sourceIdentifier = builder.sourceIdentifier;
this.sourceType = builder.sourceType;
this.startTime = builder.startTime;
this.endTime = builder.endTime;
this.duration = builder.duration;
this.eventCategories = builder.eventCategories;
this.filters = builder.filters;
this.maxRecords = builder.maxRecords;
this.marker = builder.marker;
}
/**
*
* The identifier of an event source.
*
*
* @return The identifier of an event source.
*/
public final String sourceIdentifier() {
return sourceIdentifier;
}
/**
*
* The type of DMS resource that generates events.
*
*
* Valid values: replication-instance | replication-task
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sourceType} will
* return {@link SourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sourceTypeAsString}.
*
*
* @return The type of DMS resource that generates events.
*
* Valid values: replication-instance | replication-task
* @see SourceType
*/
public final SourceType sourceType() {
return SourceType.fromValue(sourceType);
}
/**
*
* The type of DMS resource that generates events.
*
*
* Valid values: replication-instance | replication-task
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sourceType} will
* return {@link SourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sourceTypeAsString}.
*
*
* @return The type of DMS resource that generates events.
*
* Valid values: replication-instance | replication-task
* @see SourceType
*/
public final String sourceTypeAsString() {
return sourceType;
}
/**
*
* The start time for the events to be listed.
*
*
* @return The start time for the events to be listed.
*/
public final Instant startTime() {
return startTime;
}
/**
*
* The end time for the events to be listed.
*
*
* @return The end time for the events to be listed.
*/
public final Instant endTime() {
return endTime;
}
/**
*
* The duration of the events to be listed.
*
*
* @return The duration of the events to be listed.
*/
public final Integer duration() {
return duration;
}
/**
* For responses, this returns true if the service returned a value for the EventCategories 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 hasEventCategories() {
return eventCategories != null && !(eventCategories instanceof SdkAutoConstructList);
}
/**
*
* A list of event categories for the source type that you've chosen.
*
*
* 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 #hasEventCategories} method.
*
*
* @return A list of event categories for the source type that you've chosen.
*/
public final List eventCategories() {
return eventCategories;
}
/**
* 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);
}
/**
*
* Filters applied to events. The only valid filter is replication-instance-id.
*
*
* 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 Filters applied to events. The only valid filter is replication-instance-id.
*/
public final List filters() {
return filters;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @return The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords.
*
*
* @return An optional pagination token provided by a previous request. 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 serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(sourceIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(sourceTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(startTime());
hashCode = 31 * hashCode + Objects.hashCode(endTime());
hashCode = 31 * hashCode + Objects.hashCode(duration());
hashCode = 31 * hashCode + Objects.hashCode(hasEventCategories() ? eventCategories() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
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 DescribeEventsRequest)) {
return false;
}
DescribeEventsRequest other = (DescribeEventsRequest) obj;
return Objects.equals(sourceIdentifier(), other.sourceIdentifier())
&& Objects.equals(sourceTypeAsString(), other.sourceTypeAsString())
&& Objects.equals(startTime(), other.startTime()) && Objects.equals(endTime(), other.endTime())
&& Objects.equals(duration(), other.duration()) && hasEventCategories() == other.hasEventCategories()
&& Objects.equals(eventCategories(), other.eventCategories()) && hasFilters() == other.hasFilters()
&& Objects.equals(filters(), other.filters()) && 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("DescribeEventsRequest").add("SourceIdentifier", sourceIdentifier())
.add("SourceType", sourceTypeAsString()).add("StartTime", startTime()).add("EndTime", endTime())
.add("Duration", duration()).add("EventCategories", hasEventCategories() ? eventCategories() : null)
.add("Filters", hasFilters() ? filters() : null).add("MaxRecords", maxRecords()).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "SourceIdentifier":
return Optional.ofNullable(clazz.cast(sourceIdentifier()));
case "SourceType":
return Optional.ofNullable(clazz.cast(sourceTypeAsString()));
case "StartTime":
return Optional.ofNullable(clazz.cast(startTime()));
case "EndTime":
return Optional.ofNullable(clazz.cast(endTime()));
case "Duration":
return Optional.ofNullable(clazz.cast(duration()));
case "EventCategories":
return Optional.ofNullable(clazz.cast(eventCategories()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
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 getter(Function g) {
return obj -> g.apply((DescribeEventsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DatabaseMigrationRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of an event source.
*
*
* @param sourceIdentifier
* The identifier of an event source.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceIdentifier(String sourceIdentifier);
/**
*
* The type of DMS resource that generates events.
*
*
* Valid values: replication-instance | replication-task
*
*
* @param sourceType
* The type of DMS resource that generates events.
*
* Valid values: replication-instance | replication-task
* @see SourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see SourceType
*/
Builder sourceType(String sourceType);
/**
*
* The type of DMS resource that generates events.
*
*
* Valid values: replication-instance | replication-task
*
*
* @param sourceType
* The type of DMS resource that generates events.
*
* Valid values: replication-instance | replication-task
* @see SourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see SourceType
*/
Builder sourceType(SourceType sourceType);
/**
*
* The start time for the events to be listed.
*
*
* @param startTime
* The start time for the events to be listed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startTime(Instant startTime);
/**
*
* The end time for the events to be listed.
*
*
* @param endTime
* The end time for the events to be listed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endTime(Instant endTime);
/**
*
* The duration of the events to be listed.
*
*
* @param duration
* The duration of the events to be listed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder duration(Integer duration);
/**
*
* A list of event categories for the source type that you've chosen.
*
*
* @param eventCategories
* A list of event categories for the source type that you've chosen.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventCategories(Collection eventCategories);
/**
*
* A list of event categories for the source type that you've chosen.
*
*
* @param eventCategories
* A list of event categories for the source type that you've chosen.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder eventCategories(String... eventCategories);
/**
*
* Filters applied to events. The only valid filter is replication-instance-id.
*
*
* @param filters
* Filters applied to events. The only valid filter is replication-instance-id.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* Filters applied to events. The only valid filter is replication-instance-id.
*
*
* @param filters
* Filters applied to events. The only valid filter is replication-instance-id.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* Filters applied to events. The only valid filter is replication-instance-id.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.databasemigration.model.Filter.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.databasemigration.model.Filter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.databasemigration.model.Filter.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.databasemigration.model.Filter.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);
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so that the
* remaining results can be retrieved.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so that
* the remaining results can be retrieved.
*
* 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);
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords.
*
*
* @param marker
* An optional pagination token provided by a previous request. If this parameter is specified, the
* response includes only records beyond the marker, up to the value specified by MaxRecords
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DatabaseMigrationRequest.BuilderImpl implements Builder {
private String sourceIdentifier;
private String sourceType;
private Instant startTime;
private Instant endTime;
private Integer duration;
private List eventCategories = DefaultSdkAutoConstructList.getInstance();
private List filters = DefaultSdkAutoConstructList.getInstance();
private Integer maxRecords;
private String marker;
private BuilderImpl() {
}
private BuilderImpl(DescribeEventsRequest model) {
super(model);
sourceIdentifier(model.sourceIdentifier);
sourceType(model.sourceType);
startTime(model.startTime);
endTime(model.endTime);
duration(model.duration);
eventCategories(model.eventCategories);
filters(model.filters);
maxRecords(model.maxRecords);
marker(model.marker);
}
public final String getSourceIdentifier() {
return sourceIdentifier;
}
public final void setSourceIdentifier(String sourceIdentifier) {
this.sourceIdentifier = sourceIdentifier;
}
@Override
public final Builder sourceIdentifier(String sourceIdentifier) {
this.sourceIdentifier = sourceIdentifier;
return this;
}
public final String getSourceType() {
return sourceType;
}
public final void setSourceType(String sourceType) {
this.sourceType = sourceType;
}
@Override
public final Builder sourceType(String sourceType) {
this.sourceType = sourceType;
return this;
}
@Override
public final Builder sourceType(SourceType sourceType) {
this.sourceType(sourceType == null ? null : sourceType.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 Integer getDuration() {
return duration;
}
public final void setDuration(Integer duration) {
this.duration = duration;
}
@Override
public final Builder duration(Integer duration) {
this.duration = duration;
return this;
}
public final Collection getEventCategories() {
if (eventCategories instanceof SdkAutoConstructList) {
return null;
}
return eventCategories;
}
public final void setEventCategories(Collection eventCategories) {
this.eventCategories = EventCategoriesListCopier.copy(eventCategories);
}
@Override
public final Builder eventCategories(Collection eventCategories) {
this.eventCategories = EventCategoriesListCopier.copy(eventCategories);
return this;
}
@Override
@SafeVarargs
public final Builder eventCategories(String... eventCategories) {
eventCategories(Arrays.asList(eventCategories));
return this;
}
public final List getFilters() {
List result = FilterListCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
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;
}
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeEventsRequest build() {
return new DescribeEventsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}