Interface GetCurrentUserDataRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<GetCurrentUserDataRequest.Builder,GetCurrentUserDataRequest>, SdkBuilder<GetCurrentUserDataRequest.Builder,GetCurrentUserDataRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetCurrentUserDataRequest

public static interface GetCurrentUserDataRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<GetCurrentUserDataRequest.Builder,GetCurrentUserDataRequest>
  • Method Details

    • instanceId

      GetCurrentUserDataRequest.Builder instanceId(String instanceId)

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

      Parameters:
      instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filters

      The filters to apply to returned user data. You can filter up to the following limits:

      • Queues: 100

      • Routing profiles: 100

      • Agents: 100

      • Contact states: 9

      • User hierarchy groups: 1

      The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

      Currently tagging is only supported on the resources that are passed in the filter.

      Parameters:
      filters - The filters to apply to returned user data. You can filter up to the following limits:

      • Queues: 100

      • Routing profiles: 100

      • Agents: 100

      • Contact states: 9

      • User hierarchy groups: 1

      The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

      Currently tagging is only supported on the resources that are passed in the filter.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • filters

      The filters to apply to returned user data. You can filter up to the following limits:

      • Queues: 100

      • Routing profiles: 100

      • Agents: 100

      • Contact states: 9

      • User hierarchy groups: 1

      The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.

      Currently tagging is only supported on the resources that are passed in the filter.

      This is a convenience method that creates an instance of the UserDataFilters.Builder avoiding the need to create one manually via UserDataFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(UserDataFilters).

      Parameters:
      filters - a consumer that will call methods on UserDataFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • nextToken

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      Parameters:
      nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxResults

      The maximum number of results to return per page.

      Parameters:
      maxResults - The maximum number of results to return per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      GetCurrentUserDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.