Interface RegionOfInterest.Builder

All Superinterfaces:

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

Enclosing class:

RegionOfInterest

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

Method Summary

Modifier and Type	Method	Description
default RegionOfInterest.Builder	boundingBox(Consumer<BoundingBox.Builder> boundingBox)	The box representing a region of interest on screen.
RegionOfInterest.Builder	boundingBox(BoundingBox boundingBox)	The box representing a region of interest on screen.
RegionOfInterest.Builder	polygon(Collection<Point> polygon)	Specifies a shape made up of up to 10 Point objects to define a region of interest.
RegionOfInterest.Builder	polygon(Consumer<Point.Builder>... polygon)	Specifies a shape made up of up to 10 Point objects to define a region of interest.
RegionOfInterest.Builder	polygon(Point... polygon)	Specifies a shape made up of up to 10 Point objects to define a region of interest.

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, sdkFieldNameToField, sdkFields

Method Details

boundingBox

RegionOfInterest.Builder boundingBox(BoundingBox boundingBox)

The box representing a region of interest on screen.

Parameters:

boundingBox - The box representing a region of interest on screen.

Returns:

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

boundingBox

default RegionOfInterest.Builder boundingBox(Consumer<BoundingBox.Builder> boundingBox)

The box representing a region of interest on screen.

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

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

Parameters:

boundingBox - a consumer that will call methods on BoundingBox.Builder

Returns:

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

See Also:

• boundingBox(BoundingBox)

polygon

RegionOfInterest.Builder polygon(Collection<Point> polygon)

Specifies a shape made up of up to 10 Point objects to define a region of interest.

Parameters:

polygon - Specifies a shape made up of up to 10 Point objects to define a region of interest.

Returns:

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

polygon

RegionOfInterest.Builder polygon(Point... polygon)

Specifies a shape made up of up to 10 Point objects to define a region of interest.

Parameters:

polygon - Specifies a shape made up of up to 10 Point objects to define a region of interest.

Returns:

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

polygon

RegionOfInterest.Builder polygon(Consumer<Point.Builder>... polygon)

Specifies a shape made up of up to 10 Point objects to define a region of interest.

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

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

Parameters:

polygon - a consumer that will call methods on Point.Builder

Returns:

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

See Also:

• polygon(java.util.Collection<Point>)