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

Enum HttpMethod

java.lang.Object
java.lang.Enum<HttpMethod>
software.amazon.awscdk.services.stepfunctions.tasks.HttpMethod
All Implemented Interfaces:
Serializable, Comparable<HttpMethod>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:14.595Z") @Stability(Stable) public enum HttpMethod extends Enum<HttpMethod>
Http Methods that API Gateway supports.

Example: 

 import software.amazon.awscdk.services.apigatewayv2.*;
 HttpApi httpApi = new HttpApi(this, "MyHttpApi");
 CallApiGatewayHttpApiEndpoint invokeTask = CallApiGatewayHttpApiEndpoint.Builder.create(this, "Call HTTP API")
         .apiId(httpApi.getApiId())
         .apiStack(Stack.of(httpApi))
         .method(HttpMethod.GET)
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DELETE
    Delete the resource at the specified endpoint.
    GET
    Retreive data from a server at the specified resource.
    HEAD
    Retreive data from a server at the specified resource without the response body.
    OPTIONS
    Return data describing what other methods and operations the server supports.
    PATCH
    Apply partial modifications to the resource.
    POST
    Send data to the API endpoint to create or udpate a resource.
    PUT
    Send data to the API endpoint to update or create a resource.

  • Method Summary

    Modifier and Type
    Method
    Description
    static HttpMethod
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static HttpMethod[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • GET

      @Stability(Stable) public static final HttpMethod GET
      Retreive data from a server at the specified resource.

    • POST

      @Stability(Stable) public static final HttpMethod POST
      Send data to the API endpoint to create or udpate a resource.

    • PUT

      @Stability(Stable) public static final HttpMethod PUT
      Send data to the API endpoint to update or create a resource.

    • DELETE

      @Stability(Stable) public static final HttpMethod DELETE
      Delete the resource at the specified endpoint.

    • PATCH

      @Stability(Stable) public static final HttpMethod PATCH
      Apply partial modifications to the resource.

    • OPTIONS

      @Stability(Stable) public static final HttpMethod OPTIONS
      Return data describing what other methods and operations the server supports.

  • Method Details

    • values

      public static HttpMethod[] 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 HttpMethod 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