Package software.amazon.awscdk.services.stepfunctions.tasks

Enum URLEncodingFormat

java.lang.Object
java.lang.Enum<URLEncodingFormat>
software.amazon.awscdk.services.stepfunctions.tasks.URLEncodingFormat
All Implemented Interfaces:
Serializable, Comparable<URLEncodingFormat>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:59.104Z") @Stability(Stable) public enum URLEncodingFormat extends Enum<URLEncodingFormat>
The style used when applying URL encoding to array values.

Example: 

 import software.amazon.awscdk.services.events.*;
 Connection connection = Connection.Builder.create(this, "Connection")
         .authorization(Authorization.basic("username", SecretValue.unsafePlainText("password")))
         .build();
 HttpInvoke.Builder.create(this, "Invoke HTTP API")
         .apiRoot("https://api.example.com")
         .apiEndpoint(TaskInput.fromText("https://api.example.com/path/to/resource"))
         .body(TaskInput.fromObject(Map.of("foo", "bar")))
         .connection(connection)
         .headers(TaskInput.fromObject(Map.of("Content-Type", "application/json")))
         .method(TaskInput.fromText("POST"))
         .queryStringParameters(TaskInput.fromObject(Map.of("id", "123")))
         .urlEncodingFormat(URLEncodingFormat.BRACKETS)
         .build();

  • Enum Constant Details

    • BRACKETS

      @Stability(Stable) public static final URLEncodingFormat BRACKETS
      Encode arrays using brackets.

      For example, {'array': ['a','b','c']} encodes to 'array[]=a&array[]=b&array[]=c'

    • COMMAS

      @Stability(Stable) public static final URLEncodingFormat COMMAS
      Encode arrays using commas.

      For example, {'array': ['a','b','c']} encodes to 'array=a,b,c,d'

    • DEFAULT

      @Stability(Stable) public static final URLEncodingFormat DEFAULT
      Apply the default URL encoding style (INDICES).

    • INDICES

      @Stability(Stable) public static final URLEncodingFormat INDICES
      Encode arrays using the index value.

      For example, {'array': ['a','b','c']} encodes to 'array[0]=a&array[1]=b&array[2]=c'

    • NONE

      @Stability(Stable) public static final URLEncodingFormat NONE
      Do not apply URL encoding.

    • REPEAT

      @Stability(Stable) public static final URLEncodingFormat REPEAT
      Repeat key for each item in the array.

      For example, {'array': ['a','b','c']} encodes to 'array[]=a&array[]=b&array[]=c'

  • Method Details

    • values

      public static URLEncodingFormat[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static URLEncodingFormat valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null