You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SWF::Types::PollForDecisionTaskInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb

Overview

Note:

When making an API call, you may pass PollForDecisionTaskInput data as a hash:

{
  domain: "DomainName", # required
  task_list: { # required
    name: "Name", # required
  },
  identity: "Identity",
  next_page_token: "PageToken",
  maximum_page_size: 1,
  reverse_order: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#domainString

The name of the domain containing the task lists to poll.

Returns:

  • (String)


3668
3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3668

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#identityString

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

Returns:

  • (String)


3668
3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3668

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#maximum_page_sizeInteger

The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Returns:

  • (Integer)


3668
3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3668

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#next_page_tokenString

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Returns:

  • (String)


3668
3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3668

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#reverse_orderBoolean

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

Returns:

  • (Boolean)


3668
3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3668

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end

#task_listTypes::TaskList

Specifies the task list to poll for decision tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not contain the literal string arn.

Returns:



3668
3669
3670
3671
3672
3673
3674
3675
3676
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 3668

class PollForDecisionTaskInput < Struct.new(
  :domain,
  :task_list,
  :identity,
  :next_page_token,
  :maximum_page_size,
  :reverse_order)
  include Aws::Structure
end