Package software.amazon.awssdk.services.alexaforbusiness.model

Class ListDeviceEventsRequest

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

  • Method Details

    • deviceArn

      public final String deviceArn()

      The ARN of a device.

      Returns:
      The ARN of a device.

    • eventType

      public final DeviceEventType eventType()

      The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

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

      Returns:
      The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
      See Also:

    • eventTypeAsString

      public final String eventTypeAsString()

      The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

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

      Returns:
      The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
      See Also:

    • nextToken

      public final String nextToken()

      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

      Returns:
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

      Returns:
      The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    • toBuilder

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

    • builder

      public static ListDeviceEventsRequest.Builder builder()

    • serializableBuilderClass

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