Interface TemplateVersion.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<TemplateVersion.Builder,
,TemplateVersion> SdkBuilder<TemplateVersion.Builder,
,TemplateVersion> SdkPojo
- Enclosing class:
TemplateVersion
-
Method Summary
Modifier and TypeMethodDescriptioncreatedTime
(Instant createdTime) The time that this template version was created.dataSetConfigurations
(Collection<DataSetConfiguration> dataSetConfigurations) Schema of the dataset identified by the placeholder.dataSetConfigurations
(Consumer<DataSetConfiguration.Builder>... dataSetConfigurations) Schema of the dataset identified by the placeholder.dataSetConfigurations
(DataSetConfiguration... dataSetConfigurations) Schema of the dataset identified by the placeholder.description
(String description) The description of the template.errors
(Collection<TemplateError> errors) Errors associated with this template version.errors
(Consumer<TemplateError.Builder>... errors) Errors associated with this template version.errors
(TemplateError... errors) Errors associated with this template version.sheets
(Collection<Sheet> sheets) A list of the associated sheets with the unique identifier and name of each sheet.sheets
(Consumer<Sheet.Builder>... sheets) A list of the associated sheets with the unique identifier and name of each sheet.A list of the associated sheets with the unique identifier and name of each sheet.sourceEntityArn
(String sourceEntityArn) The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.The status that is associated with the template.status
(ResourceStatus status) The status that is associated with the template.The ARN of the theme associated with this version of the template.versionNumber
(Long versionNumber) The version number of the template version.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
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
-
createdTime
The time that this template version was created.
- Parameters:
createdTime
- The time that this template version was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errors
Errors associated with this template version.
- Parameters:
errors
- Errors associated with this template version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errors
Errors associated with this template version.
- Parameters:
errors
- Errors associated with this template version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
errors
Errors associated with this template version.
This is a convenience method that creates an instance of theTemplateError.Builder
avoiding the need to create one manually viaTemplateError.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toerrors(List<TemplateError>)
.- Parameters:
errors
- a consumer that will call methods onTemplateError.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
versionNumber
The version number of the template version.
- Parameters:
versionNumber
- The version number of the template version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
The status that is associated with the template.
-
CREATION_IN_PROGRESS
-
CREATION_SUCCESSFUL
-
CREATION_FAILED
-
UPDATE_IN_PROGRESS
-
UPDATE_SUCCESSFUL
-
UPDATE_FAILED
-
DELETED
- Parameters:
status
- The status that is associated with the template.-
CREATION_IN_PROGRESS
-
CREATION_SUCCESSFUL
-
CREATION_FAILED
-
UPDATE_IN_PROGRESS
-
UPDATE_SUCCESSFUL
-
UPDATE_FAILED
-
DELETED
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
status
The status that is associated with the template.
-
CREATION_IN_PROGRESS
-
CREATION_SUCCESSFUL
-
CREATION_FAILED
-
UPDATE_IN_PROGRESS
-
UPDATE_SUCCESSFUL
-
UPDATE_FAILED
-
DELETED
- Parameters:
status
- The status that is associated with the template.-
CREATION_IN_PROGRESS
-
CREATION_SUCCESSFUL
-
CREATION_FAILED
-
UPDATE_IN_PROGRESS
-
UPDATE_SUCCESSFUL
-
UPDATE_FAILED
-
DELETED
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
dataSetConfigurations
TemplateVersion.Builder dataSetConfigurations(Collection<DataSetConfiguration> dataSetConfigurations) Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
- Parameters:
dataSetConfigurations
- Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSetConfigurations
Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
- Parameters:
dataSetConfigurations
- Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSetConfigurations
TemplateVersion.Builder dataSetConfigurations(Consumer<DataSetConfiguration.Builder>... dataSetConfigurations) Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
This is a convenience method that creates an instance of theDataSetConfiguration.Builder
avoiding the need to create one manually viaDataSetConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataSetConfigurations(List<DataSetConfiguration>)
.- Parameters:
dataSetConfigurations
- a consumer that will call methods onDataSetConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
The description of the template.
- Parameters:
description
- The description of the template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceEntityArn
The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
- Parameters:
sourceEntityArn
- The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
themeArn
The ARN of the theme associated with this version of the template.
- Parameters:
themeArn
- The ARN of the theme associated with this version of the template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sheets
A list of the associated sheets with the unique identifier and name of each sheet.
- Parameters:
sheets
- A list of the associated sheets with the unique identifier and name of each sheet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sheets
A list of the associated sheets with the unique identifier and name of each sheet.
- Parameters:
sheets
- A list of the associated sheets with the unique identifier and name of each sheet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sheets
A list of the associated sheets with the unique identifier and name of each sheet.
This is a convenience method that creates an instance of theSheet.Builder
avoiding the need to create one manually viaSheet.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosheets(List<Sheet>)
.- Parameters:
sheets
- a consumer that will call methods onSheet.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-