Interface GetPropertyValueHistoryRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetPropertyValueHistoryRequest.Builder,
,GetPropertyValueHistoryRequest> IoTTwinMakerRequest.Builder
,SdkBuilder<GetPropertyValueHistoryRequest.Builder,
,GetPropertyValueHistoryRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetPropertyValueHistoryRequest
-
Method Summary
Modifier and TypeMethodDescriptioncomponentName
(String componentName) The name of the component.componentPath
(String componentPath) This string specifies the path to the composite component, starting from the top-level component.componentTypeId
(String componentTypeId) The ID of the component type.endDateTime
(Instant endDateTime) Deprecated.This field is deprecated and will throw an error in the future.The ISO8601 DateTime of the latest property value to return.The ID of the entity.interpolation
(Consumer<InterpolationParameters.Builder> interpolation) An object that specifies the interpolation type and the interval over which to interpolate data.interpolation
(InterpolationParameters interpolation) An object that specifies the interpolation type and the interval over which to interpolate data.maxResults
(Integer maxResults) The maximum number of results to return at one time.The string that specifies the next page of results.orderByTime
(String orderByTime) The time direction to use in the result order.orderByTime
(OrderByTime orderByTime) The time direction to use in the result order.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.propertyFilters
(Collection<PropertyFilter> propertyFilters) A list of objects that filter the property value history request.propertyFilters
(Consumer<PropertyFilter.Builder>... propertyFilters) A list of objects that filter the property value history request.propertyFilters
(PropertyFilter... propertyFilters) A list of objects that filter the property value history request.selectedProperties
(String... selectedProperties) A list of properties whose value histories the request retrieves.selectedProperties
(Collection<String> selectedProperties) A list of properties whose value histories the request retrieves.startDateTime
(Instant startDateTime) Deprecated.This field is deprecated and will throw an error in the future.The ISO8601 DateTime of the earliest property value to return.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, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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
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 thePropertyFilter.Builder
avoiding the need to create one manually viaPropertyFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topropertyFilters(List<PropertyFilter>)
.- Parameters:
propertyFilters
- a consumer that will call methods onPropertyFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.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
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 theInterpolationParameters.Builder
avoiding the need to create one manually viaInterpolationParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tointerpolation(InterpolationParameters)
.- Parameters:
interpolation
- a consumer that will call methods onInterpolationParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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:
-
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
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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-