commonMain.aws.sdk.kotlin.services.iottwinmaker.model.GetPropertyValueHistoryRequest.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.iottwinmaker.model
import aws.smithy.kotlin.runtime.time.Instant
public class GetPropertyValueHistoryRequest private constructor(builder: Builder) {
/**
* The name of the component.
*/
public val componentName: kotlin.String? = builder.componentName
/**
* This string specifies the path to the composite component, starting from the top-level component.
*/
public val componentPath: kotlin.String? = builder.componentPath
/**
* The ID of the component type.
*/
public val componentTypeId: kotlin.String? = builder.componentTypeId
/**
* The date and time of the latest property value to return.
*/
@Deprecated("No longer recommended for use. See AWS API documentation for more details.")
public val endDateTime: aws.smithy.kotlin.runtime.time.Instant? = builder.endDateTime
/**
* The ISO8601 DateTime of the latest property value to return.
*
* For more information about the ISO8601 DateTime format, see the data type [PropertyValue](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html).
*/
public val endTime: kotlin.String? = builder.endTime
/**
* The ID of the entity.
*/
public val entityId: kotlin.String? = builder.entityId
/**
* An object that specifies the interpolation type and the interval over which to interpolate data.
*/
public val interpolation: aws.sdk.kotlin.services.iottwinmaker.model.InterpolationParameters? = builder.interpolation
/**
* The maximum number of results to return at one time. The default is 25.
*
* Valid Range: Minimum value of 1. Maximum value of 250.
*/
public val maxResults: kotlin.Int? = builder.maxResults
/**
* The string that specifies the next page of results.
*/
public val nextToken: kotlin.String? = builder.nextToken
/**
* The time direction to use in the result order.
*/
public val orderByTime: aws.sdk.kotlin.services.iottwinmaker.model.OrderByTime? = builder.orderByTime
/**
* A list of objects that filter the property value history request.
*/
public val propertyFilters: List? = builder.propertyFilters
/**
* A list of properties whose value histories the request retrieves.
*/
public val selectedProperties: List = requireNotNull(builder.selectedProperties) { "A non-null value must be provided for selectedProperties" }
/**
* The date and time of the earliest property value to return.
*/
@Deprecated("No longer recommended for use. See AWS API documentation for more details.")
public val startDateTime: aws.smithy.kotlin.runtime.time.Instant? = builder.startDateTime
/**
* The ISO8601 DateTime of the earliest property value to return.
*
* For more information about the ISO8601 DateTime format, see the data type [PropertyValue](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html).
*/
public val startTime: kotlin.String? = builder.startTime
/**
* The ID of the workspace.
*/
public val workspaceId: kotlin.String = requireNotNull(builder.workspaceId) { "A non-null value must be provided for workspaceId" }
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.iottwinmaker.model.GetPropertyValueHistoryRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("GetPropertyValueHistoryRequest(")
append("componentName=$componentName,")
append("componentPath=$componentPath,")
append("componentTypeId=$componentTypeId,")
append("endDateTime=$endDateTime,")
append("endTime=$endTime,")
append("entityId=$entityId,")
append("interpolation=$interpolation,")
append("maxResults=$maxResults,")
append("nextToken=$nextToken,")
append("orderByTime=$orderByTime,")
append("propertyFilters=$propertyFilters,")
append("selectedProperties=$selectedProperties,")
append("startDateTime=$startDateTime,")
append("startTime=$startTime,")
append("workspaceId=$workspaceId")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = componentName?.hashCode() ?: 0
result = 31 * result + (componentPath?.hashCode() ?: 0)
result = 31 * result + (componentTypeId?.hashCode() ?: 0)
result = 31 * result + (endDateTime?.hashCode() ?: 0)
result = 31 * result + (endTime?.hashCode() ?: 0)
result = 31 * result + (entityId?.hashCode() ?: 0)
result = 31 * result + (interpolation?.hashCode() ?: 0)
result = 31 * result + (maxResults ?: 0)
result = 31 * result + (nextToken?.hashCode() ?: 0)
result = 31 * result + (orderByTime?.hashCode() ?: 0)
result = 31 * result + (propertyFilters?.hashCode() ?: 0)
result = 31 * result + (selectedProperties.hashCode())
result = 31 * result + (startDateTime?.hashCode() ?: 0)
result = 31 * result + (startTime?.hashCode() ?: 0)
result = 31 * result + (workspaceId.hashCode())
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 GetPropertyValueHistoryRequest
if (componentName != other.componentName) return false
if (componentPath != other.componentPath) return false
if (componentTypeId != other.componentTypeId) return false
if (endDateTime != other.endDateTime) return false
if (endTime != other.endTime) return false
if (entityId != other.entityId) return false
if (interpolation != other.interpolation) return false
if (maxResults != other.maxResults) return false
if (nextToken != other.nextToken) return false
if (orderByTime != other.orderByTime) return false
if (propertyFilters != other.propertyFilters) return false
if (selectedProperties != other.selectedProperties) return false
if (startDateTime != other.startDateTime) return false
if (startTime != other.startTime) return false
if (workspaceId != other.workspaceId) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.iottwinmaker.model.GetPropertyValueHistoryRequest = Builder(this).apply(block).build()
public class Builder {
/**
* The name of the component.
*/
public var componentName: kotlin.String? = null
/**
* This string specifies the path to the composite component, starting from the top-level component.
*/
public var componentPath: kotlin.String? = null
/**
* The ID of the component type.
*/
public var componentTypeId: kotlin.String? = null
/**
* The date and time of the latest property value to return.
*/
@Deprecated("No longer recommended for use. See AWS API documentation for more details.")
public var endDateTime: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The ISO8601 DateTime of the latest property value to return.
*
* For more information about the ISO8601 DateTime format, see the data type [PropertyValue](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html).
*/
public var endTime: kotlin.String? = null
/**
* The ID of the entity.
*/
public var entityId: kotlin.String? = null
/**
* An object that specifies the interpolation type and the interval over which to interpolate data.
*/
public var interpolation: aws.sdk.kotlin.services.iottwinmaker.model.InterpolationParameters? = null
/**
* The maximum number of results to return at one time. The default is 25.
*
* Valid Range: Minimum value of 1. Maximum value of 250.
*/
public var maxResults: kotlin.Int? = null
/**
* The string that specifies the next page of results.
*/
public var nextToken: kotlin.String? = null
/**
* The time direction to use in the result order.
*/
public var orderByTime: aws.sdk.kotlin.services.iottwinmaker.model.OrderByTime? = null
/**
* A list of objects that filter the property value history request.
*/
public var propertyFilters: List? = null
/**
* A list of properties whose value histories the request retrieves.
*/
public var selectedProperties: List? = null
/**
* The date and time of the earliest property value to return.
*/
@Deprecated("No longer recommended for use. See AWS API documentation for more details.")
public var startDateTime: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The ISO8601 DateTime of the earliest property value to return.
*
* For more information about the ISO8601 DateTime format, see the data type [PropertyValue](https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html).
*/
public var startTime: kotlin.String? = null
/**
* The ID of the workspace.
*/
public var workspaceId: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.iottwinmaker.model.GetPropertyValueHistoryRequest) : this() {
this.componentName = x.componentName
this.componentPath = x.componentPath
this.componentTypeId = x.componentTypeId
this.endDateTime = x.endDateTime
this.endTime = x.endTime
this.entityId = x.entityId
this.interpolation = x.interpolation
this.maxResults = x.maxResults
this.nextToken = x.nextToken
this.orderByTime = x.orderByTime
this.propertyFilters = x.propertyFilters
this.selectedProperties = x.selectedProperties
this.startDateTime = x.startDateTime
this.startTime = x.startTime
this.workspaceId = x.workspaceId
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.iottwinmaker.model.GetPropertyValueHistoryRequest = GetPropertyValueHistoryRequest(this)
/**
* construct an [aws.sdk.kotlin.services.iottwinmaker.model.InterpolationParameters] inside the given [block]
*/
public fun interpolation(block: aws.sdk.kotlin.services.iottwinmaker.model.InterpolationParameters.Builder.() -> kotlin.Unit) {
this.interpolation = aws.sdk.kotlin.services.iottwinmaker.model.InterpolationParameters.invoke(block)
}
internal fun correctErrors(): Builder {
if (selectedProperties == null) selectedProperties = emptyList()
if (workspaceId == null) workspaceId = ""
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy