commonMain.aws.sdk.kotlin.services.iotsitewise.model.GetAssetPropertyAggregatesRequest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of iotsitewise-jvm Show documentation
Show all versions of iotsitewise-jvm Show documentation
The AWS SDK for Kotlin client for IoTSiteWise
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.iotsitewise.model
import aws.smithy.kotlin.runtime.SdkDsl
import aws.smithy.kotlin.runtime.time.Instant
public class GetAssetPropertyAggregatesRequest private constructor(builder: Builder) {
/**
* The data aggregating function.
*/
public val aggregateTypes: List? = builder.aggregateTypes
/**
* The ID of the asset, in UUID format.
*/
public val assetId: kotlin.String? = builder.assetId
/**
* The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
*/
public val endDate: aws.smithy.kotlin.runtime.time.Instant? = builder.endDate
/**
* The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
* + The size of the result set is equal to 1 MB.
* + The number of data points in the result set is equal to the value of `maxResults`. The maximum value of `maxResults` is 2500.
*/
public val maxResults: kotlin.Int? = builder.maxResults
/**
* The token to be used for the next set of paginated results.
*/
public val nextToken: kotlin.String? = builder.nextToken
/**
* 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the *IoT SiteWise User Guide*.
*/
public val propertyAlias: kotlin.String? = builder.propertyAlias
/**
* The ID of the asset property, in UUID format.
*/
public val propertyId: kotlin.String? = builder.propertyId
/**
* The quality by which to filter asset data.
*/
public val qualities: List? = builder.qualities
/**
* The time interval over which to aggregate data.
*/
public val resolution: kotlin.String? = builder.resolution
/**
* The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
*/
public val startDate: aws.smithy.kotlin.runtime.time.Instant? = builder.startDate
/**
* The chronological sorting order of the requested information.
*
* Default: `ASCENDING`
*/
public val timeOrdering: aws.sdk.kotlin.services.iotsitewise.model.TimeOrdering? = builder.timeOrdering
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.iotsitewise.model.GetAssetPropertyAggregatesRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("GetAssetPropertyAggregatesRequest(")
append("aggregateTypes=$aggregateTypes,")
append("assetId=$assetId,")
append("endDate=$endDate,")
append("maxResults=$maxResults,")
append("nextToken=$nextToken,")
append("propertyAlias=$propertyAlias,")
append("propertyId=$propertyId,")
append("qualities=$qualities,")
append("resolution=$resolution,")
append("startDate=$startDate,")
append("timeOrdering=$timeOrdering")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = aggregateTypes?.hashCode() ?: 0
result = 31 * result + (assetId?.hashCode() ?: 0)
result = 31 * result + (endDate?.hashCode() ?: 0)
result = 31 * result + (maxResults ?: 0)
result = 31 * result + (nextToken?.hashCode() ?: 0)
result = 31 * result + (propertyAlias?.hashCode() ?: 0)
result = 31 * result + (propertyId?.hashCode() ?: 0)
result = 31 * result + (qualities?.hashCode() ?: 0)
result = 31 * result + (resolution?.hashCode() ?: 0)
result = 31 * result + (startDate?.hashCode() ?: 0)
result = 31 * result + (timeOrdering?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as GetAssetPropertyAggregatesRequest
if (aggregateTypes != other.aggregateTypes) return false
if (assetId != other.assetId) return false
if (endDate != other.endDate) return false
if (maxResults != other.maxResults) return false
if (nextToken != other.nextToken) return false
if (propertyAlias != other.propertyAlias) return false
if (propertyId != other.propertyId) return false
if (qualities != other.qualities) return false
if (resolution != other.resolution) return false
if (startDate != other.startDate) return false
if (timeOrdering != other.timeOrdering) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.iotsitewise.model.GetAssetPropertyAggregatesRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The data aggregating function.
*/
public var aggregateTypes: List? = null
/**
* The ID of the asset, in UUID format.
*/
public var assetId: kotlin.String? = null
/**
* The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
*/
public var endDate: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
* + The size of the result set is equal to 1 MB.
* + The number of data points in the result set is equal to the value of `maxResults`. The maximum value of `maxResults` is 2500.
*/
public var maxResults: kotlin.Int? = null
/**
* The token to be used for the next set of paginated results.
*/
public var nextToken: kotlin.String? = null
/**
* 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) in the *IoT SiteWise User Guide*.
*/
public var propertyAlias: kotlin.String? = null
/**
* The ID of the asset property, in UUID format.
*/
public var propertyId: kotlin.String? = null
/**
* The quality by which to filter asset data.
*/
public var qualities: List? = null
/**
* The time interval over which to aggregate data.
*/
public var resolution: kotlin.String? = null
/**
* The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
*/
public var startDate: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The chronological sorting order of the requested information.
*
* Default: `ASCENDING`
*/
public var timeOrdering: aws.sdk.kotlin.services.iotsitewise.model.TimeOrdering? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.iotsitewise.model.GetAssetPropertyAggregatesRequest) : this() {
this.aggregateTypes = x.aggregateTypes
this.assetId = x.assetId
this.endDate = x.endDate
this.maxResults = x.maxResults
this.nextToken = x.nextToken
this.propertyAlias = x.propertyAlias
this.propertyId = x.propertyId
this.qualities = x.qualities
this.resolution = x.resolution
this.startDate = x.startDate
this.timeOrdering = x.timeOrdering
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.iotsitewise.model.GetAssetPropertyAggregatesRequest = GetAssetPropertyAggregatesRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy