Class ContactFlow
- java.lang.Object
-
- software.amazon.awssdk.services.connect.model.ContactFlow
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ContactFlow.Builder,ContactFlow>
@Generated("software.amazon.awssdk:codegen") public final class ContactFlow extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContactFlow.Builder,ContactFlow>
Contains information about a flow.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceContactFlow.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the flow.static ContactFlow.Builderbuilder()Stringcontent()The JSON string that represents the content of the flow.Stringdescription()The description of the flow.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringid()The identifier of the flow.Stringname()The name of the flow.List<SdkField<?>>sdkFields()static Class<? extends ContactFlow.Builder>serializableBuilderClass()ContactFlowStatestate()The type of flow.StringstateAsString()The type of flow.ContactFlowStatusstatus()The status of the contact flow.StringstatusAsString()The status of the contact flow.Map<String,String>tags()The tags used to organize, track, or control access for this resource.ContactFlow.BuildertoBuilder()StringtoString()Returns a string representation of this object.ContactFlowTypetype()The type of the flow.StringtypeAsString()The type of the flow.-
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
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the flow.
- Returns:
- The Amazon Resource Name (ARN) of the flow.
-
id
public final String id()
The identifier of the flow.
- Returns:
- The identifier of the flow.
-
name
public final String name()
The name of the flow.
- Returns:
- The name of the flow.
-
type
public final ContactFlowType type()
The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
If the service returns an enum value that is not available in the current SDK version,
typewill returnContactFlowType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
- See Also:
ContactFlowType
-
typeAsString
public final String typeAsString()
The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
If the service returns an enum value that is not available in the current SDK version,
typewill returnContactFlowType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
- See Also:
ContactFlowType
-
state
public final ContactFlowState state()
The type of flow.
If the service returns an enum value that is not available in the current SDK version,
statewill returnContactFlowState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The type of flow.
- See Also:
ContactFlowState
-
stateAsString
public final String stateAsString()
The type of flow.
If the service returns an enum value that is not available in the current SDK version,
statewill returnContactFlowState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The type of flow.
- See Also:
ContactFlowState
-
status
public final ContactFlowStatus status()
The status of the contact flow.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnContactFlowStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the contact flow.
- See Also:
ContactFlowStatus
-
statusAsString
public final String statusAsString()
The status of the contact flow.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnContactFlowStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the contact flow.
- See Also:
ContactFlowStatus
-
description
public final String description()
The description of the flow.
- Returns:
- The description of the flow.
-
content
public final String content()
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
- Returns:
- The JSON string that represents the content of the flow. For an example, see Example flow in
Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
tags
public final Map<String,String> tags()
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
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
hasTags()method.- Returns:
- The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
-
toBuilder
public ContactFlow.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ContactFlow.Builder,ContactFlow>
-
builder
public static ContactFlow.Builder builder()
-
serializableBuilderClass
public static Class<? extends ContactFlow.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-