java.lang.Object
- software.amazon.awssdk.services.s3.model.CORSRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CORSRule.Builder,CORSRule>
```
@Generated("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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CORSRule.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CORSRule.Builder>`	`serializableBuilderClass()`
`CORSRule.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
  - id
```
public final String id()
```
    Unique identifier for the rule. The value cannot be longer than 255 characters.
    
    Returns:
    
    Unique identifier for the rule. The value cannot be longer than 255 characters.
  - hasAllowedHeaders
```
public final boolean hasAllowedHeaders()
```
    For responses, this returns true if the service returned a value for the AllowedHeaders property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - allowedHeaders
```
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.
    
    Returns:
    
    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.
  - hasAllowedMethods
```
public final boolean hasAllowedMethods()
```
    For responses, this returns true if the service returned a value for the AllowedMethods property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - allowedMethods
```
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.
    
    Returns:
    
    An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.
  - hasAllowedOrigins
```
public final boolean hasAllowedOrigins()
```
    For responses, this returns true if the service returned a value for the AllowedOrigins property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - allowedOrigins
```
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.
    
    Returns:
    
    One or more origins you want customers to be able to access the bucket from.
  - hasExposeHeaders
```
public final boolean hasExposeHeaders()
```
    For responses, this returns true if the service returned a value for the ExposeHeaders property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - exposeHeaders
```
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.
    
    Returns:
    
    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).
  - maxAgeSeconds
```
public final Integer maxAgeSeconds()
```
    The time in seconds that your browser is to cache the preflight response for the specified resource.
    
    Returns:
    
    The time in seconds that your browser is to cache the preflight response for the specified resource.
  - toBuilder
```
public CORSRule.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CORSRule.Builder,CORSRule>
  - builder
```
public static CORSRule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CORSRule.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CORSRule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

hasAllowedHeaders

allowedHeaders

hasAllowedMethods

allowedMethods

hasAllowedOrigins

allowedOrigins

hasExposeHeaders

exposeHeaders

maxAgeSeconds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField