software.amazon.awssdk.services.databasemigration.model

Class DescribeEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest

software.amazon.awssdk.services.databasemigration.model.DescribeEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeEventsRequest
extends DatabaseMigrationRequest
implements ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeEventsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeEventsRequest.Builder	builder()
Integer	duration() The duration of the events to be listed.
Instant	endTime() The end time for the events to be listed.
boolean	equals(Object obj)
List<String>	eventCategories() A list of event categories for a source type that you want to subscribe to.
List<Filter>	filters() Filters applied to the action.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	marker() An optional pagination token provided by a previous request.
Integer	maxRecords() The maximum number of records to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEventsRequest.Builder>	serializableBuilderClass()
String	sourceIdentifier() The identifier of the event source.
SourceType	sourceType() The type of AWS DMS resource that generates events.
String	sourceTypeAsString() The type of AWS DMS resource that generates events.
Instant	startTime() The start time for the events to be listed.
DescribeEventsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

sourceIdentifier

public String sourceIdentifier()

The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.

Returns:

The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens.

sourceType

public SourceType sourceType()

The type of AWS DMS resource that generates events.

Valid values: replication-instance | migration-task

If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

The type of AWS DMS resource that generates events.

Valid values: replication-instance | migration-task

See Also:

SourceType

sourceTypeAsString

public String sourceTypeAsString()

The type of AWS DMS resource that generates events.

Valid values: replication-instance | migration-task

If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

The type of AWS DMS resource that generates events.

Valid values: replication-instance | migration-task

See Also:

SourceType

startTime

public Instant startTime()

The start time for the events to be listed.

Returns:

The start time for the events to be listed.

endTime

public Instant endTime()

The end time for the events to be listed.

Returns:

The end time for the events to be listed.

duration

public Integer duration()

The duration of the events to be listed.

Returns:

The duration of the events to be listed.

eventCategories

public List<String> eventCategories()

A list of event categories for a source type that you want to subscribe to.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of event categories for a source type that you want to subscribe to.

filters

public List<Filter> filters()

Filters applied to the action.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Filters applied to the action.

maxRecords

public Integer 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.

Returns:

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.

marker

public String 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.

Returns:

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.

toBuilder

public DescribeEventsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEventsRequest.Builder,DescribeEventsRequest>

Specified by:

toBuilder in class DatabaseMigrationRequest

Returns:

a builder for type T

builder

public static DescribeEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeEventsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.