GetPropertyValueHistoryRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class GetPropertyValueHistoryRequest
extends IoTTwinMakerRequest
implements ToCopyableBuilder<GetPropertyValueHistoryRequest.Builder,GetPropertyValueHistoryRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetPropertyValueHistoryRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetPropertyValueHistoryRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static GetPropertyValueHistoryRequest.Builder`	`builder()`
`String`	`componentName()` The name of the component.
`String`	`componentTypeId()` The ID of the component type.
`Instant`	`endDateTime()` Deprecated. This field is deprecated and will throw an error in the future. Use endTime instead.
`String`	`endTime()` The ISO8601 DateTime of the latest property value to return.
`String`	`entityId()` The ID of the entity.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPropertyFilters()` For responses, this returns true if the service returned a value for the PropertyFilters property.
`boolean`	`hasSelectedProperties()` For responses, this returns true if the service returned a value for the SelectedProperties property.
`InterpolationParameters`	`interpolation()` An object that specifies the interpolation type and the interval over which to interpolate data.
`Integer`	`maxResults()` The maximum number of results to return.
`String`	`nextToken()` The string that specifies the next page of results.
`OrderByTime`	`orderByTime()` The time direction to use in the result order.
`String`	`orderByTimeAsString()` The time direction to use in the result order.
`List<PropertyFilter>`	`propertyFilters()` A list of objects that filter the property value history request.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`selectedProperties()` A list of properties whose value histories the request retrieves.
`static Class<? extends GetPropertyValueHistoryRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startDateTime()` Deprecated. This field is deprecated and will throw an error in the future. Use startTime instead.
`String`	`startTime()` The ISO8601 DateTime of the earliest property value to return.
`GetPropertyValueHistoryRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`workspaceId()` The ID of the workspace.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - componentName
```
public final String componentName()
```
    The name of the component.
    
    Returns:
    
    The name of the component.
  - componentTypeId
```
public final String componentTypeId()
```
    The ID of the component type.
    
    Returns:
    
    The ID of the component type.
  - 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.
  - 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.
  - entityId
```
public final String entityId()
```
    The ID of the entity.
    
    Returns:
    
    The ID of the entity.
  - 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.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return.
    
    Returns:
    
    The maximum number of results to return.
  - nextToken
```
public final String nextToken()
```
    The string that specifies the next page of results.
    
    Returns:
    
    The string that specifies the next page of results.
  - 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:
    
    OrderByTime
  - 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:
    
    OrderByTime
  - 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.
  - 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.
  - 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.
  - 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.
  - workspaceId
```
public final String workspaceId()
```
    The ID of the workspace.
    
    Returns:
    
    The ID of the workspace.
  - toBuilder
```
public GetPropertyValueHistoryRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetPropertyValueHistoryRequest.Builder,GetPropertyValueHistoryRequest>
    
    Specified by:
    
    toBuilder in class IoTTwinMakerRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetPropertyValueHistoryRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

componentName

componentTypeId

endDateTime

endTime

entityId

interpolation

maxResults

nextToken

orderByTime

orderByTimeAsString

hasPropertyFilters

propertyFilters

hasSelectedProperties

selectedProperties

startDateTime

startTime

workspaceId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields