Class CorsRule
- java.lang.Object
-
- software.amazon.awssdk.services.mediastore.model.CorsRule
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CorsRule.Builder,CorsRule>
@Generated("software.amazon.awssdk:codegen") public final class CorsRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CorsRule.Builder,CorsRule>
A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCorsRule.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>allowedHeaders()Specifies which headers are allowed in a preflightOPTIONSrequest through theAccess-Control-Request-Headersheader.List<MethodName>allowedMethods()Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.List<String>allowedMethodsAsStrings()Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.List<String>allowedOrigins()One or more response headers that you want users to be able to access from their applications (for example, from a JavaScriptXMLHttpRequestobject).static CorsRule.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>exposeHeaders()One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScriptXMLHttpRequestobject).<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowedHeaders()For responses, this returns true if the service returned a value for the AllowedHeaders property.booleanhasAllowedMethods()For responses, this returns true if the service returned a value for the AllowedMethods property.booleanhasAllowedOrigins()For responses, this returns true if the service returned a value for the AllowedOrigins property.booleanhasExposeHeaders()For responses, this returns true if the service returned a value for the ExposeHeaders property.inthashCode()IntegermaxAgeSeconds()The time in seconds that your browser caches the preflight response for the specified resource.List<SdkField<?>>sdkFields()static Class<? extends CorsRule.Builder>serializableBuilderClass()CorsRule.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
-
hasAllowedOrigins
public final boolean hasAllowedOrigins()
For responses, this returns true if the service returned a value for the AllowedOrigins 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.
-
allowedOrigins
public final List<String> allowedOrigins()
One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript
XMLHttpRequestobject).Each CORS rule must have at least one
AllowedOriginselement. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.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
hasAllowedOrigins()method.- Returns:
- One or more response headers that you want users to be able to access from their applications (for
example, from a JavaScript
XMLHttpRequestobject).Each CORS rule must have at least one
AllowedOriginselement. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.
-
allowedMethods
public final List<MethodName> allowedMethods()
Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
Each CORS rule must contain at least one
AllowedMethodsand oneAllowedOriginselement.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
hasAllowedMethods()method.- Returns:
- Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
Each CORS rule must contain at least one
AllowedMethodsand oneAllowedOriginselement.
-
hasAllowedMethods
public final boolean hasAllowedMethods()
For responses, this returns true if the service returned a value for the AllowedMethods 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.
-
allowedMethodsAsStrings
public final List<String> allowedMethodsAsStrings()
Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
Each CORS rule must contain at least one
AllowedMethodsand oneAllowedOriginselement.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
hasAllowedMethods()method.- Returns:
- Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
Each CORS rule must contain at least one
AllowedMethodsand oneAllowedOriginselement.
-
hasAllowedHeaders
public final boolean hasAllowedHeaders()
For responses, this returns true if the service returned a value for the AllowedHeaders 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.
-
allowedHeaders
public final List<String> allowedHeaders()
Specifies which headers are allowed in a preflight
OPTIONSrequest through theAccess-Control-Request-Headersheader. Each header name that is specified inAccess-Control-Request-Headersmust have a corresponding entry in the rule. Only the headers that were requested are sent back.This element can contain only one wildcard character (*).
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
hasAllowedHeaders()method.- Returns:
- Specifies which headers are allowed in a preflight
OPTIONSrequest through theAccess-Control-Request-Headersheader. Each header name that is specified inAccess-Control-Request-Headersmust have a corresponding entry in the rule. Only the headers that were requested are sent back.This element can contain only one wildcard character (*).
-
maxAgeSeconds
public final Integer maxAgeSeconds()
The time in seconds that your browser caches the preflight response for the specified resource.
A CORS rule can have only one
MaxAgeSecondselement.- Returns:
- The time in seconds that your browser caches the preflight response for the specified resource.
A CORS rule can have only one
MaxAgeSecondselement.
-
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()
One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript
XMLHttpRequestobject).This element is optional for each rule.
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:
- One or more headers in the response that you want users to be able to access from their applications (for
example, from a JavaScript
XMLHttpRequestobject).This element is optional for each rule.
-
toBuilder
public CorsRule.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CorsRule.Builder,CorsRule>
-
builder
public static CorsRule.Builder builder()
-
serializableBuilderClass
public static Class<? extends CorsRule.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.
-
-