/** * 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 Batch { namespace Model { /** *

Contains the parameters for * DescribeJobDefinitions.

See Also:

AWS * API Reference

*/ class DescribeJobDefinitionsRequest : public BatchRequest { public: AWS_BATCH_API DescribeJobDefinitionsRequest(); // 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 "DescribeJobDefinitions"; } AWS_BATCH_API Aws::String SerializePayload() const override; /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline const Aws::Vector& GetJobDefinitions() const{ return m_jobDefinitions; } /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline bool JobDefinitionsHasBeenSet() const { return m_jobDefinitionsHasBeenSet; } /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline void SetJobDefinitions(const Aws::Vector& value) { m_jobDefinitionsHasBeenSet = true; m_jobDefinitions = value; } /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline void SetJobDefinitions(Aws::Vector&& value) { m_jobDefinitionsHasBeenSet = true; m_jobDefinitions = std::move(value); } /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline DescribeJobDefinitionsRequest& WithJobDefinitions(const Aws::Vector& value) { SetJobDefinitions(value); return *this;} /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline DescribeJobDefinitionsRequest& WithJobDefinitions(Aws::Vector&& value) { SetJobDefinitions(std::move(value)); return *this;} /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline DescribeJobDefinitionsRequest& AddJobDefinitions(const Aws::String& value) { m_jobDefinitionsHasBeenSet = true; m_jobDefinitions.push_back(value); return *this; } /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline DescribeJobDefinitionsRequest& AddJobDefinitions(Aws::String&& value) { m_jobDefinitionsHasBeenSet = true; m_jobDefinitions.push_back(std::move(value)); return *this; } /** *

A list of up to 100 job definitions. Each entry in the list can either be an * ARN in the format * arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} * or a short version using the form * ${JobDefinitionName}:${Revision}.

*/ inline DescribeJobDefinitionsRequest& AddJobDefinitions(const char* value) { m_jobDefinitionsHasBeenSet = true; m_jobDefinitions.push_back(value); return *this; } /** *

The maximum number of results returned by DescribeJobDefinitions * in paginated output. When this parameter is used, * DescribeJobDefinitions only returns maxResults results * in a single page and a nextToken response element. The remaining * results of the initial request can be seen by sending another * DescribeJobDefinitions request with the returned * nextToken value. This value can be between 1 and 100. If this * parameter isn't used, then DescribeJobDefinitions returns up to 100 * results and a nextToken value if applicable.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of results returned by DescribeJobDefinitions * in paginated output. When this parameter is used, * DescribeJobDefinitions only returns maxResults results * in a single page and a nextToken response element. The remaining * results of the initial request can be seen by sending another * DescribeJobDefinitions request with the returned * nextToken value. This value can be between 1 and 100. If this * parameter isn't used, then DescribeJobDefinitions returns up to 100 * results and a nextToken value if applicable.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of results returned by DescribeJobDefinitions * in paginated output. When this parameter is used, * DescribeJobDefinitions only returns maxResults results * in a single page and a nextToken response element. The remaining * results of the initial request can be seen by sending another * DescribeJobDefinitions request with the returned * nextToken value. This value can be between 1 and 100. If this * parameter isn't used, then DescribeJobDefinitions returns up to 100 * results and a nextToken value if applicable.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of results returned by DescribeJobDefinitions * in paginated output. When this parameter is used, * DescribeJobDefinitions only returns maxResults results * in a single page and a nextToken response element. The remaining * results of the initial request can be seen by sending another * DescribeJobDefinitions request with the returned * nextToken value. This value can be between 1 and 100. If this * parameter isn't used, then DescribeJobDefinitions returns up to 100 * results and a nextToken value if applicable.

*/ inline DescribeJobDefinitionsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

The name of the job definition to describe.

