Class AwsCorsConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsCorsConfiguration.Builder,
AwsCorsConfiguration>
Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is only supported for HTTP APIs.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Indicates whether the CORS request includes credentials.The allowed headers for CORS requests.The allowed methods for CORS requests.The allowed origins for CORS requests.static AwsCorsConfiguration.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The exposed headers for CORS requests.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AllowHeaders property.final boolean
For responses, this returns true if the service returned a value for the AllowMethods property.final boolean
For responses, this returns true if the service returned a value for the AllowOrigins property.final boolean
For responses, this returns true if the service returned a value for the ExposeHeaders property.final int
hashCode()
final Integer
maxAge()
The number of seconds for which the browser caches preflight request results.static Class
<? extends AwsCorsConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasAllowOrigins
public final boolean hasAllowOrigins()For responses, this returns true if the service returned a value for the AllowOrigins property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
allowOrigins
The allowed origins for CORS requests.
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
hasAllowOrigins()
method.- Returns:
- The allowed origins for CORS requests.
-
allowCredentials
Indicates whether the CORS request includes credentials.
- Returns:
- Indicates whether the CORS request includes credentials.
-
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 theisEmpty()
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
The exposed headers for CORS requests.
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:
- The exposed headers for CORS requests.
-
maxAge
The number of seconds for which the browser caches preflight request results.
- Returns:
- The number of seconds for which the browser caches preflight request results.
-
hasAllowMethods
public final boolean hasAllowMethods()For responses, this returns true if the service returned a value for the AllowMethods property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
allowMethods
The allowed methods for CORS requests.
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
hasAllowMethods()
method.- Returns:
- The allowed methods for CORS requests.
-
hasAllowHeaders
public final boolean hasAllowHeaders()For responses, this returns true if the service returned a value for the AllowHeaders property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
allowHeaders
The allowed headers for CORS requests.
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
hasAllowHeaders()
method.- Returns:
- The allowed headers for CORS requests.
-
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 interfaceToCopyableBuilder<AwsCorsConfiguration.Builder,
AwsCorsConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-