@Generated(value="software.amazon.awssdk:codegen") public final class CORSRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CORSRule.Builder,CORSRule>
Specifies a cross-origin access rule for an Amazon S3 bucket.
Modifier and Type | Class and Description |
---|---|
static interface |
CORSRule.Builder |
Modifier and Type | Method and Description |
---|---|
List<String> |
allowedHeaders()
Headers that are specified in the
Access-Control-Request-Headers header. |
List<String> |
allowedMethods()
An HTTP method that you allow the origin to execute.
|
List<String> |
allowedOrigins()
One or more origins you want customers to be able to access the bucket from.
|
static CORSRule.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<String> |
exposeHeaders()
One or more headers in the response that you want customers 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()
For responses, this returns true if the service returned a value for the AllowedHeaders property.
|
boolean |
hasAllowedMethods()
For responses, this returns true if the service returned a value for the AllowedMethods property.
|
boolean |
hasAllowedOrigins()
For responses, this returns true if the service returned a value for the AllowedOrigins property.
|
boolean |
hasExposeHeaders()
For responses, this returns true if the service returned a value for the ExposeHeaders property.
|
int |
hashCode() |
String |
id()
Unique identifier for the rule.
|
Integer |
maxAgeSeconds()
The time in seconds that your browser is to cache the preflight response for the specified resource.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CORSRule.Builder> |
serializableBuilderClass() |
CORSRule.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String id()
Unique identifier for the rule. The value cannot be longer than 255 characters.
public final boolean hasAllowedHeaders()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> allowedHeaders()
Headers that are specified in the Access-Control-Request-Headers
header. These headers are allowed
in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested
headers that are allowed.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAllowedHeaders()
method.
Access-Control-Request-Headers
header. These headers are
allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns
any requested headers that are allowed.public final boolean hasAllowedMethods()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> allowedMethods()
An HTTP method that you allow the origin to execute. Valid values are GET
, PUT
,
HEAD
, POST
, and DELETE
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAllowedMethods()
method.
GET
, PUT
,
HEAD
, POST
, and DELETE
.public final boolean hasAllowedOrigins()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> allowedOrigins()
One or more origins you want customers to be able to access the bucket from.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAllowedOrigins()
method.
public final boolean hasExposeHeaders()
isEmpty()
method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> exposeHeaders()
One or more headers in the response that you want customers to be able to access from their applications (for
example, from a JavaScript XMLHttpRequest
object).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasExposeHeaders()
method.
XMLHttpRequest
object).public final Integer maxAgeSeconds()
The time in seconds that your browser is to cache the preflight response for the specified resource.
public CORSRule.Builder toBuilder()
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)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2021. All rights reserved.