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>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:15.002Z")
 @Stability(value=Experimental)
public enum HttpMethod
extends Enum<HttpMethod>

(experimental) Http Methods that API Gateway supports.

Example:

 import software.amazon.awscdk.core.*;
 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();
 

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GET

@Stability(value=Experimental)
public static final HttpMethod GET

(experimental) Retreive data from a server at the specified resource.

POST

@Stability(value=Experimental)
public static final HttpMethod POST

(experimental) Send data to the API endpoint to create or udpate a resource.

PUT

@Stability(value=Experimental)
public static final HttpMethod PUT

(experimental) Send data to the API endpoint to update or create a resource.

DELETE

@Stability(value=Experimental)
public static final HttpMethod DELETE

(experimental) Delete the resource at the specified endpoint.

PATCH

@Stability(value=Experimental)
public static final HttpMethod PATCH

(experimental) Apply partial modifications to the resource.

HEAD

@Stability(value=Experimental)
public static final HttpMethod HEAD

(experimental) Retreive data from a server at the specified resource without the response body.

OPTIONS

@Stability(value=Experimental)
public static final HttpMethod OPTIONS

(experimental) Return data describing what other methods and operations the server supports.

Method Detail

values

public static HttpMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpMethod c : HttpMethod.values())
    System.out.println(c);

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