/** * 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 GetWorkflowExecutionHistoryRequest : public SWFRequest { public: AWS_SWF_API GetWorkflowExecutionHistoryRequest(); // 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 "GetWorkflowExecutionHistory"; } AWS_SWF_API Aws::String SerializePayload() const override; AWS_SWF_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the domain containing the workflow execution.

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

The name of the domain containing the workflow execution.

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

The name of the domain containing the workflow execution.

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

The name of the domain containing the workflow execution.

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

The name of the domain containing the workflow execution.

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

The name of the domain containing the workflow execution.

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

The name of the domain containing the workflow execution.

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

The name of the domain containing the workflow execution.

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

Specifies the workflow execution for which to return the history.

*/ inline const WorkflowExecution& GetExecution() const{ return m_execution; } /** *

Specifies the workflow execution for which to return the history.

*/ inline bool ExecutionHasBeenSet() const { return m_executionHasBeenSet; } /** *

Specifies the workflow execution for which to return the history.

*/ inline void SetExecution(const WorkflowExecution& value) { m_executionHasBeenSet = true; m_execution = value; } /** *

Specifies the workflow execution for which to return the history.

*/ inline void SetExecution(WorkflowExecution&& value) { m_executionHasBeenSet = true; m_execution = std::move(value); } /** *

Specifies the workflow execution for which to return the history.

*/ inline GetWorkflowExecutionHistoryRequest& WithExecution(const WorkflowExecution& value) { SetExecution(value); return *this;} /** *

Specifies the workflow execution for which to return the history.

*/ inline GetWorkflowExecutionHistoryRequest& WithExecution(WorkflowExecution&& value) { SetExecution(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.

*/ 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.

*/ 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.

*/ 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.

*/ 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.

*/ 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.

*/ inline GetWorkflowExecutionHistoryRequest& 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.

*/ inline GetWorkflowExecutionHistoryRequest& 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.

*/ inline GetWorkflowExecutionHistoryRequest& 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.

*/ 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.

*/ 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.

*/ 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.

*/ inline GetWorkflowExecutionHistoryRequest& 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 GetWorkflowExecutionHistoryRequest& WithReverseOrder(bool value) { SetReverseOrder(value); return *this;} private: Aws::String m_domain; bool m_domainHasBeenSet = false; WorkflowExecution m_execution; bool m_executionHasBeenSet = false; Aws::String m_nextPageToken; bool m_nextPageTokenHasBeenSet = false; int m_maximumPageSize; bool m_maximumPageSizeHasBeenSet = false; bool m_reverseOrder; bool m_reverseOrderHasBeenSet = false; }; } // namespace Model } // namespace SWF } // namespace Aws