Interface GetPropertyValueHistoryRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetPropertyValueHistoryRequest.Builder,GetPropertyValueHistoryRequest>, IoTTwinMakerRequest.Builder, SdkBuilder<GetPropertyValueHistoryRequest.Builder,GetPropertyValueHistoryRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetPropertyValueHistoryRequest

@Mutable
@NotThreadSafe
public static interface GetPropertyValueHistoryRequest.Builder
extends IoTTwinMakerRequest.Builder, SdkPojo, CopyableBuilder<GetPropertyValueHistoryRequest.Builder,GetPropertyValueHistoryRequest>

Method Summary

Modifier and Type	Method	Description
GetPropertyValueHistoryRequest.Builder	componentName(String componentName)	The name of the component.
GetPropertyValueHistoryRequest.Builder	componentPath(String componentPath)	This string specifies the path to the composite component, starting from the top-level component.
GetPropertyValueHistoryRequest.Builder	componentTypeId(String componentTypeId)	The ID of the component type.
GetPropertyValueHistoryRequest.Builder	endDateTime(Instant endDateTime)	Deprecated. This field is deprecated and will throw an error in the future.
GetPropertyValueHistoryRequest.Builder	endTime(String endTime)	The ISO8601 DateTime of the latest property value to return.
GetPropertyValueHistoryRequest.Builder	entityId(String entityId)	The ID of the entity.
default GetPropertyValueHistoryRequest.Builder	interpolation(Consumer<InterpolationParameters.Builder> interpolation)	An object that specifies the interpolation type and the interval over which to interpolate data.
GetPropertyValueHistoryRequest.Builder	interpolation(InterpolationParameters interpolation)	An object that specifies the interpolation type and the interval over which to interpolate data.
GetPropertyValueHistoryRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return at one time.
GetPropertyValueHistoryRequest.Builder	nextToken(String nextToken)	The string that specifies the next page of results.
GetPropertyValueHistoryRequest.Builder	orderByTime(String orderByTime)	The time direction to use in the result order.
GetPropertyValueHistoryRequest.Builder	orderByTime(OrderByTime orderByTime)	The time direction to use in the result order.
GetPropertyValueHistoryRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
GetPropertyValueHistoryRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
GetPropertyValueHistoryRequest.Builder	propertyFilters(Collection<PropertyFilter> propertyFilters)	A list of objects that filter the property value history request.
GetPropertyValueHistoryRequest.Builder	propertyFilters(Consumer<PropertyFilter.Builder>... propertyFilters)	A list of objects that filter the property value history request.
GetPropertyValueHistoryRequest.Builder	propertyFilters(PropertyFilter... propertyFilters)	A list of objects that filter the property value history request.
GetPropertyValueHistoryRequest.Builder	selectedProperties(String... selectedProperties)	A list of properties whose value histories the request retrieves.
GetPropertyValueHistoryRequest.Builder	selectedProperties(Collection<String> selectedProperties)	A list of properties whose value histories the request retrieves.
GetPropertyValueHistoryRequest.Builder	startDateTime(Instant startDateTime)	Deprecated. This field is deprecated and will throw an error in the future.
GetPropertyValueHistoryRequest.Builder	startTime(String startTime)	The ISO8601 DateTime of the earliest property value to return.
GetPropertyValueHistoryRequest.Builder	workspaceId(String workspaceId)	The ID of the workspace.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

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.

propertyFilters

GetPropertyValueHistoryRequest.Builder propertyFilters(Consumer<PropertyFilter.Builder>... propertyFilters)

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

This is a convenience method that creates an instance of the PropertyFilter.Builder avoiding the need to create one manually via PropertyFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to propertyFilters(List<PropertyFilter>).

Parameters:

propertyFilters - a consumer that will call methods on PropertyFilter.Builder

Returns:

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

See Also:

• propertyFilters(java.util.Collection<PropertyFilter>)

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.

interpolation

default GetPropertyValueHistoryRequest.Builder interpolation(Consumer<InterpolationParameters.Builder> interpolation)

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

This is a convenience method that creates an instance of the InterpolationParameters.Builder avoiding the need to create one manually via InterpolationParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to interpolation(InterpolationParameters).

Parameters:

interpolation - a consumer that will call methods on InterpolationParameters.Builder

Returns:

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

See Also:

• interpolation(InterpolationParameters)

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

orderByTime

GetPropertyValueHistoryRequest.Builder orderByTime(OrderByTime 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.

overrideConfiguration

GetPropertyValueHistoryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

GetPropertyValueHistoryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.