Class RoutingProfile

java.lang.Object
software.amazon.awssdk.services.connect.model.RoutingProfile
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RoutingProfile.Builder,RoutingProfile>
@Generated("software.amazon.awssdk:codegen") public final class RoutingProfile extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RoutingProfile.Builder,RoutingProfile>

Contains information about a routing profile.

See Also:

  • Method Details

    • 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 routing profile.

      Returns:
      The name of the routing profile.

    • routingProfileArn

      public final String routingProfileArn()

      The Amazon Resource Name (ARN) of the routing profile.

      Returns:
      The Amazon Resource Name (ARN) of the routing profile.

    • routingProfileId

      public final String routingProfileId()

      The identifier of the routing profile.

      Returns:
      The identifier of the routing profile.

    • description

      public final String description()

      The description of the routing profile.

      Returns:
      The description of the routing profile.

    • hasMediaConcurrencies

      public final boolean hasMediaConcurrencies()
      For responses, this returns true if the service returned a value for the MediaConcurrencies 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.

    • mediaConcurrencies

      public final List<MediaConcurrency> mediaConcurrencies()

      The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

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

      Returns:
      The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

    • defaultOutboundQueueId

      public final String defaultOutboundQueueId()

      The identifier of the default outbound queue for this routing profile.

      Returns:
      The identifier of the default outbound queue for this routing profile.

    • 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 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.

    • 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"} }.

    • numberOfAssociatedQueues

      public final Long numberOfAssociatedQueues()

      The number of associated queues in routing profile.

      Returns:
      The number of associated queues in routing profile.

    • numberOfAssociatedUsers

      public final Long numberOfAssociatedUsers()

      The number of associated users in routing profile.

      Returns:
      The number of associated users in routing profile.

    • agentAvailabilityTimer

      public final AgentAvailabilityTimer agentAvailabilityTimer()

      Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

      If the service returns an enum value that is not available in the current SDK version, agentAvailabilityTimer will return AgentAvailabilityTimer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentAvailabilityTimerAsString().

      Returns:
      Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
      See Also:

    • agentAvailabilityTimerAsString

      public final String agentAvailabilityTimerAsString()

      Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

      If the service returns an enum value that is not available in the current SDK version, agentAvailabilityTimer will return AgentAvailabilityTimer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentAvailabilityTimerAsString().

      Returns:
      Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
      See Also:

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when this resource was last modified.

      Returns:
      The timestamp when this resource was last modified.

    • lastModifiedRegion

      public final String lastModifiedRegion()

      The Amazon Web Services Region where this resource was last modified.

      Returns:
      The Amazon Web Services Region where this resource was last modified.

    • isDefault

      public final Boolean isDefault()

      Whether this a default routing profile.

      Returns:
      Whether this a default routing profile.

    • hasAssociatedQueueIds

      public final boolean hasAssociatedQueueIds()
      For responses, this returns true if the service returned a value for the AssociatedQueueIds 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.

    • associatedQueueIds

      public final List<String> associatedQueueIds()

      The IDs of the associated queue.

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

      Returns:
      The IDs of the associated queue.

    • toBuilder

      public RoutingProfile.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RoutingProfile.Builder,RoutingProfile>
      Returns:
      a builder for type T

    • builder

      public static RoutingProfile.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RoutingProfile.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.