*/ inline const Aws::String& GetJobDefinitionName() const{ return m_jobDefinitionName; } /** *

The name of the job definition to describe.

*/ inline bool JobDefinitionNameHasBeenSet() const { return m_jobDefinitionNameHasBeenSet; } /** *

The name of the job definition to describe.

*/ inline void SetJobDefinitionName(const Aws::String& value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName = value; } /** *

The name of the job definition to describe.

*/ inline void SetJobDefinitionName(Aws::String&& value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName = std::move(value); } /** *

The name of the job definition to describe.

*/ inline void SetJobDefinitionName(const char* value) { m_jobDefinitionNameHasBeenSet = true; m_jobDefinitionName.assign(value); } /** *

The name of the job definition to describe.

*/ inline DescribeJobDefinitionsRequest& WithJobDefinitionName(const Aws::String& value) { SetJobDefinitionName(value); return *this;} /** *

The name of the job definition to describe.

*/ inline DescribeJobDefinitionsRequest& WithJobDefinitionName(Aws::String&& value) { SetJobDefinitionName(std::move(value)); return *this;} /** *

The name of the job definition to describe.

*/ inline DescribeJobDefinitionsRequest& WithJobDefinitionName(const char* value) { SetJobDefinitionName(value); return *this;} /** *

The status used to filter job definitions.

*/ inline const Aws::String& GetStatus() const{ return m_status; } /** *

The status used to filter job definitions.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The status used to filter job definitions.

*/ inline void SetStatus(const Aws::String& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The status used to filter job definitions.

*/ inline void SetStatus(Aws::String&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The status used to filter job definitions.

*/ inline void SetStatus(const char* value) { m_statusHasBeenSet = true; m_status.assign(value); } /** *

The status used to filter job definitions.

*/ inline DescribeJobDefinitionsRequest& WithStatus(const Aws::String& value) { SetStatus(value); return *this;} /** *

The status used to filter job definitions.

*/ inline DescribeJobDefinitionsRequest& WithStatus(Aws::String&& value) { SetStatus(std::move(value)); return *this;} /** *

The status used to filter job definitions.

*/ inline DescribeJobDefinitionsRequest& WithStatus(const char* value) { SetStatus(value); return *this;} /** *

The nextToken value returned from a previous paginated * DescribeJobDefinitions request where maxResults was * used and the results exceeded the value of that parameter. Pagination continues * from the end of the previous results that returned the nextToken * value. This value is null when there are no more results to * return.

Treat this token as an opaque identifier that's only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

The nextToken value returned from a previous paginated * DescribeJobDefinitions request where maxResults was * used and the results exceeded the value of that parameter. Pagination continues * from the end of the previous results that returned the nextToken * value. This value is null when there are no more results to * return.

Treat this token as an opaque identifier that's only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

The nextToken value returned from a previous paginated * DescribeJobDefinitions request where maxResults was * used and the results exceeded the value of that parameter. Pagination continues * from the end of the previous results that returned the nextToken * value. This value is null when there are no more results to * return.

Treat this token as an opaque identifier that's only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

The nextToken value returned from a previous paginated * DescribeJobDefinitions request where maxResults was * used and the results exceeded the value of that parameter. Pagination continues * from the end of the previous results that returned the nextToken * value. This value is null when there are no more results to * return.

Treat this token as an opaque identifier that's only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

The nextToken value returned from a previous paginated * DescribeJobDefinitions request where maxResults was * used and the results exceeded the value of that parameter. Pagination continues * from the end of the previous results that returned the nextToken * value. This value is null when there are no more results to * return.

Treat this token as an opaque identifier that's only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

The nextToken value returned from a previous paginated * DescribeJobDefinitions request where maxResults was * used and the results exceeded the value of that parameter. Pagination continues * from the end of the previous results that returned the nextToken * value. This value is null when there are no more results to * return.

Treat this token as an opaque identifier that's only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline DescribeJobDefinitionsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

The nextToken value returned from a previous paginated * DescribeJobDefinitions request where maxResults was * used and the results exceeded the value of that parameter. Pagination continues * from the end of the previous results that returned the nextToken * value. This value is null when there are no more results to * return.

Treat this token as an opaque identifier that's only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline DescribeJobDefinitionsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

The nextToken value returned from a previous paginated * DescribeJobDefinitions request where maxResults was * used and the results exceeded the value of that parameter. Pagination continues * from the end of the previous results that returned the nextToken * value. This value is null when there are no more results to * return.

Treat this token as an opaque identifier that's only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline DescribeJobDefinitionsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::Vector m_jobDefinitions; bool m_jobDefinitionsHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_jobDefinitionName; bool m_jobDefinitionNameHasBeenSet = false; Aws::String m_status; bool m_statusHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace Batch } // namespace Aws