Package software.amazon.awssdk.services.s3.model

Class CORSRule

    • Method Detail

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

      • hashCode

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

      • equals

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

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