software.amazon.awssdk.services.mediastore.model

Class CorsRule

java.lang.Object

software.amazon.awssdk.services.mediastore.model.CorsRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CorsRule.Builder,CorsRule>

@Generated(value="software.amazon.awssdk:codegen")
public final class CorsRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CorsRule.Builder,CorsRule>

A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CorsRule.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	allowedHeaders() Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header.
List<MethodName>	allowedMethods() Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
List<String>	allowedMethodsAsStrings() Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
List<String>	allowedOrigins() One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
static CorsRule.Builder	builder()
boolean	equals(Object obj)
List<String>	exposeHeaders() One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxAgeSeconds() The time in seconds that your browser caches the preflight response for the specified resource.
List<SdkField<?>>	sdkFields()
static Class<? extends CorsRule.Builder>	serializableBuilderClass()
CorsRule.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

allowedOrigins

public List<String> allowedOrigins()

One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

Each CORS rule must have at least one AllowedOrigin element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

Each CORS rule must have at least one AllowedOrigin element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

allowedMethods

public List<MethodName> allowedMethods()

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethod and one AllowedOrigin element.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethod and one AllowedOrigin element.

allowedMethodsAsStrings

public List<String> allowedMethodsAsStrings()

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethod and one AllowedOrigin element.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethod and one AllowedOrigin element.

allowedHeaders

public List<String> allowedHeaders()

Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

This element can contain only one wildcard character (*).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

This element can contain only one wildcard character (*).

maxAgeSeconds

public Integer maxAgeSeconds()

The time in seconds that your browser caches the preflight response for the specified resource.

A CORS rule can have only one MaxAgeSeconds element.

Returns:

The time in seconds that your browser caches the preflight response for the specified resource.

A CORS rule can have only one MaxAgeSeconds element.

exposeHeaders

public List<String> exposeHeaders()

One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

This element is optional for each rule.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

This element is optional for each rule.

toBuilder

public CorsRule.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CorsRule.Builder,CorsRule>

Returns:

a builder for type T

builder

public static CorsRule.Builder builder()

serializableBuilderClass

public static Class<? extends CorsRule.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.