Class Cors
- java.lang.Object
-
- software.amazon.awssdk.services.apigatewayv2.model.Cors
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Cors.Builder,Cors>
@Generated("software.amazon.awssdk:codegen") public final class Cors extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Cors.Builder,Cors>
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCors.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanallowCredentials()Specifies whether credentials are included in the CORS request.List<String>allowHeaders()Represents a collection of allowed headers.List<String>allowMethods()Represents a collection of allowed HTTP methods.List<String>allowOrigins()Represents a collection of allowed origins.static Cors.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>exposeHeaders()Represents a collection of exposed headers.<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 that the browser should cache preflight request results.List<SdkField<?>>sdkFields()static Class<? extends Cors.Builder>serializableBuilderClass()Cors.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
-
allowCredentials
public final Boolean 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
public final List<String> 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
public final List<String> 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
public final List<String> 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
public final List<String> 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
public final Integer 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
public Cors.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Cors.Builder,Cors>
-
builder
public static Cors.Builder builder()
-
serializableBuilderClass
public static Class<? extends Cors.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.
-
-