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

Class CreateRoutingProfileRequest

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.CreateRoutingProfileRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateRoutingProfileRequest.Builder,CreateRoutingProfileRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateRoutingProfileRequest extends ConnectRequest implements ToCopyableBuilder<CreateRoutingProfileRequest.Builder,CreateRoutingProfileRequest>

  • 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. Must not be more than 127 characters.

      Returns:
      The name of the routing profile. Must not be more than 127 characters.

    • description

      public final String description()

      Description of the routing profile. Must not be more than 250 characters.

      Returns:
      Description of the routing profile. Must not be more than 250 characters.

    • defaultOutboundQueueId

      public final String defaultOutboundQueueId()

      The default outbound queue for the routing profile.

      Returns:
      The default outbound queue for the routing profile.

    • hasQueueConfigs

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

    • queueConfigs

      public final List<RoutingProfileQueueConfig> queueConfigs()

      The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

      The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.

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

      Returns:
      The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.

      The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.

    • 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 that 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 that agents can handle in the Contact Control Panel (CCP) 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"} }.

    • agentAvailabilityTimer

      public final AgentAvailabilityTimer agentAvailabilityTimer()

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

      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 longest idle time or time since their last inbound contact.
      See Also:

    • agentAvailabilityTimerAsString

      public final String agentAvailabilityTimerAsString()

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

      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 longest idle time or time since their last inbound contact.
      See Also:

    • toBuilder

      public CreateRoutingProfileRequest.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<CreateRoutingProfileRequest.Builder,CreateRoutingProfileRequest>
      Specified by:
      toBuilder in class ConnectRequest
      Returns:
      a builder for type T

    • builder

      public static CreateRoutingProfileRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateRoutingProfileRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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