Class RequestWidget

java.lang.Object
software.amazon.awssdk.services.cloudtrail.model.RequestWidget
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RequestWidget.Builder,RequestWidget>
@Generated("software.amazon.awssdk:codegen") public final class RequestWidget extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RequestWidget.Builder,RequestWidget>

Contains information about a widget on a CloudTrail Lake dashboard.

See Also:

  • Method Details

    • queryStatement

      public final String queryStatement()

      The query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.

      When a query uses ? with eventTime, ? must be surrounded by single quotes as follows: '?'.

      Returns:
      The query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.

      When a query uses ? with eventTime, ? must be surrounded by single quotes as follows: '?'.

    • hasQueryParameters

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

    • queryParameters

      public final List<String> queryParameters()

      The optional query parameters. The following query parameters are valid: $StartTime$, $EndTime$, and $Period$.

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

      Returns:
      The optional query parameters. The following query parameters are valid: $StartTime$, $EndTime$, and $Period$.

    • hasViewProperties

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

    • viewProperties

      public final Map<String,String> viewProperties()

      The view properties for the widget. For more information about view properties, see View properties for widgets in the CloudTrail User Guide.

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

      Returns:
      The view properties for the widget. For more information about view properties, see View properties for widgets in the CloudTrail User Guide.

    • toBuilder

      public RequestWidget.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<RequestWidget.Builder,RequestWidget>
      Returns:
      a builder for type T

    • builder

      public static RequestWidget.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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