GetAssetPropertyAggregatesRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest
    - - software.amazon.awssdk.services.iotsitewise.model.GetAssetPropertyAggregatesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetAssetPropertyAggregatesRequest.Builder,GetAssetPropertyAggregatesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetAssetPropertyAggregatesRequest
extends IoTSiteWiseRequest
implements ToCopyableBuilder<GetAssetPropertyAggregatesRequest.Builder,GetAssetPropertyAggregatesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetAssetPropertyAggregatesRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AggregateType>`	`aggregateTypes()` The data aggregating function.
`List<String>`	`aggregateTypesAsStrings()` The data aggregating function.
`String`	`assetId()` The ID of the asset.
`static GetAssetPropertyAggregatesRequest.Builder`	`builder()`
`Instant`	`endDate()` The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAggregateTypes()` For responses, this returns true if the service returned a value for the AggregateTypes property.
`int`	`hashCode()`
`boolean`	`hasQualities()` For responses, this returns true if the service returned a value for the Qualities property.
`Integer`	`maxResults()` The maximum number of results to return for each paginated request.
`String`	`nextToken()` The token to be used for the next set of paginated results.
`String`	`propertyAlias()` The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature`).
`String`	`propertyId()` The ID of the asset property.
`List<Quality>`	`qualities()` The quality by which to filter asset data.
`List<String>`	`qualitiesAsStrings()` The quality by which to filter asset data.
`String`	`resolution()` The time interval over which to aggregate data.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetAssetPropertyAggregatesRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startDate()` The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
`TimeOrdering`	`timeOrdering()` The chronological sorting order of the requested information.
`String`	`timeOrderingAsString()` The chronological sorting order of the requested information.
`GetAssetPropertyAggregatesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - assetId
```
public final String assetId()
```
    The ID of the asset.
    
    Returns:
    
    The ID of the asset.
  - propertyId
```
public final String propertyId()
```
    The ID of the asset property.
    
    Returns:
    
    The ID of the asset property.
  - propertyAlias
```
public final String propertyAlias()
```
    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
    
    Returns:
    
    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
  - aggregateTypes
```
public final List<AggregateType> aggregateTypes()
```
    The data aggregating function.
    
    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 hasAggregateTypes() method.
    
    Returns:
    
    The data aggregating function.
  - hasAggregateTypes
```
public final boolean hasAggregateTypes()
```
    For responses, this returns true if the service returned a value for the AggregateTypes 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.
  - aggregateTypesAsStrings
```
public final List<String> aggregateTypesAsStrings()
```
    The data aggregating function.
    
    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 hasAggregateTypes() method.
    
    Returns:
    
    The data aggregating function.
  - resolution
```
public final String resolution()
```
    The time interval over which to aggregate data.
    
    Returns:
    
    The time interval over which to aggregate data.
  - qualities
```
public final List<Quality> qualities()
```
    The quality by which to filter asset data.
    
    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 hasQualities() method.
    
    Returns:
    
    The quality by which to filter asset data.
  - hasQualities
```
public final boolean hasQualities()
```
    For responses, this returns true if the service returned a value for the Qualities 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.
  - qualitiesAsStrings
```
public final List<String> qualitiesAsStrings()
```
    The quality by which to filter asset data.
    
    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 hasQualities() method.
    
    Returns:
    
    The quality by which to filter asset data.
  - startDate
```
public final Instant startDate()
```
    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
    
    Returns:
    
    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
  - endDate
```
public final Instant endDate()
```
    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
    
    Returns:
    
    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
  - timeOrdering
```
public final TimeOrdering timeOrdering()
```
    The chronological sorting order of the requested information.
    
    Default: ASCENDING
    
    If the service returns an enum value that is not available in the current SDK version, timeOrdering will return TimeOrdering.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeOrderingAsString().
    
    Returns:
    
    The chronological sorting order of the requested information.
    
    Default: ASCENDING
    
    See Also:
    
    TimeOrdering
  - timeOrderingAsString
```
public final String timeOrderingAsString()
```
    The chronological sorting order of the requested information.
    
    Default: ASCENDING
    
    If the service returns an enum value that is not available in the current SDK version, timeOrdering will return TimeOrdering.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeOrderingAsString().
    
    Returns:
    
    The chronological sorting order of the requested information.
    
    Default: ASCENDING
    
    See Also:
    
    TimeOrdering
  - nextToken
```
public final String nextToken()
```
    The token to be used for the next set of paginated results.
    
    Returns:
    
    The token to be used for the next set of paginated results.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return for each paginated request.
    
    Default: 100
    
    Returns:
    
    The maximum number of results to return for each paginated request.
    
    Default: 100
  - toBuilder
```
public GetAssetPropertyAggregatesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetAssetPropertyAggregatesRequest.Builder,GetAssetPropertyAggregatesRequest>
    
    Specified by:
    
    toBuilder in class IoTSiteWiseRequest
  - builder
```
public static GetAssetPropertyAggregatesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetAssetPropertyAggregatesRequest.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 GetAssetPropertyAggregatesRequest

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

assetId

propertyId

propertyAlias

aggregateTypes

hasAggregateTypes

aggregateTypesAsStrings

resolution

qualities

hasQualities

qualitiesAsStrings

startDate

endDate

timeOrdering

timeOrderingAsString

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields