Class CORSRule

java.lang.Object
software.amazon.awssdk.services.s3.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>

Specifies a cross-origin access rule for an Amazon S3 bucket.

See Also:

  • Method Details

    • id

      public final String id()

      Unique identifier for the rule. The value cannot be longer than 255 characters.

      Returns:
      Unique identifier for the rule. The value cannot be longer than 255 characters.

    • 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()

      Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

      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:
      Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

    • 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.

    • allowedMethods

      public final List<String> allowedMethods()

      An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

      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:
      An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

    • 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 origins you want customers to be able to access the bucket from.

      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 origins you want customers to be able to access the bucket from.

    • 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 customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

      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 customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

    • maxAgeSeconds

      public final Integer maxAgeSeconds()

      The time in seconds that your browser is to cache the preflight response for the specified resource.

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

    • 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.