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

Class ListInsightsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.opensearch.model.OpenSearchResponse
software.amazon.awssdk.services.opensearch.model.ListInsightsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListInsightsResponse.Builder,ListInsightsResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListInsightsResponse extends OpenSearchResponse implements ToCopyableBuilder<ListInsightsResponse.Builder,ListInsightsResponse>

The result of a ListInsights request. Contains the list of insights and a pagination token for retrieving the next page of results.

  • Method Details

    • hasInsights

      public final boolean hasInsights()
      For responses, this returns true if the service returned a value for the Insights property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • insights

      public final List<Insight> insights()

      The list of insights returned for the specified entity.

      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 hasInsights() method.

      Returns:
      The list of insights returned for the specified entity.

    • nextToken

      public final String nextToken()

      When NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

      Returns:
      When NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

    • toBuilder

      public ListInsightsResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListInsightsResponse.Builder,ListInsightsResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static ListInsightsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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 SdkResponse

    • 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