/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace SWF { namespace Model { /** */ class PollForDecisionTaskRequest : public SWFRequest { public: AWS_SWF_API PollForDecisionTaskRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "PollForDecisionTask"; } AWS_SWF_API Aws::String SerializePayload() const override; AWS_SWF_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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

*/ inline const Aws::String& GetDomain() const{ return m_domain; } /** *

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

*/ inline bool DomainHasBeenSet() const { return m_domainHasBeenSet; } /** *

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

*/ inline void SetDomain(const Aws::String& value) { m_domainHasBeenSet = true; m_domain = value; } /** *

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

*/ inline void SetDomain(Aws::String&& value) { m_domainHasBeenSet = true; m_domain = std::move(value); } /** *

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

*/ inline void SetDomain(const char* value) { m_domainHasBeenSet = true; m_domain.assign(value); } /** *

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

*/ inline PollForDecisionTaskRequest& WithDomain(const Aws::String& value) { SetDomain(value); return *this;} /** *

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

*/ inline PollForDecisionTaskRequest& WithDomain(Aws::String&& value) { SetDomain(std::move(value)); return *this;} /** *

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

*/ inline PollForDecisionTaskRequest& WithDomain(const char* value) { SetDomain(value); return *this;} /** *

Specifies the task list to poll for decision tasks.

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

*/ inline const TaskList& GetTaskList() const{ return m_taskList; } /** *

Specifies the task list to poll for decision tasks.

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

*/ inline bool TaskListHasBeenSet() const { return m_taskListHasBeenSet; } /** *

Specifies the task list to poll for decision tasks.

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

*/ inline void SetTaskList(const TaskList& value) { m_taskListHasBeenSet = true; m_taskList = value; } /** *

Specifies the task list to poll for decision tasks.

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

*/ inline void SetTaskList(TaskList&& value) { m_taskListHasBeenSet = true; m_taskList = std::move(value); } /** *

Specifies the task list to poll for decision tasks.

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

*/ inline PollForDecisionTaskRequest& WithTaskList(const TaskList& value) { SetTaskList(value); return *this;} /** *

Specifies the task list to poll for decision tasks.

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

*/ inline PollForDecisionTaskRequest& WithTaskList(TaskList&& value) { SetTaskList(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetIdentity() const{ return m_identity; } /** *

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.

*/ inline bool IdentityHasBeenSet() const { return m_identityHasBeenSet; } /** *

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.

*/ inline void SetIdentity(const Aws::String& value) { m_identityHasBeenSet = true; m_identity = value; } /** *

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.

*/ inline void SetIdentity(Aws::String&& value) { m_identityHasBeenSet = true; m_identity = std::move(value); } /** *

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.

*/ inline void SetIdentity(const char* value) { m_identityHasBeenSet = true; m_identity.assign(value); } /** *

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.

*/ inline PollForDecisionTaskRequest& WithIdentity(const Aws::String& value) { SetIdentity(value); return *this;} /** *

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.

*/ inline PollForDecisionTaskRequest& WithIdentity(Aws::String&& value) { SetIdentity(std::move(value)); return *this;} /** *

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.

*/ inline PollForDecisionTaskRequest& WithIdentity(const char* value) { SetIdentity(value); return *this;} /** *

If NextPageToken is returned there are more results available. * The value of NextPageToken is a unique pagination token for each * page. Make the call again using the returned token to retrieve the next page. * Keep all other arguments unchanged. Each pagination token expires after 24 * hours. Using an expired pagination token will return a 400 error: * "Specified token has exceeded its maximum lifetime".

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.

*/ inline const Aws::String& GetNextPageToken() const{ return m_nextPageToken; } /** *

If NextPageToken is returned there are more results available. * The value of NextPageToken is a unique pagination token for each * page. Make the call again using the returned token to retrieve the next page. * Keep all other arguments unchanged. Each pagination token expires after 24 * hours. Using an expired pagination token will return a 400 error: * "Specified token has exceeded its maximum lifetime".

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.

*/ inline bool NextPageTokenHasBeenSet() const { return m_nextPageTokenHasBeenSet; } /** *

If NextPageToken is returned there are more results available. * The value of NextPageToken is a unique pagination token for each * page. Make the call again using the returned token to retrieve the next page. * Keep all other arguments unchanged. Each pagination token expires after 24 * hours. Using an expired pagination token will return a 400 error: * "Specified token has exceeded its maximum lifetime".

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.

*/ inline void SetNextPageToken(const Aws::String& value) { m_nextPageTokenHasBeenSet = true; m_nextPageToken = value; } /** *

If NextPageToken is returned there are more results available. * The value of NextPageToken is a unique pagination token for each * page. Make the call again using the returned token to retrieve the next page. * Keep all other arguments unchanged. Each pagination token expires after 24 * hours. Using an expired pagination token will return a 400 error: * "Specified token has exceeded its maximum lifetime".

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.

*/ inline void SetNextPageToken(Aws::String&& value) { m_nextPageTokenHasBeenSet = true; m_nextPageToken = std::move(value); } /** *

If NextPageToken is returned there are more results available. * The value of NextPageToken is a unique pagination token for each * page. Make the call again using the returned token to retrieve the next page. * Keep all other arguments unchanged. Each pagination token expires after 24 * hours. Using an expired pagination token will return a 400 error: * "Specified token has exceeded its maximum lifetime".

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.

*/ inline void SetNextPageToken(const char* value) { m_nextPageTokenHasBeenSet = true; m_nextPageToken.assign(value); } /** *

If NextPageToken is returned there are more results available. * The value of NextPageToken is a unique pagination token for each * page. Make the call again using the returned token to retrieve the next page. * Keep all other arguments unchanged. Each pagination token expires after 24 * hours. Using an expired pagination token will return a 400 error: * "Specified token has exceeded its maximum lifetime".

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.

*/ inline PollForDecisionTaskRequest& WithNextPageToken(const Aws::String& value) { SetNextPageToken(value); return *this;} /** *

If NextPageToken is returned there are more results available. * The value of NextPageToken is a unique pagination token for each * page. Make the call again using the returned token to retrieve the next page. * Keep all other arguments unchanged. Each pagination token expires after 24 * hours. Using an expired pagination token will return a 400 error: * "Specified token has exceeded its maximum lifetime".

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.

*/ inline PollForDecisionTaskRequest& WithNextPageToken(Aws::String&& value) { SetNextPageToken(std::move(value)); return *this;} /** *

If NextPageToken is returned there are more results available. * The value of NextPageToken is a unique pagination token for each * page. Make the call again using the returned token to retrieve the next page. * Keep all other arguments unchanged. Each pagination token expires after 24 * hours. Using an expired pagination token will return a 400 error: * "Specified token has exceeded its maximum lifetime".

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.

*/ inline PollForDecisionTaskRequest& WithNextPageToken(const char* value) { SetNextPageToken(value); return *this;} /** *

The maximum number of results that are returned per call. Use * nextPageToken to obtain further pages of results.

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

*/ inline int GetMaximumPageSize() const{ return m_maximumPageSize; } /** *

The maximum number of results that are returned per call. Use * nextPageToken to obtain further pages of results.

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

*/ inline bool MaximumPageSizeHasBeenSet() const { return m_maximumPageSizeHasBeenSet; } /** *

The maximum number of results that are returned per call. Use * nextPageToken to obtain further pages of results.

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

*/ inline void SetMaximumPageSize(int value) { m_maximumPageSizeHasBeenSet = true; m_maximumPageSize = value; } /** *

The maximum number of results that are returned per call. Use * nextPageToken to obtain further pages of results.

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

*/ inline PollForDecisionTaskRequest& WithMaximumPageSize(int value) { SetMaximumPageSize(value); return *this;} /** *

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.

*/ inline bool GetReverseOrder() const{ return m_reverseOrder; } /** *

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.

*/ inline bool ReverseOrderHasBeenSet() const { return m_reverseOrderHasBeenSet; } /** *

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.

*/ inline void SetReverseOrder(bool value) { m_reverseOrderHasBeenSet = true; m_reverseOrder = value; } /** *

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.

*/ inline PollForDecisionTaskRequest& WithReverseOrder(bool value) { SetReverseOrder(value); return *this;} /** *

When set to true, returns the events with * eventTimestamp greater than or equal to eventTimestamp * of the most recent DecisionTaskStarted event. By default, this * parameter is set to false.

*/ inline bool GetStartAtPreviousStartedEvent() const{ return m_startAtPreviousStartedEvent; } /** *

When set to true, returns the events with * eventTimestamp greater than or equal to eventTimestamp * of the most recent DecisionTaskStarted event. By default, this * parameter is set to false.

*/ inline bool StartAtPreviousStartedEventHasBeenSet() const { return m_startAtPreviousStartedEventHasBeenSet; } /** *

When set to true, returns the events with * eventTimestamp greater than or equal to eventTimestamp * of the most recent DecisionTaskStarted event. By default, this * parameter is set to false.

*/ inline void SetStartAtPreviousStartedEvent(bool value) { m_startAtPreviousStartedEventHasBeenSet = true; m_startAtPreviousStartedEvent = value; } /** *

When set to true, returns the events with * eventTimestamp greater than or equal to eventTimestamp * of the most recent DecisionTaskStarted event. By default, this * parameter is set to false.

*/ inline PollForDecisionTaskRequest& WithStartAtPreviousStartedEvent(bool value) { SetStartAtPreviousStartedEvent(value); return *this;} private: Aws::String m_domain; bool m_domainHasBeenSet = false; TaskList m_taskList; bool m_taskListHasBeenSet = false; Aws::String m_identity; bool m_identityHasBeenSet = false; Aws::String m_nextPageToken; bool m_nextPageTokenHasBeenSet = false; int m_maximumPageSize; bool m_maximumPageSizeHasBeenSet = false; bool m_reverseOrder; bool m_reverseOrderHasBeenSet = false; bool m_startAtPreviousStartedEvent; bool m_startAtPreviousStartedEventHasBeenSet = false; }; } // namespace Model } // namespace SWF } // namespace Aws