Package software.amazon.awssdk.services.s3.model

Class CORSConfiguration

java.lang.Object

software.amazon.awssdk.services.s3.model.CORSConfiguration

All Implemented Interfaces:

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

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

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CORSConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static CORSConfiguration.Builder	builder()
List<CORSRule>	corsRules()	A set of origins and methods (cross-origin access that you want to allow).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCorsRules()	For responses, this returns true if the service returned a value for the CORSRules property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CORSConfiguration.Builder>	serializableBuilderClass()
CORSConfiguration.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

hasCorsRules

public final boolean hasCorsRules()

For responses, this returns true if the service returned a value for the CORSRules 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.

corsRules

public final List<CORSRule> corsRules()

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

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 hasCorsRules() method.

Returns:

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

toBuilder

public CORSConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CORSConfiguration.Builder,CORSConfiguration>

builder

public static CORSConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CORSConfiguration.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