@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.
Modifier and Type | Class and Description |
---|---|
static interface |
CorsRule.Builder |
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) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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) |
boolean |
hasAllowedHeaders()
Returns true if the AllowedHeaders 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 |
hasAllowedMethods()
Returns true if the AllowedMethods 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 |
hasAllowedOrigins()
Returns true if the AllowedOrigins 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 |
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()
Returns a string representation of this object.
|
copy
public final boolean hasAllowedOrigins()
public final 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 AllowedOrigins
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.
You can use hasAllowedOrigins()
to see if a value was sent in this field.
XMLHttpRequest
object).
Each CORS rule must have at least one AllowedOrigins
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.
public final 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 AllowedMethods
and one AllowedOrigins
element.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAllowedMethods()
to see if a value was sent in this field.
Each CORS rule must contain at least one AllowedMethods
and one AllowedOrigins
element.
public final boolean hasAllowedMethods()
public final 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 AllowedMethods
and one AllowedOrigins
element.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAllowedMethods()
to see if a value was sent in this field.
Each CORS rule must contain at least one AllowedMethods
and one AllowedOrigins
element.
public final boolean hasAllowedHeaders()
public final 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.
You can use hasAllowedHeaders()
to see if a value was sent in this field.
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 (*).
public final 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.
A CORS rule can have only one MaxAgeSeconds
element.
public final boolean hasExposeHeaders()
public final 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.
You can use hasExposeHeaders()
to see if a value was sent in this field.
XMLHttpRequest
object).
This element is optional for each rule.
public CorsRule.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CorsRule.Builder,CorsRule>
public static CorsRule.Builder builder()
public static Class<? extends CorsRule.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.