Package software.amazon.awssdk.services.iottwinmaker.model

Interface GetPropertyValueHistoryRequest.Builder

    • Method Detail

      • workspaceId

        GetPropertyValueHistoryRequest.Builder workspaceId​(String workspaceId)

        The ID of the workspace.

        Parameters:
        workspaceId - The ID of the workspace.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • entityId

        GetPropertyValueHistoryRequest.Builder entityId​(String entityId)

        The ID of the entity.

        Parameters:
        entityId - The ID of the entity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • componentName

        GetPropertyValueHistoryRequest.Builder componentName​(String componentName)

        The name of the component.

        Parameters:
        componentName - The name of the component.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • componentPath

        GetPropertyValueHistoryRequest.Builder componentPath​(String componentPath)

        This string specifies the path to the composite component, starting from the top-level component.

        Parameters:
        componentPath - This string specifies the path to the composite component, starting from the top-level component.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • componentTypeId

        GetPropertyValueHistoryRequest.Builder componentTypeId​(String componentTypeId)

        The ID of the component type.

        Parameters:
        componentTypeId - The ID of the component type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selectedProperties

        GetPropertyValueHistoryRequest.Builder selectedProperties​(Collection<String> selectedProperties)

        A list of properties whose value histories the request retrieves.

        Parameters:
        selectedProperties - A list of properties whose value histories the request retrieves.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • selectedProperties

        GetPropertyValueHistoryRequest.Builder selectedProperties​(String... selectedProperties)

        A list of properties whose value histories the request retrieves.

        Parameters:
        selectedProperties - A list of properties whose value histories the request retrieves.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • propertyFilters

        GetPropertyValueHistoryRequest.Builder propertyFilters​(Collection<PropertyFilter> propertyFilters)

        A list of objects that filter the property value history request.

        Parameters:
        propertyFilters - A list of objects that filter the property value history request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • propertyFilters

        GetPropertyValueHistoryRequest.Builder propertyFilters​(PropertyFilter... propertyFilters)

        A list of objects that filter the property value history request.

        Parameters:
        propertyFilters - A list of objects that filter the property value history request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startDateTime

        @Deprecated
GetPropertyValueHistoryRequest.Builder startDateTime​(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.

        Parameters:
        startDateTime - The date and time of the earliest property value to return.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endDateTime

        @Deprecated
GetPropertyValueHistoryRequest.Builder endDateTime​(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.

        Parameters:
        endDateTime - The date and time of the latest property value to return.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • interpolation

        GetPropertyValueHistoryRequest.Builder interpolation​(InterpolationParameters interpolation)

        An object that specifies the interpolation type and the interval over which to interpolate data.

        Parameters:
        interpolation - An object that specifies the interpolation type and the interval over which to interpolate data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        GetPropertyValueHistoryRequest.Builder nextToken​(String nextToken)

        The string that specifies the next page of results.

        Parameters:
        nextToken - The string that specifies the next page of results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        GetPropertyValueHistoryRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results to return at one time. The default is 25.

        Valid Range: Minimum value of 1. Maximum value of 250.

        Parameters:
        maxResults - The maximum number of results to return at one time. The default is 25.

        Valid Range: Minimum value of 1. Maximum value of 250.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • orderByTime

        GetPropertyValueHistoryRequest.Builder orderByTime​(String orderByTime)

        The time direction to use in the result order.

        Parameters:
        orderByTime - The time direction to use in the result order.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        OrderByTime, OrderByTime

      • startTime

        GetPropertyValueHistoryRequest.Builder startTime​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • endTime

        GetPropertyValueHistoryRequest.Builder endTime​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.