Class Cors
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Cors.Builder,
Cors>
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Specifies whether credentials are included in the CORS request.Represents a collection of allowed headers.Represents a collection of allowed HTTP methods.Represents a collection of allowed origins.static Cors.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Represents a collection of exposed headers.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 that the browser should cache preflight request results.static Class
<? extends Cors.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
-
allowCredentials
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
- Returns:
- Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
-
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
Represents a collection of allowed headers. Supported only for HTTP APIs.
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:
- Represents a collection of allowed headers. Supported only for HTTP APIs.
-
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
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
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:
- Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
-
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
Represents a collection of allowed origins. Supported only for HTTP APIs.
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:
- Represents a collection of allowed origins. Supported only for HTTP APIs.
-
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
Represents a collection of exposed headers. Supported only for HTTP APIs.
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:
- Represents a collection of exposed headers. Supported only for HTTP APIs.
-
maxAge
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
- Returns:
- The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
-
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<Cors.Builder,
Cors> - 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
-