Class AwsCorsConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.securityhub.model.AwsCorsConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AwsCorsConfiguration.Builder,AwsCorsConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class AwsCorsConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsCorsConfiguration.Builder,AwsCorsConfiguration>
Contains the cross-origin resource sharing (CORS) configuration for the API. CORS is only supported for HTTP APIs.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAwsCorsConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanallowCredentials()Indicates whether the CORS request includes credentials.List<String>allowHeaders()The allowed headers for CORS requests.List<String>allowMethods()The allowed methods for CORS requests.List<String>allowOrigins()The allowed origins for CORS requests.static AwsCorsConfiguration.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>exposeHeaders()The exposed headers for CORS requests.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowHeaders()For responses, this returns true if the service returned a value for the AllowHeaders property.booleanhasAllowMethods()For responses, this returns true if the service returned a value for the AllowMethods property.booleanhasAllowOrigins()For responses, this returns true if the service returned a value for the AllowOrigins property.booleanhasExposeHeaders()For responses, this returns true if the service returned a value for the ExposeHeaders property.inthashCode()IntegermaxAge()The number of seconds for which the browser caches preflight request results.List<SdkField<?>>sdkFields()static Class<? extends AwsCorsConfiguration.Builder>serializableBuilderClass()AwsCorsConfiguration.BuildertoBuilder()StringtoString()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
-
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
public final List<String> 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
public final Boolean 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
public final List<String> 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
public final Integer 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
public final List<String> 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
public final List<String> 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
public AwsCorsConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AwsCorsConfiguration.Builder,AwsCorsConfiguration>
-
builder
public static AwsCorsConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends AwsCorsConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-