Package software.amazon.awssdk.services.cloudtrail.model

Class PutInsightSelectorsRequest

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

  • Method Details

    • trailName

      public final String trailName()

      The name of the CloudTrail trail for which you want to change or add Insights selectors.

      You cannot use this parameter with the EventDataStore and InsightsDestination parameters.

      Returns:
      The name of the CloudTrail trail for which you want to change or add Insights selectors.

      You cannot use this parameter with the EventDataStore and InsightsDestination parameters.

    • hasInsightSelectors

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

    • insightSelectors

      public final List<InsightSelector> insightSelectors()

      A JSON string that contains the Insights types you want to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

      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. The error is shown if the API call is unsuccessful.

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

      Returns:
      A JSON string that contains the Insights types you want to log on a trail or event data store. ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

      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. The error is shown if the API call is unsuccessful.

    • eventDataStore

      public final String eventDataStore()

      The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights selectors. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

      You cannot use this parameter with the TrailName parameter.

      Returns:
      The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights selectors. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

      You cannot use this parameter with the TrailName parameter.

    • insightsDestination

      public final String insightsDestination()

      The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

      You cannot use this parameter with the TrailName parameter.

      Returns:
      The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the EventDataStore and InsightsDestination parameters.

      You cannot use this parameter with the TrailName parameter.

    • toBuilder

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

    • builder

      public static PutInsightSelectorsRequest.Builder builder()

    • serializableBuilderClass

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