Package software.amazon.smithy.smoketests.traits

Class SmokeTestCase.Builder

java.lang.Object

software.amazon.smithy.smoketests.traits.SmokeTestCase.Builder

All Implemented Interfaces:

SmithyBuilder<SmokeTestCase>

Enclosing class:

SmokeTestCase

public static final class SmokeTestCase.Builder
extends java.lang.Object
implements SmithyBuilder<SmokeTestCase>

Method Summary

Modifier and Type	Method	Description
SmokeTestCase	build()	Creates an immutable object that is created from the properties that have been set on the builder.
SmokeTestCase.Builder	expectation(Expectation expectation)	Sets the expected response of the service call for the test case.
SmokeTestCase.Builder	id(java.lang.String id)	Sets the smoke test case ID.
SmokeTestCase.Builder	params(ObjectNode params)	Sets the input parameters to the operation targeted by the smoke test case.
SmokeTestCase.Builder	tags(java.util.List<java.lang.String> tags)	Sets the tags that can be used to categorize and group test cases.
SmokeTestCase.Builder	vendorParams(ObjectNode vendorParams)	Sets vendor-specific parameters for the test case which can be used to influence the request.
SmokeTestCase.Builder	vendorParamsShape(ShapeId vendorParamsShape)	Sets the shape ID of vendor-specific parameters for the test case.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public SmokeTestCase.Builder id(java.lang.String id)

Sets the smoke test case ID.

Must be unique across all smoke test cases on other operations bound to the same service.

Must match the following regex: ^[A-Za-z_][A-Za-z0-9_]+$

Parameters:

id - Test case ID.

Returns:

Returns the builder.

params

public SmokeTestCase.Builder params(ObjectNode params)

Sets the input parameters to the operation targeted by the smoke test case.

These parameters must be compatible with the operation's input.

Parameters:

params - Test case operation input parameters.

Returns:

Returns the builder.

vendorParams

public SmokeTestCase.Builder vendorParams(ObjectNode vendorParams)

Sets vendor-specific parameters for the test case which can be used to influence the request.

If vendorParamsShape(ShapeId) is set, these parameters must match that shape's definition.

Parameters:

vendorParams - Vendor-specific parameters for the test case.

Returns:

Returns the builder.

vendorParamsShape

public SmokeTestCase.Builder vendorParamsShape(ShapeId vendorParamsShape)

Sets the shape ID of vendor-specific parameters for the test case.

If set, vendorParams(ObjectNode) must be compatible with this shape's definition

Parameters:

vendorParamsShape - Shape ID of vendor-specific parameters.

Returns:

Returns the builder.

expectation

public SmokeTestCase.Builder expectation(Expectation expectation)

Sets the expected response of the service call for the test case.

Parameters:

expectation - Expected response of the service call.

Returns:

Returns the builder.

tags

public SmokeTestCase.Builder tags(java.util.List<java.lang.String> tags)

Sets the tags that can be used to categorize and group test cases.

Parameters:

tags - Tags to attach to the test case.

Returns:

Returns the builder.

build

public SmokeTestCase build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface SmithyBuilder<SmokeTestCase>

Returns:

an instance of T