Package software.amazon.awssdk.services.opensearch.model

Class ListInsightsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearch.model.OpenSearchRequest

software.amazon.awssdk.services.opensearch.model.ListInsightsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListInsightsRequest.Builder,ListInsightsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListInsightsRequest
extends OpenSearchRequest
implements ToCopyableBuilder<ListInsightsRequest.Builder,ListInsightsRequest>

Container for the parameters to the ListInsights operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListInsightsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListInsightsRequest.Builder	builder()
final InsightEntity	entity()	The entity for which to list insights.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Integer	maxResults()	An optional parameter that specifies the maximum number of results to return.
final String	nextToken()	If your initial ListInsights operation returns a NextToken, include the returned NextToken in subsequent ListInsights operations to retrieve the next page of results.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ListInsightsRequest.Builder>	serializableBuilderClass()
final InsightSortOrder	sortOrder()	The sort order for the results.
final String	sortOrderAsString()	The sort order for the results.
final InsightTimeRange	timeRange()	The time range for filtering insights, specified as epoch millisecond timestamps.
ListInsightsRequest.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

entity

public final InsightEntity entity()

The entity for which to list insights. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.

Returns:

The entity for which to list insights. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.

timeRange

public final InsightTimeRange timeRange()

The time range for filtering insights, specified as epoch millisecond timestamps.

Returns:

The time range for filtering insights, specified as epoch millisecond timestamps.

sortOrder

public final InsightSortOrder sortOrder()

The sort order for the results. Possible values are ASC (ascending) and DESC (descending).

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

Returns:

The sort order for the results. Possible values are ASC (ascending) and DESC (descending).

See Also:

• InsightSortOrder

sortOrderAsString

public final String sortOrderAsString()

The sort order for the results. Possible values are ASC (ascending) and DESC (descending).

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

Returns:

The sort order for the results. Possible values are ASC (ascending) and DESC (descending).

See Also:

• InsightSortOrder

maxResults

public final Integer maxResults()

An optional parameter that specifies the maximum number of results to return. You can use NextToken to get the next page of results. Valid values are 1 to 500.

Returns:

An optional parameter that specifies the maximum number of results to return. You can use NextToken to get the next page of results. Valid values are 1 to 500.

nextToken

public final String nextToken()

If your initial ListInsights operation returns a NextToken, include the returned NextToken in subsequent ListInsights operations to retrieve the next page of results.

Returns:

If your initial ListInsights operation returns a NextToken, include the returned NextToken in subsequent ListInsights operations to retrieve the next page of results.

toBuilder

public ListInsightsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListInsightsRequest.Builder,ListInsightsRequest>

Specified by:

toBuilder in class OpenSearchRequest

builder

public static ListInsightsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo