Class ListInsightsMetricDataRequest

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.ListInsightsMetricDataRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListInsightsMetricDataRequest.Builder,ListInsightsMetricDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListInsightsMetricDataRequest extends CloudTrailRequest implements ToCopyableBuilder<ListInsightsMetricDataRequest.Builder,ListInsightsMetricDataRequest>

  • Method Details

    • eventSource

      public final String eventSource()

      The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

      Returns:
      The Amazon Web Services service to which the request was made, such as iam.amazonaws.com or s3.amazonaws.com.

    • eventName

      public final String eventName()

      The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

      Returns:
      The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.

    • insightType

      public final InsightType insightType()

      The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

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

      Returns:
      The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.
      See Also:

    • insightTypeAsString

      public final String insightTypeAsString()

      The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.

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

      Returns:
      The type of CloudTrail Insights event, which is either ApiCallRateInsight or ApiErrorRateInsight. The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes.
      See Also:

    • errorCode

      public final String errorCode()

      Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

      If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

      Returns:
      Conditionally required if the InsightType parameter is set to ApiErrorRateInsight.

      If returning metrics for the ApiErrorRateInsight Insights type, this is the error to retrieve data for. For example, AccessDenied.

    • startTime

      public final Instant startTime()

      Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

      The default is 90 days before the time of request.

      Returns:
      Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.

      The default is 90 days before the time of request.

    • endTime

      public final Instant endTime()

      Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

      The default is the time of request.

      Returns:
      Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.

      The default is the time of request.

    • period

      public final Integer period()

      Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

      Returns:
      Granularity of data to retrieve, in seconds. Valid values are 60, 300, and 3600. If you specify any other value, you will get an error. The default is 3600 seconds.

    • dataType

      public final InsightsMetricDataType dataType()

      Type of data points to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

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

      Returns:
      Type of data points to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      Type of data points to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.

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

      Returns:
      Type of data points to return. Valid values are NonZeroData and FillWithZeros. The default is NonZeroData.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of data points to return. Valid values are integers from 1 to 21600. The default value is 21600.

      Returns:
      The maximum number of data points to return. Valid values are integers from 1 to 21600. The default value is 21600.

    • nextToken

      public final String nextToken()

      Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

      Add this parameter to the request to continue retrieving results starting from the last evaluated point.

      Returns:
      Returned if all datapoints can't be returned in a single call. For example, due to reaching MaxResults.

      Add this parameter to the request to continue retrieving results starting from the last evaluated point.

    • toBuilder

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

    • builder

      public static ListInsightsMetricDataRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListInsightsMetricDataRequest.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.