Condition (software.amazon.awscdk:stepfunctions 1.163.2 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.stepfunctions.Condition

All Implemented Interfaces:: software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-13T22:11:54.679Z")
 @Stability(value=Stable)
public abstract class Condition
extends software.amazon.jsii.JsiiObject

A Condition for use in a Choice state branch.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Function submitLambda;
 Function getStatusLambda;
 LambdaInvoke submitJob = LambdaInvoke.Builder.create(this, "Submit Job")
         .lambdaFunction(submitLambda)
         // Lambda's result is in the attribute `Payload`
         .outputPath("$.Payload")
         .build();
 Wait waitX = Wait.Builder.create(this, "Wait X Seconds")
         .time(WaitTime.secondsPath("$.waitSeconds"))
         .build();
 LambdaInvoke getStatus = LambdaInvoke.Builder.create(this, "Get Job Status")
         .lambdaFunction(getStatusLambda)
         // Pass just the field named "guid" into the Lambda, put the
         // Lambda's result in a field called "status" in the response
         .inputPath("$.guid")
         .outputPath("$.Payload")
         .build();
 Fail jobFailed = Fail.Builder.create(this, "Job Failed")
         .cause("AWS Batch Job Failed")
         .error("DescribeJob returned FAILED")
         .build();
 LambdaInvoke finalStatus = LambdaInvoke.Builder.create(this, "Get Final Job Status")
         .lambdaFunction(getStatusLambda)
         // Use "guid" field as input
         .inputPath("$.guid")
         .outputPath("$.Payload")
         .build();
 Chain definition = submitJob.next(waitX).next(getStatus).next(new Choice(this, "Job Complete?").when(Condition.stringEquals("$.status", "FAILED"), jobFailed).when(Condition.stringEquals("$.status", "SUCCEEDED"), finalStatus).otherwise(waitX));
 StateMachine.Builder.create(this, "StateMachine")
         .definition(definition)
         .timeout(Duration.minutes(5))
         .build();

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Condition()`
`protected`	`Condition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`Condition(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static Condition`	`and(Condition... conditions)` Combine two or more conditions with a logical AND.
`static Condition`	`booleanEquals(String variable, Boolean value)` Matches if a boolean field has the given value.
`static Condition`	`booleanEqualsJsonPath(String variable, String value)` Matches if a boolean field equals to a value at a given mapping path.
`static Condition`	`isBoolean(String variable)` Matches if variable is boolean.
`static Condition`	`isNotBoolean(String variable)` Matches if variable is not boolean.
`static Condition`	`isNotNull(String variable)` Matches if variable is not null.
`static Condition`	`isNotNumeric(String variable)` Matches if variable is not numeric.
`static Condition`	`isNotPresent(String variable)` Matches if variable is not present.
`static Condition`	`isNotString(String variable)` Matches if variable is not a string.
`static Condition`	`isNotTimestamp(String variable)` Matches if variable is not a timestamp.
`static Condition`	`isNull(String variable)` Matches if variable is Null.
`static Condition`	`isNumeric(String variable)` Matches if variable is numeric.
`static Condition`	`isPresent(String variable)` Matches if variable is present.
`static Condition`	`isString(String variable)` Matches if variable is a string.
`static Condition`	`isTimestamp(String variable)` Matches if variable is a timestamp.
`static Condition`	`not(Condition condition)` Negate a condition.
`static Condition`	`numberEquals(String variable, Number value)` Matches if a numeric field has the given value.
`static Condition`	`numberEqualsJsonPath(String variable, String value)` Matches if a numeric field has the value in a given mapping path.
`static Condition`	`numberGreaterThan(String variable, Number value)` Matches if a numeric field is greater than the given value.
`static Condition`	`numberGreaterThanEquals(String variable, Number value)` Matches if a numeric field is greater than or equal to the given value.
`static Condition`	`numberGreaterThanEqualsJsonPath(String variable, String value)` Matches if a numeric field is greater than or equal to the value at a given mapping path.
`static Condition`	`numberGreaterThanJsonPath(String variable, String value)` Matches if a numeric field is greater than the value at a given mapping path.
`static Condition`	`numberLessThan(String variable, Number value)` Matches if a numeric field is less than the given value.
`static Condition`	`numberLessThanEquals(String variable, Number value)` Matches if a numeric field is less than or equal to the given value.
`static Condition`	`numberLessThanEqualsJsonPath(String variable, String value)` Matches if a numeric field is less than or equal to the numeric value at given mapping path.
`static Condition`	`numberLessThanJsonPath(String variable, String value)` Matches if a numeric field is less than the value at the given mapping path.
`static Condition`	`or(Condition... conditions)` Combine two or more conditions with a logical OR.
`abstract Object`	`renderCondition()` Render Amazon States Language JSON for the condition.
`static Condition`	`stringEquals(String variable, String value)` Matches if a string field has the given value.
`static Condition`	`stringEqualsJsonPath(String variable, String value)` Matches if a string field equals to a value at a given mapping path.
`static Condition`	`stringGreaterThan(String variable, String value)` Matches if a string field sorts after a given value.
`static Condition`	`stringGreaterThanEquals(String variable, String value)` Matches if a string field sorts after or equal to a given value.
`static Condition`	`stringGreaterThanEqualsJsonPath(String variable, String value)` Matches if a string field sorts after or equal to value at a given mapping path.
`static Condition`	`stringGreaterThanJsonPath(String variable, String value)` Matches if a string field sorts after a value at a given mapping path.
`static Condition`	`stringLessThan(String variable, String value)` Matches if a string field sorts before a given value.
`static Condition`	`stringLessThanEquals(String variable, String value)` Matches if a string field sorts equal to or before a given value.
`static Condition`	`stringLessThanEqualsJsonPath(String variable, String value)` Matches if a string field sorts equal to or before a given mapping.
`static Condition`	`stringLessThanJsonPath(String variable, String value)` Matches if a string field sorts before a given value at a particular mapping.
`static Condition`	`stringMatches(String variable, String value)` Matches if a field matches a string pattern that can contain a wild card () e.g: log-.txt or LATEST.
`static Condition`	`timestampEquals(String variable, String value)` Matches if a timestamp field is the same time as the given timestamp.
`static Condition`	`timestampEqualsJsonPath(String variable, String value)` Matches if a timestamp field is the same time as the timestamp at a given mapping path.
`static Condition`	`timestampGreaterThan(String variable, String value)` Matches if a timestamp field is after the given timestamp.
`static Condition`	`timestampGreaterThanEquals(String variable, String value)` Matches if a timestamp field is after or equal to the given timestamp.
`static Condition`	`timestampGreaterThanEqualsJsonPath(String variable, String value)` Matches if a timestamp field is after or equal to the timestamp at a given mapping path.
`static Condition`	`timestampGreaterThanJsonPath(String variable, String value)` Matches if a timestamp field is after the timestamp at a given mapping path.
`static Condition`	`timestampLessThan(String variable, String value)` Matches if a timestamp field is before the given timestamp.
`static Condition`	`timestampLessThanEquals(String variable, String value)` Matches if a timestamp field is before or equal to the given timestamp.
`static Condition`	`timestampLessThanEqualsJsonPath(String variable, String value)` Matches if a timestamp field is before or equal to the timestamp at a given mapping path.
`static Condition`	`timestampLessThanJsonPath(String variable, String value)` Matches if a timestamp field is before the timestamp at a given mapping path.

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Constructor Detail

Condition

protected Condition(software.amazon.jsii.JsiiObjectRef objRef)

Condition

protected Condition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Condition

@Stability(value=Stable)
protected Condition()

Method Detail

and

@Stability(value=Stable)
 @NotNull
public static Condition and(@NotNull
                                                               Condition... conditions)

Combine two or more conditions with a logical AND.

Parameters:: conditions - This parameter is required.

booleanEquals

@Stability(value=Stable)
 @NotNull
public static Condition booleanEquals(@NotNull
                                                                         String variable,
                                                                         @NotNull
                                                                         Boolean value)

Matches if a boolean field has the given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

booleanEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition booleanEqualsJsonPath(@NotNull
                                                                                 String variable,
                                                                                 @NotNull
                                                                                 String value)

Matches if a boolean field equals to a value at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

isBoolean

@Stability(value=Stable)
 @NotNull
public static Condition isBoolean(@NotNull
                                                                     String variable)

Matches if variable is boolean.

Parameters:: variable - This parameter is required.

isNotBoolean

@Stability(value=Stable)
 @NotNull
public static Condition isNotBoolean(@NotNull
                                                                        String variable)

Matches if variable is not boolean.

Parameters:: variable - This parameter is required.

isNotNull

@Stability(value=Stable)
 @NotNull
public static Condition isNotNull(@NotNull
                                                                     String variable)

Matches if variable is not null.

Parameters:: variable - This parameter is required.

isNotNumeric

@Stability(value=Stable)
 @NotNull
public static Condition isNotNumeric(@NotNull
                                                                        String variable)

Matches if variable is not numeric.

Parameters:: variable - This parameter is required.

isNotPresent

@Stability(value=Stable)
 @NotNull
public static Condition isNotPresent(@NotNull
                                                                        String variable)

Matches if variable is not present.

Parameters:: variable - This parameter is required.

isNotString

@Stability(value=Stable)
 @NotNull
public static Condition isNotString(@NotNull
                                                                       String variable)

Matches if variable is not a string.

Parameters:: variable - This parameter is required.

isNotTimestamp

@Stability(value=Stable)
 @NotNull
public static Condition isNotTimestamp(@NotNull
                                                                          String variable)

Matches if variable is not a timestamp.

Parameters:: variable - This parameter is required.

isNull

@Stability(value=Stable)
 @NotNull
public static Condition isNull(@NotNull
                                                                  String variable)

Matches if variable is Null.

Parameters:: variable - This parameter is required.

isNumeric

@Stability(value=Stable)
 @NotNull
public static Condition isNumeric(@NotNull
                                                                     String variable)

Matches if variable is numeric.

Parameters:: variable - This parameter is required.

isPresent

@Stability(value=Stable)
 @NotNull
public static Condition isPresent(@NotNull
                                                                     String variable)

Matches if variable is present.

Parameters:: variable - This parameter is required.

isString

@Stability(value=Stable)
 @NotNull
public static Condition isString(@NotNull
                                                                    String variable)

Matches if variable is a string.

Parameters:: variable - This parameter is required.

isTimestamp

@Stability(value=Stable)
 @NotNull
public static Condition isTimestamp(@NotNull
                                                                       String variable)

Matches if variable is a timestamp.

Parameters:: variable - This parameter is required.

not

@Stability(value=Stable)
 @NotNull
public static Condition not(@NotNull
                                                               Condition condition)

Negate a condition.

Parameters:: condition - This parameter is required.

numberEquals

@Stability(value=Stable)
 @NotNull
public static Condition numberEquals(@NotNull
                                                                        String variable,
                                                                        @NotNull
                                                                        Number value)

Matches if a numeric field has the given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition numberEqualsJsonPath(@NotNull
                                                                                String variable,
                                                                                @NotNull
                                                                                String value)

Matches if a numeric field has the value in a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberGreaterThan

@Stability(value=Stable)
 @NotNull
public static Condition numberGreaterThan(@NotNull
                                                                             String variable,
                                                                             @NotNull
                                                                             Number value)

Matches if a numeric field is greater than the given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberGreaterThanEquals

@Stability(value=Stable)
 @NotNull
public static Condition numberGreaterThanEquals(@NotNull
                                                                                   String variable,
                                                                                   @NotNull
                                                                                   Number value)

Matches if a numeric field is greater than or equal to the given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberGreaterThanEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition numberGreaterThanEqualsJsonPath(@NotNull
                                                                                           String variable,
                                                                                           @NotNull
                                                                                           String value)

Matches if a numeric field is greater than or equal to the value at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberGreaterThanJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition numberGreaterThanJsonPath(@NotNull
                                                                                     String variable,
                                                                                     @NotNull
                                                                                     String value)

Matches if a numeric field is greater than the value at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberLessThan

@Stability(value=Stable)
 @NotNull
public static Condition numberLessThan(@NotNull
                                                                          String variable,
                                                                          @NotNull
                                                                          Number value)

Matches if a numeric field is less than the given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberLessThanEquals

@Stability(value=Stable)
 @NotNull
public static Condition numberLessThanEquals(@NotNull
                                                                                String variable,
                                                                                @NotNull
                                                                                Number value)

Matches if a numeric field is less than or equal to the given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberLessThanEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition numberLessThanEqualsJsonPath(@NotNull
                                                                                        String variable,
                                                                                        @NotNull
                                                                                        String value)

Matches if a numeric field is less than or equal to the numeric value at given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

numberLessThanJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition numberLessThanJsonPath(@NotNull
                                                                                  String variable,
                                                                                  @NotNull
                                                                                  String value)

Matches if a numeric field is less than the value at the given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

or

@Stability(value=Stable)
 @NotNull
public static Condition or(@NotNull
                                                              Condition... conditions)

Combine two or more conditions with a logical OR.

Parameters:: conditions - This parameter is required.

stringEquals

@Stability(value=Stable)
 @NotNull
public static Condition stringEquals(@NotNull
                                                                        String variable,
                                                                        @NotNull
                                                                        String value)

Matches if a string field has the given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition stringEqualsJsonPath(@NotNull
                                                                                String variable,
                                                                                @NotNull
                                                                                String value)

Matches if a string field equals to a value at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringGreaterThan

@Stability(value=Stable)
 @NotNull
public static Condition stringGreaterThan(@NotNull
                                                                             String variable,
                                                                             @NotNull
                                                                             String value)

Matches if a string field sorts after a given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringGreaterThanEquals

@Stability(value=Stable)
 @NotNull
public static Condition stringGreaterThanEquals(@NotNull
                                                                                   String variable,
                                                                                   @NotNull
                                                                                   String value)

Matches if a string field sorts after or equal to a given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringGreaterThanEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition stringGreaterThanEqualsJsonPath(@NotNull
                                                                                           String variable,
                                                                                           @NotNull
                                                                                           String value)

Matches if a string field sorts after or equal to value at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringGreaterThanJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition stringGreaterThanJsonPath(@NotNull
                                                                                     String variable,
                                                                                     @NotNull
                                                                                     String value)

Matches if a string field sorts after a value at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringLessThan

@Stability(value=Stable)
 @NotNull
public static Condition stringLessThan(@NotNull
                                                                          String variable,
                                                                          @NotNull
                                                                          String value)

Matches if a string field sorts before a given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringLessThanEquals

@Stability(value=Stable)
 @NotNull
public static Condition stringLessThanEquals(@NotNull
                                                                                String variable,
                                                                                @NotNull
                                                                                String value)

Matches if a string field sorts equal to or before a given value.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringLessThanEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition stringLessThanEqualsJsonPath(@NotNull
                                                                                        String variable,
                                                                                        @NotNull
                                                                                        String value)

Matches if a string field sorts equal to or before a given mapping.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringLessThanJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition stringLessThanJsonPath(@NotNull
                                                                                  String variable,
                                                                                  @NotNull
                                                                                  String value)

Matches if a string field sorts before a given value at a particular mapping.

Parameters:: variable - This parameter is required.; value - This parameter is required.

stringMatches

@Stability(value=Stable)
 @NotNull
public static Condition stringMatches(@NotNull
                                                                         String variable,
                                                                         @NotNull
                                                                         String value)

Matches if a field matches a string pattern that can contain a wild card (*) e.g: log-*.txt or *LATEST*. No other characters other than "*" have any special meaning - * can be escaped: \\*.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampEquals

@Stability(value=Stable)
 @NotNull
public static Condition timestampEquals(@NotNull
                                                                           String variable,
                                                                           @NotNull
                                                                           String value)

Matches if a timestamp field is the same time as the given timestamp.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition timestampEqualsJsonPath(@NotNull
                                                                                   String variable,
                                                                                   @NotNull
                                                                                   String value)

Matches if a timestamp field is the same time as the timestamp at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampGreaterThan

@Stability(value=Stable)
 @NotNull
public static Condition timestampGreaterThan(@NotNull
                                                                                String variable,
                                                                                @NotNull
                                                                                String value)

Matches if a timestamp field is after the given timestamp.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampGreaterThanEquals

@Stability(value=Stable)
 @NotNull
public static Condition timestampGreaterThanEquals(@NotNull
                                                                                      String variable,
                                                                                      @NotNull
                                                                                      String value)

Matches if a timestamp field is after or equal to the given timestamp.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampGreaterThanEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition timestampGreaterThanEqualsJsonPath(@NotNull
                                                                                              String variable,
                                                                                              @NotNull
                                                                                              String value)

Matches if a timestamp field is after or equal to the timestamp at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampGreaterThanJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition timestampGreaterThanJsonPath(@NotNull
                                                                                        String variable,
                                                                                        @NotNull
                                                                                        String value)

Matches if a timestamp field is after the timestamp at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampLessThan

@Stability(value=Stable)
 @NotNull
public static Condition timestampLessThan(@NotNull
                                                                             String variable,
                                                                             @NotNull
                                                                             String value)

Matches if a timestamp field is before the given timestamp.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampLessThanEquals

@Stability(value=Stable)
 @NotNull
public static Condition timestampLessThanEquals(@NotNull
                                                                                   String variable,
                                                                                   @NotNull
                                                                                   String value)

Matches if a timestamp field is before or equal to the given timestamp.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampLessThanEqualsJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition timestampLessThanEqualsJsonPath(@NotNull
                                                                                           String variable,
                                                                                           @NotNull
                                                                                           String value)

Matches if a timestamp field is before or equal to the timestamp at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

timestampLessThanJsonPath

@Stability(value=Stable)
 @NotNull
public static Condition timestampLessThanJsonPath(@NotNull
                                                                                     String variable,
                                                                                     @NotNull
                                                                                     String value)

Matches if a timestamp field is before the timestamp at a given mapping path.

Parameters:: variable - This parameter is required.; value - This parameter is required.

renderCondition

@Stability(value=Stable)
 @NotNull
public abstract Object renderCondition()

Render Amazon States Language JSON for the condition.

Class Condition

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Constructor Detail

Condition

Condition

Condition

Method Detail

and

booleanEquals

booleanEqualsJsonPath

isBoolean

isNotBoolean

isNotNull

isNotNumeric

isNotPresent

isNotString

isNotTimestamp

isNull

isNumeric

isPresent

isString

isTimestamp

not

numberEquals

numberEqualsJsonPath

numberGreaterThan

numberGreaterThanEquals

numberGreaterThanEqualsJsonPath

numberGreaterThanJsonPath

numberLessThan

numberLessThanEquals

numberLessThanEqualsJsonPath

numberLessThanJsonPath

or

stringEquals

stringEqualsJsonPath

stringGreaterThan

stringGreaterThanEquals

stringGreaterThanEqualsJsonPath

stringGreaterThanJsonPath

stringLessThan

stringLessThanEquals

stringLessThanEqualsJsonPath

stringLessThanJsonPath

stringMatches

timestampEquals

timestampEqualsJsonPath

timestampGreaterThan

timestampGreaterThanEquals

timestampGreaterThanEqualsJsonPath

timestampGreaterThanJsonPath

timestampLessThan

timestampLessThanEquals

timestampLessThanEqualsJsonPath

timestampLessThanJsonPath

renderCondition