Cors (AWS Java SDK :: Services :: ApiGatewayV2 2.15.45 API)

java.lang.Object
- software.amazon.awssdk.services.apigatewayv2.model.Cors

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Cors.Builder,Cors>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Cors
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Cors.Builder,Cors>
```
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Cors.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Cors.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allowCredentials()` Specifies whether credentials are included in the CORS request.
`List<String>`	`allowHeaders()` Represents a collection of allowed headers.
`List<String>`	`allowMethods()` Represents a collection of allowed HTTP methods.
`List<String>`	`allowOrigins()` Represents a collection of allowed origins.
`static Cors.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`exposeHeaders()` Represents a collection of exposed headers.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowHeaders()` Returns true if the AllowHeaders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasAllowMethods()` Returns true if the AllowMethods property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasAllowOrigins()` Returns true if the AllowOrigins property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasExposeHeaders()` Returns true if the ExposeHeaders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`Integer`	`maxAge()` The number of seconds that the browser should cache preflight request results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Cors.Builder>`	`serializableBuilderClass()`
`Cors.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - allowCredentials
```
public Boolean allowCredentials()
```
    Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
    
    Returns:
    
    Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
  - hasAllowHeaders
```
public boolean hasAllowHeaders()
```
    Returns true if the AllowHeaders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - allowHeaders
```
public List<String> allowHeaders()
```
    Represents a collection of allowed headers. Supported only for HTTP APIs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAllowHeaders() to see if a value was sent in this field.
    
    Returns:
    
    Represents a collection of allowed headers. Supported only for HTTP APIs.
  - hasAllowMethods
```
public boolean hasAllowMethods()
```
    Returns true if the AllowMethods property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - allowMethods
```
public List<String> allowMethods()
```
    Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAllowMethods() to see if a value was sent in this field.
    
    Returns:
    
    Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
  - hasAllowOrigins
```
public boolean hasAllowOrigins()
```
    Returns true if the AllowOrigins property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - allowOrigins
```
public List<String> allowOrigins()
```
    Represents a collection of allowed origins. Supported only for HTTP APIs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAllowOrigins() to see if a value was sent in this field.
    
    Returns:
    
    Represents a collection of allowed origins. Supported only for HTTP APIs.
  - hasExposeHeaders
```
public boolean hasExposeHeaders()
```
    Returns true if the ExposeHeaders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - exposeHeaders
```
public List<String> exposeHeaders()
```
    Represents a collection of exposed headers. Supported only for HTTP APIs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExposeHeaders() to see if a value was sent in this field.
    
    Returns:
    
    Represents a collection of exposed headers. Supported only for HTTP APIs.
  - maxAge
```
public Integer maxAge()
```
    The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
    
    Returns:
    
    The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
  - toBuilder
```
public Cors.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Cors.Builder,Cors>
  - builder
```
public static Cors.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Cors.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Cors

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

allowCredentials

hasAllowHeaders

allowHeaders

hasAllowMethods

allowMethods

hasAllowOrigins

allowOrigins

hasExposeHeaders

exposeHeaders

maxAge

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields