software.amazon.awssdk.services.iotthingsgraph.model

Interface SystemInstanceDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SystemInstanceDescription.Builder,SystemInstanceDescription>, SdkBuilder<SystemInstanceDescription.Builder,SystemInstanceDescription>, SdkPojo

Enclosing class:

SystemInstanceDescription

public static interface SystemInstanceDescription.Builder
extends SdkPojo, CopyableBuilder<SystemInstanceDescription.Builder,SystemInstanceDescription>

Method Summary

Modifier and Type	Method and Description
default SystemInstanceDescription.Builder	definition(Consumer<DefinitionDocument.Builder> definition) Sets the value of the Definition property for this object.
SystemInstanceDescription.Builder	definition(DefinitionDocument definition) Sets the value of the Definition property for this object.
SystemInstanceDescription.Builder	flowActionsRoleArn(String flowActionsRoleArn) The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment.
default SystemInstanceDescription.Builder	metricsConfiguration(Consumer<MetricsConfiguration.Builder> metricsConfiguration) Sets the value of the MetricsConfiguration property for this object.
SystemInstanceDescription.Builder	metricsConfiguration(MetricsConfiguration metricsConfiguration) Sets the value of the MetricsConfiguration property for this object.
SystemInstanceDescription.Builder	s3BucketName(String s3BucketName) The Amazon Simple Storage Service bucket where information about a system instance is stored.
default SystemInstanceDescription.Builder	summary(Consumer<SystemInstanceSummary.Builder> summary) An object that contains summary information about a system instance.
SystemInstanceDescription.Builder	summary(SystemInstanceSummary summary) An object that contains summary information about a system instance.
SystemInstanceDescription.Builder	validatedDependencyRevisions(Collection<DependencyRevision> validatedDependencyRevisions) A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
SystemInstanceDescription.Builder	validatedDependencyRevisions(Consumer<DependencyRevision.Builder>... validatedDependencyRevisions) A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
SystemInstanceDescription.Builder	validatedDependencyRevisions(DependencyRevision... validatedDependencyRevisions) A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.
SystemInstanceDescription.Builder	validatedNamespaceVersion(Long validatedNamespaceVersion) The version of the user's namespace against which the system instance was validated.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

summary

SystemInstanceDescription.Builder summary(SystemInstanceSummary summary)

An object that contains summary information about a system instance.

Parameters:

summary - An object that contains summary information about a system instance.

Returns:

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

summary

default SystemInstanceDescription.Builder summary(Consumer<SystemInstanceSummary.Builder> summary)

An object that contains summary information about a system instance.

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

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

Parameters:

summary - a consumer that will call methods on SystemInstanceSummary.Builder

Returns:

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

See Also:

summary(SystemInstanceSummary)

definition

SystemInstanceDescription.Builder definition(DefinitionDocument definition)

Sets the value of the Definition property for this object.

Parameters:

definition - The new value for the Definition property for this object.

Returns:

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

definition

default SystemInstanceDescription.Builder definition(Consumer<DefinitionDocument.Builder> definition)

Sets the value of the Definition property for this object. This is a convenience method that creates an instance of the DefinitionDocument.Builder avoiding the need to create one manually via DefinitionDocument.builder().

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

Parameters:

definition - a consumer that will call methods on DefinitionDocument.Builder

Returns:

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

See Also:

definition(DefinitionDocument)

s3BucketName

SystemInstanceDescription.Builder s3BucketName(String s3BucketName)

The Amazon Simple Storage Service bucket where information about a system instance is stored.

Parameters:

s3BucketName - The Amazon Simple Storage Service bucket where information about a system instance is stored.

Returns:

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

metricsConfiguration

SystemInstanceDescription.Builder metricsConfiguration(MetricsConfiguration metricsConfiguration)

Sets the value of the MetricsConfiguration property for this object.

Parameters:

metricsConfiguration - The new value for the MetricsConfiguration property for this object.

Returns:

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

metricsConfiguration

default SystemInstanceDescription.Builder metricsConfiguration(Consumer<MetricsConfiguration.Builder> metricsConfiguration)

Sets the value of the MetricsConfiguration property for this object. This is a convenience method that creates an instance of the MetricsConfiguration.Builder avoiding the need to create one manually via MetricsConfiguration.builder().

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

Parameters:

metricsConfiguration - a consumer that will call methods on MetricsConfiguration.Builder

Returns:

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

See Also:

metricsConfiguration(MetricsConfiguration)

validatedNamespaceVersion

SystemInstanceDescription.Builder validatedNamespaceVersion(Long validatedNamespaceVersion)

The version of the user's namespace against which the system instance was validated.

Parameters:

validatedNamespaceVersion - The version of the user's namespace against which the system instance was validated.

Returns:

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

validatedDependencyRevisions

SystemInstanceDescription.Builder validatedDependencyRevisions(Collection<DependencyRevision> validatedDependencyRevisions)

A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

Parameters:

validatedDependencyRevisions - A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

Returns:

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

validatedDependencyRevisions

SystemInstanceDescription.Builder validatedDependencyRevisions(DependencyRevision... validatedDependencyRevisions)

A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

Parameters:

validatedDependencyRevisions - A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

Returns:

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

validatedDependencyRevisions

SystemInstanceDescription.Builder validatedDependencyRevisions(Consumer<DependencyRevision.Builder>... validatedDependencyRevisions)

A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #validatedDependencyRevisions(List).

Parameters:

validatedDependencyRevisions - a consumer that will call methods on DependencyRevision.Builder

Returns:

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

See Also:

#validatedDependencyRevisions(java.util.Collection)

flowActionsRoleArn

SystemInstanceDescription.Builder flowActionsRoleArn(String flowActionsRoleArn)

The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

Parameters:

flowActionsRoleArn - The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

Returns:

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