Class ListInsightsDataRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudtrail.model.CloudTrailRequest
software.amazon.awssdk.services.cloudtrail.model.ListInsightsDataRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListInsightsDataRequest.Builder,ListInsightsDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListInsightsDataRequest extends CloudTrailRequest implements ToCopyableBuilder<ListInsightsDataRequest.Builder,ListInsightsDataRequest>

  • Method Details

    • insightSource

      public final String insightSource()

      The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.

      Returns:
      The Amazon Resource Name(ARN) of the trail for which you want to retrieve Insights events.

    • dataType

      public final ListInsightsDataType dataType()

      Specifies the category of events returned. To fetch Insights events, specify InsightsEvents as the value of DataType

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

      Returns:
      Specifies the category of events returned. To fetch Insights events, specify InsightsEvents as the value of DataType
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      Specifies the category of events returned. To fetch Insights events, specify InsightsEvents as the value of DataType

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

      Returns:
      Specifies the category of events returned. To fetch Insights events, specify InsightsEvents as the value of DataType
      See Also:

    • dimensions

      public final Map<ListInsightsDataDimensionKey,String> dimensions()

      Contains a map of dimensions. Currently the map can contain only one item.

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

      Returns:
      Contains a map of dimensions. Currently the map can contain only one item.

    • hasDimensions

      public final boolean hasDimensions()
      For responses, this returns true if the service returned a value for the Dimensions 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.

    • dimensionsAsStrings

      public final Map<String,String> dimensionsAsStrings()

      Contains a map of dimensions. Currently the map can contain only one item.

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

      Returns:
      Contains a map of dimensions. Currently the map can contain only one item.

    • startTime

      public final Instant startTime()

      Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

      Returns:
      Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

    • endTime

      public final Instant endTime()

      Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

      Returns:
      Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

    • maxResults

      public final Integer maxResults()

      The number of events to return. Possible values are 1 through 50. The default is 50.

      Returns:
      The number of events to return. Possible values are 1 through 50. The default is 50.

    • nextToken

      public final String nextToken()

      The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified a EventName as a dimension with PutObject as a value, the call with NextToken should include those same parameters.

      Returns:
      The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified a EventName as a dimension with PutObject as a value, the call with NextToken should include those same parameters.

    • toBuilder

      public ListInsightsDataRequest.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<ListInsightsDataRequest.Builder,ListInsightsDataRequest>
      Specified by:
      toBuilder in class CloudTrailRequest
      Returns:
      a builder for type T

    • builder

      public static ListInsightsDataRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListInsightsDataRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.