Package io.github.cdklabs.cdk.ecs.codedeploy

Class ApiTestStep.Builder

java.lang.Object

io.github.cdklabs.cdk.ecs.codedeploy.ApiTestStep.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiTestStep>

Enclosing interface:

ApiTestStep

@Stability(Experimental)
public static final class ApiTestStep.Builder
extends Object
implements software.amazon.jsii.Builder<ApiTestStep>

A builder for ApiTestStep

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ApiTestStep.Builder	body(String body)	Sets the value of ApiTestStep.getBody()
ApiTestStep	build()	Builds the configured instance.
ApiTestStep.Builder	expectedValue(Object expectedValue)	Sets the value of ApiTestStep.getExpectedValue()
ApiTestStep.Builder	headers(Map<String,String> headers)	Sets the value of ApiTestStep.getHeaders()
ApiTestStep.Builder	jmesPath(String jmesPath)	Sets the value of ApiTestStep.getJmesPath()
ApiTestStep.Builder	method(String method)	Sets the value of ApiTestStep.getMethod()
ApiTestStep.Builder	name(String name)	Sets the value of ApiTestStep.getName()
ApiTestStep.Builder	path(String path)	Sets the value of ApiTestStep.getPath()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

name

@Stability(Experimental)
public ApiTestStep.Builder name(String name)

Sets the value of ApiTestStep.getName()

Parameters:

name - Name of test. This parameter is required.

Returns:

this

path

@Stability(Experimental)
public ApiTestStep.Builder path(String path)

Sets the value of ApiTestStep.getPath()

Parameters:

path - Path of HTTP request, relative to baseUrl. This parameter is required.

Returns:

this

body

@Stability(Experimental)
public ApiTestStep.Builder body(String body)

Sets the value of ApiTestStep.getBody()

Parameters:

body - Optional body to include in HTTP request.

Returns:

this

expectedValue

@Stability(Experimental)
public ApiTestStep.Builder expectedValue(Object expectedValue)

Sets the value of ApiTestStep.getExpectedValue()

Parameters:

expectedValue - Expected value to compare against the jmesPath.

Returns:

this

headers

@Stability(Experimental)
public ApiTestStep.Builder headers(Map<String,String> headers)

Sets the value of ApiTestStep.getHeaders()

Parameters:

headers - Optional headers to include in HTTP request.

Returns:

this

jmesPath

@Stability(Experimental)
public ApiTestStep.Builder jmesPath(String jmesPath)

Sets the value of ApiTestStep.getJmesPath()

Parameters:

jmesPath - JMESPath to apply against the response from the HTTP request and compare against expected value.

Returns:

this

method

@Stability(Experimental)
public ApiTestStep.Builder method(String method)

Sets the value of ApiTestStep.getMethod()

Parameters:

method - Optional method to for HTTP request.

Returns:

this

build

@Stability(Experimental)
public ApiTestStep build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ApiTestStep>

Returns:

a new instance of ApiTestStep

Throws:

NullPointerException - if any required attribute was not provided