Interface ListInsightsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListInsightsRequest.Builder,ListInsightsRequest>, OpenSearchRequest.Builder, SdkBuilder<ListInsightsRequest.Builder,ListInsightsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListInsightsRequest
@Mutable @NotThreadSafe public static interface ListInsightsRequest.Builder extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<ListInsightsRequest.Builder,ListInsightsRequest>

  • Method Details

    • entity

      ListInsightsRequest.Builder entity(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • entity

      default ListInsightsRequest.Builder entity(Consumer<InsightEntity.Builder> 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.

      This is a convenience method that creates an instance of the InsightEntity.Builder avoiding the need to create one manually via InsightEntity.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to entity(InsightEntity).

      Parameters:
      entity - a consumer that will call methods on InsightEntity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeRange

      ListInsightsRequest.Builder timeRange(InsightTimeRange timeRange)

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

      Parameters:
      timeRange - The time range for filtering insights, specified as epoch millisecond timestamps.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeRange

      default ListInsightsRequest.Builder timeRange(Consumer<InsightTimeRange.Builder> timeRange)

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

      This is a convenience method that creates an instance of the InsightTimeRange.Builder avoiding the need to create one manually via InsightTimeRange.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timeRange(InsightTimeRange).

      Parameters:
      timeRange - a consumer that will call methods on InsightTimeRange.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListInsightsRequest.Builder sortOrder(String sortOrder)

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

      Parameters:
      sortOrder - The sort order for the results. Possible values are ASC (ascending) and DESC (descending).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListInsightsRequest.Builder sortOrder(InsightSortOrder sortOrder)

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

      Parameters:
      sortOrder - The sort order for the results. Possible values are ASC (ascending) and DESC (descending).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListInsightsRequest.Builder maxResults(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListInsightsRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListInsightsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListInsightsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.