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

Class KeyGroupConfig

java.lang.Object

software.amazon.awssdk.services.cloudfront.model.KeyGroupConfig

All Implemented Interfaces:

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

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

A key group configuration.

A key group contains a list of public keys that you can use with CloudFront signed URLs and signed cookies.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KeyGroupConfig.Builder

Method Summary

Modifier and Type	Method	Description
static KeyGroupConfig.Builder	builder()
String	comment()	A comment to describe the key group.
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<String>	items()	A list of the identifiers of the public keys in the key group.
String	name()	A name to identify the key group.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KeyGroupConfig.Builder>	serializableBuilderClass()
KeyGroupConfig.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

name

public final String name()

A name to identify the key group.

Returns:

A name to identify the key group.

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.

items

public final List<String> items()

A list of the identifiers of the public keys in the key group.

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 list of the identifiers of the public keys in the key group.

comment

public final String comment()

A comment to describe the key group. The comment cannot be longer than 128 characters.

Returns:

A comment to describe the key group. The comment cannot be longer than 128 characters.

toBuilder

public KeyGroupConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KeyGroupConfig.Builder,KeyGroupConfig>

builder

public static KeyGroupConfig.Builder builder()

serializableBuilderClass

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