Class GetPropertyValueHistoryRequest

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

  • Method Details

    • workspaceId

      public final String workspaceId()

      The ID of the workspace.

      Returns:
      The ID of the workspace.

    • entityId

      public final String entityId()

      The ID of the entity.

      Returns:
      The ID of the entity.

    • componentName

      public final String componentName()

      The name of the component.

      Returns:
      The name of the component.

    • componentPath

      public final String componentPath()

      This string specifies the path to the composite component, starting from the top-level component.

      Returns:
      This string specifies the path to the composite component, starting from the top-level component.

    • componentTypeId

      public final String componentTypeId()

      The ID of the component type.

      Returns:
      The ID of the component type.

    • hasSelectedProperties

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

    • selectedProperties

      public final List<String> selectedProperties()

      A list of properties whose value histories the request retrieves.

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

      Returns:
      A list of properties whose value histories the request retrieves.

    • hasPropertyFilters

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

    • propertyFilters

      public final List<PropertyFilter> propertyFilters()

      A list of objects that filter the property value history request.

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

      Returns:
      A list of objects that filter the property value history request.

    • startDateTime

      @Deprecated public final Instant startDateTime()
      Deprecated.
      This field is deprecated and will throw an error in the future. Use startTime instead.

      The date and time of the earliest property value to return.

      Returns:
      The date and time of the earliest property value to return.

    • endDateTime

      @Deprecated public final Instant endDateTime()
      Deprecated.
      This field is deprecated and will throw an error in the future. Use endTime instead.

      The date and time of the latest property value to return.

      Returns:
      The date and time of the latest property value to return.

    • interpolation

      public final InterpolationParameters interpolation()

      An object that specifies the interpolation type and the interval over which to interpolate data.

      Returns:
      An object that specifies the interpolation type and the interval over which to interpolate data.

    • nextToken

      public final String nextToken()

      The string that specifies the next page of results.

      Returns:
      The string that specifies the next page of results.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

      Returns:
      The maximum number of results to return at one time. The default is 25.

      Valid Range: Minimum value of 1. Maximum value of 250.

    • orderByTime

      public final OrderByTime orderByTime()

      The time direction to use in the result order.

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

      Returns:
      The time direction to use in the result order.
      See Also:

    • orderByTimeAsString

      public final String orderByTimeAsString()

      The time direction to use in the result order.

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

      Returns:
      The time direction to use in the result order.
      See Also:

    • startTime

      public final String startTime()

      The ISO8601 DateTime of the earliest property value to return.

      For more information about the ISO8601 DateTime format, see the data type PropertyValue.

      Returns:
      The ISO8601 DateTime of the earliest property value to return.

      For more information about the ISO8601 DateTime format, see the data type PropertyValue.

    • endTime

      public final String endTime()

      The ISO8601 DateTime of the latest property value to return.

      For more information about the ISO8601 DateTime format, see the data type PropertyValue.

      Returns:
      The ISO8601 DateTime of the latest property value to return.

      For more information about the ISO8601 DateTime format, see the data type PropertyValue.

    • toBuilder

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

    • builder

      public static GetPropertyValueHistoryRequest.Builder builder()

    • serializableBuilderClass

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