Class BucketCorsRule

java.lang.Object
software.amazon.awssdk.services.lightsail.model.BucketCorsRule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BucketCorsRule.Builder,BucketCorsRule>
@Generated("software.amazon.awssdk:codegen") public final class BucketCorsRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BucketCorsRule.Builder,BucketCorsRule>

Describes a cross-origin resource sharing (CORS) rule for a Lightsail bucket. CORS rules specify which origins are allowed to access the bucket, which HTTP methods are allowed, and other access control information. For more information, see Configuring cross-origin resource sharing (CORS).

See Also:

  • Method Details

    • id

      public final String id()

      A unique identifier for the CORS rule. The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration.

      Returns:
      A unique identifier for the CORS rule. The ID value can be up to 255 characters long. The IDs help you find a rule in the configuration.

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

      The HTTP methods that are allowed when accessing the bucket from the specified origin. Each CORS rule must identify at least one origin and one method.

      You can use the following HTTP methods:

      • GET - Retrieves data from the server, such as downloading files or viewing content.

      • PUT - Uploads or replaces data on the server, such as uploading new files.

      • POST - Sends data to the server for processing, such as submitting forms or creating new resources.

      • DELETE - Removes data from the server, such as deleting files or resources.

      • HEAD - Retrieves only the headers from the server without the actual content, useful for checking if a resource exists.

      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:
      The HTTP methods that are allowed when accessing the bucket from the specified origin. Each CORS rule must identify at least one origin and one method.

      You can use the following HTTP methods:

      • GET - Retrieves data from the server, such as downloading files or viewing content.

      • PUT - Uploads or replaces data on the server, such as uploading new files.

      • POST - Sends data to the server for processing, such as submitting forms or creating new resources.

      • DELETE - Removes data from the server, such as deleting files or resources.

      • HEAD - Retrieves only the headers from the server without the actual content, useful for checking if a resource exists.

    • 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. Each CORS rule must identify at least one origin and one method.

      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. Each CORS rule must identify at least one origin and one method.

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

    • 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. A CORS rule can have only one maxAgeSeconds element.

      Returns:
      The time in seconds that your browser is to cache the preflight response for the specified resource. A CORS rule can have only one maxAgeSeconds element.

    • toBuilder

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

    • builder

      public static BucketCorsRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BucketCorsRule.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.