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:

  • Method Details

    • 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 the isEmpty() 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 XMLHttpRequest object).

      Each CORS rule must have at least one AllowedOrigins element. 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 XMLHttpRequest object).

      Each CORS rule must have at least one AllowedOrigins element. 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 AllowedMethods and one AllowedOrigins element.

      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 AllowedMethods and one AllowedOrigins element.

    • 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 the isEmpty() 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 AllowedMethods and one AllowedOrigins element.

      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 AllowedMethods and one AllowedOrigins element.

    • 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 the isEmpty() 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 OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must 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 OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must 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 MaxAgeSeconds element.

      Returns:
      The time in seconds that your browser caches the preflight response for the specified resource.

      A CORS rule can have only one MaxAgeSeconds element.

    • 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 the isEmpty() 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 XMLHttpRequest object).

      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 XMLHttpRequest object).

      This element is optional for each rule.

    • toBuilder

      public CorsRule.Builder 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 interface ToCopyableBuilder<CorsRule.Builder,CorsRule>
      Returns:
      a builder for type T

    • builder

      public static CorsRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CorsRule.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.