software.amazon.awssdk.services.cloudfront.model

Class AllowedMethods

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.AllowedMethods

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AllowedMethods.Builder,AllowedMethods>

@Generated(value="software.amazon.awssdk:codegen")
public final class AllowedMethods
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AllowedMethods.Builder,AllowedMethods>

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

• CloudFront forwards only GET and HEAD requests.

• CloudFront forwards only GET, HEAD, and OPTIONS requests.

• CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AllowedMethods.Builder

Method Summary

Modifier and Type	Method and Description
static AllowedMethods.Builder	builder()
CachedMethods	cachedMethods() Returns the value of the CachedMethods property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItems() For responses, this returns true if the service returned a value for the Items property.
List<Method>	items() A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
List<String>	itemsAsStrings() A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
Integer	quantity() The number of HTTP methods that you want CloudFront to forward to your origin.
List<SdkField<?>>	sdkFields()
static Class<? extends AllowedMethods.Builder>	serializableBuilderClass()
AllowedMethods.Builder	toBuilder()
String	toString() 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

quantity

public final Integer quantity()

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

Returns:

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

items

public final List<Method> items()

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

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 hasItems() method.

Returns:

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

hasItems

public final boolean hasItems()

For responses, this returns true if the service returned a value for the Items 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.

itemsAsStrings

public final List<String> itemsAsStrings()

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

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 hasItems() method.

Returns:

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

cachedMethods

public final CachedMethods cachedMethods()

Returns the value of the CachedMethods property for this object.

Returns:

The value of the CachedMethods property for this object.

toBuilder

public AllowedMethods.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AllowedMethods.Builder,AllowedMethods>

builder

public static AllowedMethods.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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