/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace ECR { namespace Model { /** */ class DescribeImagesRequest : public ECRRequest { public: AWS_ECR_API DescribeImagesRequest(); // 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 "DescribeImages"; } AWS_ECR_API Aws::String SerializePayload() const override; AWS_ECR_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The Amazon Web Services account ID associated with the registry that contains * the repository in which to describe images. If you do not specify a registry, * the default registry is assumed.

*/ inline const Aws::String& GetRegistryId() const{ return m_registryId; } /** *

The Amazon Web Services account ID associated with the registry that contains * the repository in which to describe images. If you do not specify a registry, * the default registry is assumed.

*/ inline bool RegistryIdHasBeenSet() const { return m_registryIdHasBeenSet; } /** *

The Amazon Web Services account ID associated with the registry that contains * the repository in which to describe images. If you do not specify a registry, * the default registry is assumed.

*/ inline void SetRegistryId(const Aws::String& value) { m_registryIdHasBeenSet = true; m_registryId = value; } /** *

The Amazon Web Services account ID associated with the registry that contains * the repository in which to describe images. If you do not specify a registry, * the default registry is assumed.

*/ inline void SetRegistryId(Aws::String&& value) { m_registryIdHasBeenSet = true; m_registryId = std::move(value); } /** *

The Amazon Web Services account ID associated with the registry that contains * the repository in which to describe images. If you do not specify a registry, * the default registry is assumed.

*/ inline void SetRegistryId(const char* value) { m_registryIdHasBeenSet = true; m_registryId.assign(value); } /** *

The Amazon Web Services account ID associated with the registry that contains * the repository in which to describe images. If you do not specify a registry, * the default registry is assumed.

*/ inline DescribeImagesRequest& WithRegistryId(const Aws::String& value) { SetRegistryId(value); return *this;} /** *

The Amazon Web Services account ID associated with the registry that contains * the repository in which to describe images. If you do not specify a registry, * the default registry is assumed.

*/ inline DescribeImagesRequest& WithRegistryId(Aws::String&& value) { SetRegistryId(std::move(value)); return *this;} /** *

The Amazon Web Services account ID associated with the registry that contains * the repository in which to describe images. If you do not specify a registry, * the default registry is assumed.

*/ inline DescribeImagesRequest& WithRegistryId(const char* value) { SetRegistryId(value); return *this;} /** *

The repository that contains the images to describe.

*/ inline const Aws::String& GetRepositoryName() const{ return m_repositoryName; } /** *

The repository that contains the images to describe.

*/ inline bool RepositoryNameHasBeenSet() const { return m_repositoryNameHasBeenSet; } /** *

The repository that contains the images to describe.

*/ inline void SetRepositoryName(const Aws::String& value) { m_repositoryNameHasBeenSet = true; m_repositoryName = value; } /** *

The repository that contains the images to describe.

*/ inline void SetRepositoryName(Aws::String&& value) { m_repositoryNameHasBeenSet = true; m_repositoryName = std::move(value); } /** *

The repository that contains the images to describe.

*/ inline void SetRepositoryName(const char* value) { m_repositoryNameHasBeenSet = true; m_repositoryName.assign(value); } /** *

The repository that contains the images to describe.

*/ inline DescribeImagesRequest& WithRepositoryName(const Aws::String& value) { SetRepositoryName(value); return *this;} /** *

The repository that contains the images to describe.

*/ inline DescribeImagesRequest& WithRepositoryName(Aws::String&& value) { SetRepositoryName(std::move(value)); return *this;} /** *

The repository that contains the images to describe.

*/ inline DescribeImagesRequest& WithRepositoryName(const char* value) { SetRepositoryName(value); return *this;} /** *

The list of image IDs for the requested repository.

*/ inline const Aws::Vector& GetImageIds() const{ return m_imageIds; } /** *

The list of image IDs for the requested repository.

*/ inline bool ImageIdsHasBeenSet() const { return m_imageIdsHasBeenSet; } /** *

The list of image IDs for the requested repository.

*/ inline void SetImageIds(const Aws::Vector& value) { m_imageIdsHasBeenSet = true; m_imageIds = value; } /** *

The list of image IDs for the requested repository.

*/ inline void SetImageIds(Aws::Vector&& value) { m_imageIdsHasBeenSet = true; m_imageIds = std::move(value); } /** *

The list of image IDs for the requested repository.

*/ inline DescribeImagesRequest& WithImageIds(const Aws::Vector& value) { SetImageIds(value); return *this;} /** *

The list of image IDs for the requested repository.

*/ inline DescribeImagesRequest& WithImageIds(Aws::Vector&& value) { SetImageIds(std::move(value)); return *this;} /** *

The list of image IDs for the requested repository.

*/ inline DescribeImagesRequest& AddImageIds(const ImageIdentifier& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(value); return *this; } /** *

The list of image IDs for the requested repository.

*/ inline DescribeImagesRequest& AddImageIds(ImageIdentifier&& value) { m_imageIdsHasBeenSet = true; m_imageIds.push_back(std::move(value)); return *this; } /** *

The nextToken value returned from a previous paginated * DescribeImages 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. This option * cannot be used when you specify images with imageIds.

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

The nextToken value returned from a previous paginated * DescribeImages 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. This option * cannot be used when you specify images with imageIds.

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

The nextToken value returned from a previous paginated * DescribeImages 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. This option * cannot be used when you specify images with imageIds.

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

The nextToken value returned from a previous paginated * DescribeImages 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. This option * cannot be used when you specify images with imageIds.

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

The nextToken value returned from a previous paginated * DescribeImages 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. This option * cannot be used when you specify images with imageIds.

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

The nextToken value returned from a previous paginated * DescribeImages 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. This option * cannot be used when you specify images with imageIds.

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

The nextToken value returned from a previous paginated * DescribeImages 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. This option * cannot be used when you specify images with imageIds.

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

The nextToken value returned from a previous paginated * DescribeImages 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. This option * cannot be used when you specify images with imageIds.

*/ inline DescribeImagesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of repository results returned by * DescribeImages in paginated output. When this parameter is used, * DescribeImages only returns maxResults results in a * single page along with a nextToken response element. The remaining * results of the initial request can be seen by sending another * DescribeImages request with the returned nextToken * value. This value can be between 1 and 1000. If this parameter is not used, then * DescribeImages returns up to 100 results and a * nextToken value, if applicable. This option cannot be used when you * specify images with imageIds.

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

The maximum number of repository results returned by * DescribeImages in paginated output. When this parameter is used, * DescribeImages only returns maxResults results in a * single page along with a nextToken response element. The remaining * results of the initial request can be seen by sending another * DescribeImages request with the returned nextToken * value. This value can be between 1 and 1000. If this parameter is not used, then * DescribeImages returns up to 100 results and a * nextToken value, if applicable. This option cannot be used when you * specify images with imageIds.

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

The maximum number of repository results returned by * DescribeImages in paginated output. When this parameter is used, * DescribeImages only returns maxResults results in a * single page along with a nextToken response element. The remaining * results of the initial request can be seen by sending another * DescribeImages request with the returned nextToken * value. This value can be between 1 and 1000. If this parameter is not used, then * DescribeImages returns up to 100 results and a * nextToken value, if applicable. This option cannot be used when you * specify images with imageIds.

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

The maximum number of repository results returned by * DescribeImages in paginated output. When this parameter is used, * DescribeImages only returns maxResults results in a * single page along with a nextToken response element. The remaining * results of the initial request can be seen by sending another * DescribeImages request with the returned nextToken * value. This value can be between 1 and 1000. If this parameter is not used, then * DescribeImages returns up to 100 results and a * nextToken value, if applicable. This option cannot be used when you * specify images with imageIds.

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

The filter key and value with which to filter your * DescribeImages results.

*/ inline const DescribeImagesFilter& GetFilter() const{ return m_filter; } /** *

The filter key and value with which to filter your * DescribeImages results.

*/ inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; } /** *

The filter key and value with which to filter your * DescribeImages results.

*/ inline void SetFilter(const DescribeImagesFilter& value) { m_filterHasBeenSet = true; m_filter = value; } /** *

The filter key and value with which to filter your * DescribeImages results.

*/ inline void SetFilter(DescribeImagesFilter&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); } /** *

The filter key and value with which to filter your * DescribeImages results.

*/ inline DescribeImagesRequest& WithFilter(const DescribeImagesFilter& value) { SetFilter(value); return *this;} /** *

The filter key and value with which to filter your * DescribeImages results.

*/ inline DescribeImagesRequest& WithFilter(DescribeImagesFilter&& value) { SetFilter(std::move(value)); return *this;} private: Aws::String m_registryId; bool m_registryIdHasBeenSet = false; Aws::String m_repositoryName; bool m_repositoryNameHasBeenSet = false; Aws::Vector m_imageIds; bool m_imageIdsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; DescribeImagesFilter m_filter; bool m_filterHasBeenSet = false; }; } // namespace Model } // namespace ECR } // namespace Aws