software.amazon.awscdk.services.apigatewayv2

Enum HttpMethod

java.lang.Object

java.lang.Enum<HttpMethod>

software.amazon.awscdk.services.apigatewayv2.HttpMethod

All Implemented Interfaces:

Serializable, Comparable<HttpMethod>

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:23.613Z")
 @Stability(value=Experimental)
public enum HttpMethod
extends Enum<HttpMethod>

(experimental) Supported HTTP methods.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpUrlIntegration;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpLambdaIntegration;
 Function booksDefaultFn;
 HttpUrlIntegration getBooksIntegration = new HttpUrlIntegration("GetBooksIntegration", "https://get-books-proxy.myproxy.internal");
 HttpLambdaIntegration booksDefaultIntegration = new HttpLambdaIntegration("BooksIntegration", booksDefaultFn);
 HttpApi httpApi = new HttpApi(this, "HttpApi");
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/books")
         .methods(List.of(HttpMethod.GET))
         .integration(getBooksIntegration)
         .build());
 httpApi.addRoutes(AddRoutesOptions.builder()
         .path("/books")
         .methods(List.of(HttpMethod.ANY))
         .integration(booksDefaultIntegration)
         .build());
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY (experimental) HTTP ANY.
DELETE (experimental) HTTP DELETE.
GET (experimental) HTTP GET.
HEAD (experimental) HTTP HEAD.
OPTIONS (experimental) HTTP OPTIONS.
PATCH (experimental) HTTP PATCH.
POST (experimental) HTTP POST.
PUT (experimental) HTTP PUT.

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

ANY

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

(experimental) HTTP ANY.

DELETE

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

(experimental) HTTP DELETE.

GET

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

(experimental) HTTP GET.

HEAD

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

(experimental) HTTP HEAD.

OPTIONS

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

(experimental) HTTP OPTIONS.

PATCH

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

(experimental) HTTP PATCH.

POST

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

(experimental) HTTP POST.

PUT

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

(experimental) HTTP PUT.

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