Package software.amazon.awssdk.services.iotsitewise.model

Class GetAssetPropertyAggregatesRequest

    • Method Detail

      • assetId

        public final String assetId()

        The ID of the asset, in UUID format.

        Returns:
        The ID of the asset, in UUID format.

      • propertyId

        public final String propertyId()

        The ID of the asset property, in UUID format.

        Returns:
        The ID of the asset property, in UUID format.

      • 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. 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.

        Returns:
        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.

      • 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