Package software.amazon.awssdk.services.connect.model

Class CreatePredefinedAttributeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.CreatePredefinedAttributeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePredefinedAttributeRequest.Builder,CreatePredefinedAttributeRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreatePredefinedAttributeRequest
extends ConnectRequest
implements ToCopyableBuilder<CreatePredefinedAttributeRequest.Builder,CreatePredefinedAttributeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePredefinedAttributeRequest.Builder

Method Summary

Modifier and Type	Method	Description
InputPredefinedAttributeConfiguration	attributeConfiguration()	Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.
static CreatePredefinedAttributeRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPurposes()	For responses, this returns true if the service returned a value for the Purposes property.
String	instanceId()	The identifier of the Amazon Connect instance.
String	name()	The name of the predefined attribute.
List<String>	purposes()	Values that enable you to categorize your predefined attributes.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePredefinedAttributeRequest.Builder>	serializableBuilderClass()
CreatePredefinedAttributeRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PredefinedAttributeValues	values()	The values of the predefined attribute.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

instanceId

public final String instanceId()

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

name

public final String name()

The name of the predefined attribute.

Returns:

The name of the predefined attribute.

values

public final PredefinedAttributeValues values()

The values of the predefined attribute.

Returns:

The values of the predefined attribute.

hasPurposes

public final boolean hasPurposes()

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

purposes

public final List<String> purposes()

Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.

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

Returns:

Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.

attributeConfiguration

public final InputPredefinedAttributeConfiguration attributeConfiguration()

Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

Returns:

Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

toBuilder

public CreatePredefinedAttributeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePredefinedAttributeRequest.Builder,CreatePredefinedAttributeRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static CreatePredefinedAttributeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePredefinedAttributeRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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