Package software.amazon.awssdk.services.cloudfront.model

Class ResponseHeadersPolicyServerTimingHeadersConfig

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.ResponseHeadersPolicyServerTimingHeadersConfig

All Implemented Interfaces:

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

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

A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

You can use the Server-Timing header to view metrics that can help you gain insights about the behavior and performance of CloudFront. For example, you can see which cache layer served a cache hit, or the first byte latency from the origin when there was a cache miss. You can use the metrics in the Server-Timing header to troubleshoot issues or test the efficiency of your CloudFront configuration. For more information, see Server-Timing header in the Amazon CloudFront Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResponseHeadersPolicyServerTimingHeadersConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ResponseHeadersPolicyServerTimingHeadersConfig.Builder	builder()
Boolean	enabled()	A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	samplingRate()	A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ResponseHeadersPolicyServerTimingHeadersConfig.Builder>	serializableBuilderClass()
ResponseHeadersPolicyServerTimingHeadersConfig.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

enabled

public final Boolean enabled()

A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

Returns:

A Boolean that determines whether CloudFront adds the Server-Timing header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

samplingRate

public final Double samplingRate()

A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.

Returns:

A number 0–100 (inclusive) that specifies the percentage of responses that you want CloudFront to add the Server-Timing header to. When you set the sampling rate to 100, CloudFront adds the Server-Timing header to the HTTP response for every request that matches the cache behavior that this response headers policy is attached to. When you set it to 50, CloudFront adds the header to 50% of the responses for requests that match the cache behavior. You can set the sampling rate to any number 0–100 with up to four decimal places.

toBuilder

public ResponseHeadersPolicyServerTimingHeadersConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResponseHeadersPolicyServerTimingHeadersConfig.Builder,ResponseHeadersPolicyServerTimingHeadersConfig>

builder

public static ResponseHeadersPolicyServerTimingHeadersConfig.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo