software.amazon.awscdk.integtests.alpha.WaiterStateMachineOptions Maven / Gradle / Ivy
Show all versions of cdk-integ-tests-alpha Show documentation
package software.amazon.awscdk.integtests.alpha;
/**
* (experimental) Options for creating a WaiterStateMachine.
*
* Example:
*
*
* IntegTest testCase;
* IApiCall start;
* IApiCall describe = testCase.assertions.awsApiCall("StepFunctions", "describeExecution", Map.of(
* "executionArn", start.getAttString("executionArn"))).expect(ExpectedResult.objectLike(Map.of(
* "status", "SUCCEEDED"))).waitForAssertions(WaiterStateMachineOptions.builder()
* .totalTimeout(Duration.minutes(5))
* .interval(Duration.seconds(15))
* .backoffRate(3)
* .build());
*
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-05T03:43:53.058Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.integtests.alpha.$Module.class, fqn = "@aws-cdk/integ-tests-alpha.WaiterStateMachineOptions")
@software.amazon.jsii.Jsii.Proxy(WaiterStateMachineOptions.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface WaiterStateMachineOptions extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) Backoff between attempts.
*
* This is the multiplier by which the retry interval increases
* after each retry attempt.
*
* By default there is no backoff. Each retry will wait the amount of time
* specified by interval.
*
* Default: 1 (no backoff)
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable java.lang.Number getBackoffRate() {
return null;
}
/**
* (experimental) The interval (number of seconds) to wait between attempts.
*
* Default: Duration.seconds(5)
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.Duration getInterval() {
return null;
}
/**
* (experimental) The total time that the state machine will wait for a successful response.
*
* Default: Duration.minutes(30)
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
default @org.jetbrains.annotations.Nullable software.amazon.awscdk.Duration getTotalTimeout() {
return null;
}
/**
* @return a {@link Builder} of {@link WaiterStateMachineOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link WaiterStateMachineOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Number backoffRate;
software.amazon.awscdk.Duration interval;
software.amazon.awscdk.Duration totalTimeout;
/**
* Sets the value of {@link WaiterStateMachineOptions#getBackoffRate}
* @param backoffRate Backoff between attempts.
* This is the multiplier by which the retry interval increases
* after each retry attempt.
*
* By default there is no backoff. Each retry will wait the amount of time
* specified by interval.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder backoffRate(java.lang.Number backoffRate) {
this.backoffRate = backoffRate;
return this;
}
/**
* Sets the value of {@link WaiterStateMachineOptions#getInterval}
* @param interval The interval (number of seconds) to wait between attempts.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder interval(software.amazon.awscdk.Duration interval) {
this.interval = interval;
return this;
}
/**
* Sets the value of {@link WaiterStateMachineOptions#getTotalTimeout}
* @param totalTimeout The total time that the state machine will wait for a successful response.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder totalTimeout(software.amazon.awscdk.Duration totalTimeout) {
this.totalTimeout = totalTimeout;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link WaiterStateMachineOptions}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public WaiterStateMachineOptions build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link WaiterStateMachineOptions}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements WaiterStateMachineOptions {
private final java.lang.Number backoffRate;
private final software.amazon.awscdk.Duration interval;
private final software.amazon.awscdk.Duration totalTimeout;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.backoffRate = software.amazon.jsii.Kernel.get(this, "backoffRate", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.interval = software.amazon.jsii.Kernel.get(this, "interval", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.Duration.class));
this.totalTimeout = software.amazon.jsii.Kernel.get(this, "totalTimeout", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.Duration.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.backoffRate = builder.backoffRate;
this.interval = builder.interval;
this.totalTimeout = builder.totalTimeout;
}
@Override
public final java.lang.Number getBackoffRate() {
return this.backoffRate;
}
@Override
public final software.amazon.awscdk.Duration getInterval() {
return this.interval;
}
@Override
public final software.amazon.awscdk.Duration getTotalTimeout() {
return this.totalTimeout;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
if (this.getBackoffRate() != null) {
data.set("backoffRate", om.valueToTree(this.getBackoffRate()));
}
if (this.getInterval() != null) {
data.set("interval", om.valueToTree(this.getInterval()));
}
if (this.getTotalTimeout() != null) {
data.set("totalTimeout", om.valueToTree(this.getTotalTimeout()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@aws-cdk/integ-tests-alpha.WaiterStateMachineOptions"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
WaiterStateMachineOptions.Jsii$Proxy that = (WaiterStateMachineOptions.Jsii$Proxy) o;
if (this.backoffRate != null ? !this.backoffRate.equals(that.backoffRate) : that.backoffRate != null) return false;
if (this.interval != null ? !this.interval.equals(that.interval) : that.interval != null) return false;
return this.totalTimeout != null ? this.totalTimeout.equals(that.totalTimeout) : that.totalTimeout == null;
}
@Override
public final int hashCode() {
int result = this.backoffRate != null ? this.backoffRate.hashCode() : 0;
result = 31 * result + (this.interval != null ? this.interval.hashCode() : 0);
result = 31 * result + (this.totalTimeout != null ? this.totalTimeout.hashCode() : 0);
return result;
}
}
}