/** * 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 Http { class URI; } //namespace Http namespace CodeArtifact { namespace Model { /** */ class ListPackagesRequest : public CodeArtifactRequest { public: AWS_CODEARTIFACT_API ListPackagesRequest(); // 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 "ListPackages"; } AWS_CODEARTIFACT_API Aws::String SerializePayload() const override; AWS_CODEARTIFACT_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The name of the domain that contains the repository that contains the * requested packages.

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

The name of the domain that contains the repository that contains the * requested packages.

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

The name of the domain that contains the repository that contains the * requested packages.

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

The name of the domain that contains the repository that contains the * requested packages.

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

The name of the domain that contains the repository that contains the * requested packages.

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

The name of the domain that contains the repository that contains the * requested packages.

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

The name of the domain that contains the repository that contains the * requested packages.

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

The name of the domain that contains the repository that contains the * requested packages.

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

The 12-digit account number of the Amazon Web Services account that owns the * domain. It does not include dashes or spaces.

*/ inline const Aws::String& GetDomainOwner() const{ return m_domainOwner; } /** *

The 12-digit account number of the Amazon Web Services account that owns the * domain. It does not include dashes or spaces.

*/ inline bool DomainOwnerHasBeenSet() const { return m_domainOwnerHasBeenSet; } /** *

The 12-digit account number of the Amazon Web Services account that owns the * domain. It does not include dashes or spaces.

*/ inline void SetDomainOwner(const Aws::String& value) { m_domainOwnerHasBeenSet = true; m_domainOwner = value; } /** *

The 12-digit account number of the Amazon Web Services account that owns the * domain. It does not include dashes or spaces.

*/ inline void SetDomainOwner(Aws::String&& value) { m_domainOwnerHasBeenSet = true; m_domainOwner = std::move(value); } /** *

The 12-digit account number of the Amazon Web Services account that owns the * domain. It does not include dashes or spaces.

*/ inline void SetDomainOwner(const char* value) { m_domainOwnerHasBeenSet = true; m_domainOwner.assign(value); } /** *

The 12-digit account number of the Amazon Web Services account that owns the * domain. It does not include dashes or spaces.

*/ inline ListPackagesRequest& WithDomainOwner(const Aws::String& value) { SetDomainOwner(value); return *this;} /** *

The 12-digit account number of the Amazon Web Services account that owns the * domain. It does not include dashes or spaces.

*/ inline ListPackagesRequest& WithDomainOwner(Aws::String&& value) { SetDomainOwner(std::move(value)); return *this;} /** *

The 12-digit account number of the Amazon Web Services account that owns the * domain. It does not include dashes or spaces.

*/ inline ListPackagesRequest& WithDomainOwner(const char* value) { SetDomainOwner(value); return *this;} /** *

The name of the repository that contains the requested packages.

*/ inline const Aws::String& GetRepository() const{ return m_repository; } /** *

The name of the repository that contains the requested packages.

*/ inline bool RepositoryHasBeenSet() const { return m_repositoryHasBeenSet; } /** *

The name of the repository that contains the requested packages.

*/ inline void SetRepository(const Aws::String& value) { m_repositoryHasBeenSet = true; m_repository = value; } /** *

The name of the repository that contains the requested packages.

*/ inline void SetRepository(Aws::String&& value) { m_repositoryHasBeenSet = true; m_repository = std::move(value); } /** *

The name of the repository that contains the requested packages.

*/ inline void SetRepository(const char* value) { m_repositoryHasBeenSet = true; m_repository.assign(value); } /** *

The name of the repository that contains the requested packages.

*/ inline ListPackagesRequest& WithRepository(const Aws::String& value) { SetRepository(value); return *this;} /** *

The name of the repository that contains the requested packages.

*/ inline ListPackagesRequest& WithRepository(Aws::String&& value) { SetRepository(std::move(value)); return *this;} /** *

The name of the repository that contains the requested packages.

*/ inline ListPackagesRequest& WithRepository(const char* value) { SetRepository(value); return *this;} /** *

The format used to filter requested packages. Only packages from the provided * format will be returned.

*/ inline const PackageFormat& GetFormat() const{ return m_format; } /** *

The format used to filter requested packages. Only packages from the provided * format will be returned.

*/ inline bool FormatHasBeenSet() const { return m_formatHasBeenSet; } /** *

The format used to filter requested packages. Only packages from the provided * format will be returned.

*/ inline void SetFormat(const PackageFormat& value) { m_formatHasBeenSet = true; m_format = value; } /** *

The format used to filter requested packages. Only packages from the provided * format will be returned.

*/ inline void SetFormat(PackageFormat&& value) { m_formatHasBeenSet = true; m_format = std::move(value); } /** *

The format used to filter requested packages. Only packages from the provided * format will be returned.

*/ inline ListPackagesRequest& WithFormat(const PackageFormat& value) { SetFormat(value); return *this;} /** *

The format used to filter requested packages. Only packages from the provided * format will be returned.

*/ inline ListPackagesRequest& WithFormat(PackageFormat&& value) { SetFormat(std::move(value)); return *this;} /** *

The namespace prefix used to filter requested packages. Only packages with a * namespace that starts with the provided string value are returned. Note that * although this option is called --namespace and not * --namespace-prefix, it has prefix-matching behavior.

Each * package format uses namespace as follows:

  • The namespace of a * Maven package is its groupId.

  • The namespace of * an npm package is its scope.

  • Python and NuGet * packages do not contain a corresponding component, packages of those formats do * not have a namespace.

  • The namespace of a generic package is * its namespace.

*/ inline const Aws::String& GetNamespace() const{ return m_namespace; } /** *

The namespace prefix used to filter requested packages. Only packages with a * namespace that starts with the provided string value are returned. Note that * although this option is called --namespace and not * --namespace-prefix, it has prefix-matching behavior.

Each * package format uses namespace as follows:

  • The namespace of a * Maven package is its groupId.

  • The namespace of * an npm package is its scope.

  • Python and NuGet * packages do not contain a corresponding component, packages of those formats do * not have a namespace.

  • The namespace of a generic package is * its namespace.

*/ inline bool NamespaceHasBeenSet() const { return m_namespaceHasBeenSet; } /** *

The namespace prefix used to filter requested packages. Only packages with a * namespace that starts with the provided string value are returned. Note that * although this option is called --namespace and not * --namespace-prefix, it has prefix-matching behavior.

Each * package format uses namespace as follows:

  • The namespace of a * Maven package is its groupId.

  • The namespace of * an npm package is its scope.

  • Python and NuGet * packages do not contain a corresponding component, packages of those formats do * not have a namespace.

  • The namespace of a generic package is * its namespace.

*/ inline void SetNamespace(const Aws::String& value) { m_namespaceHasBeenSet = true; m_namespace = value; } /** *

The namespace prefix used to filter requested packages. Only packages with a * namespace that starts with the provided string value are returned. Note that * although this option is called --namespace and not * --namespace-prefix, it has prefix-matching behavior.

Each * package format uses namespace as follows:

  • The namespace of a * Maven package is its groupId.

  • The namespace of * an npm package is its scope.

  • Python and NuGet * packages do not contain a corresponding component, packages of those formats do * not have a namespace.

  • The namespace of a generic package is * its namespace.

*/ inline void SetNamespace(Aws::String&& value) { m_namespaceHasBeenSet = true; m_namespace = std::move(value); } /** *

The namespace prefix used to filter requested packages. Only packages with a * namespace that starts with the provided string value are returned. Note that * although this option is called --namespace and not * --namespace-prefix, it has prefix-matching behavior.

Each * package format uses namespace as follows:

  • The namespace of a * Maven package is its groupId.

  • The namespace of * an npm package is its scope.

  • Python and NuGet * packages do not contain a corresponding component, packages of those formats do * not have a namespace.

  • The namespace of a generic package is * its namespace.

*/ inline void SetNamespace(const char* value) { m_namespaceHasBeenSet = true; m_namespace.assign(value); } /** *

The namespace prefix used to filter requested packages. Only packages with a * namespace that starts with the provided string value are returned. Note that * although this option is called --namespace and not * --namespace-prefix, it has prefix-matching behavior.

Each * package format uses namespace as follows:

  • The namespace of a * Maven package is its groupId.

  • The namespace of * an npm package is its scope.

  • Python and NuGet * packages do not contain a corresponding component, packages of those formats do * not have a namespace.

  • The namespace of a generic package is * its namespace.

*/ inline ListPackagesRequest& WithNamespace(const Aws::String& value) { SetNamespace(value); return *this;} /** *

The namespace prefix used to filter requested packages. Only packages with a * namespace that starts with the provided string value are returned. Note that * although this option is called --namespace and not * --namespace-prefix, it has prefix-matching behavior.

Each * package format uses namespace as follows:

  • The namespace of a * Maven package is its groupId.

  • The namespace of * an npm package is its scope.

  • Python and NuGet * packages do not contain a corresponding component, packages of those formats do * not have a namespace.

  • The namespace of a generic package is * its namespace.

*/ inline ListPackagesRequest& WithNamespace(Aws::String&& value) { SetNamespace(std::move(value)); return *this;} /** *

The namespace prefix used to filter requested packages. Only packages with a * namespace that starts with the provided string value are returned. Note that * although this option is called --namespace and not * --namespace-prefix, it has prefix-matching behavior.

Each * package format uses namespace as follows:

  • The namespace of a * Maven package is its groupId.

  • The namespace of * an npm package is its scope.

  • Python and NuGet * packages do not contain a corresponding component, packages of those formats do * not have a namespace.

  • The namespace of a generic package is * its namespace.

*/ inline ListPackagesRequest& WithNamespace(const char* value) { SetNamespace(value); return *this;} /** *

A prefix used to filter requested packages. Only packages with names that * start with packagePrefix are returned.

*/ inline const Aws::String& GetPackagePrefix() const{ return m_packagePrefix; } /** *

A prefix used to filter requested packages. Only packages with names that * start with packagePrefix are returned.

*/ inline bool PackagePrefixHasBeenSet() const { return m_packagePrefixHasBeenSet; } /** *

A prefix used to filter requested packages. Only packages with names that * start with packagePrefix are returned.

*/ inline void SetPackagePrefix(const Aws::String& value) { m_packagePrefixHasBeenSet = true; m_packagePrefix = value; } /** *

A prefix used to filter requested packages. Only packages with names that * start with packagePrefix are returned.

*/ inline void SetPackagePrefix(Aws::String&& value) { m_packagePrefixHasBeenSet = true; m_packagePrefix = std::move(value); } /** *

A prefix used to filter requested packages. Only packages with names that * start with packagePrefix are returned.

*/ inline void SetPackagePrefix(const char* value) { m_packagePrefixHasBeenSet = true; m_packagePrefix.assign(value); } /** *

A prefix used to filter requested packages. Only packages with names that * start with packagePrefix are returned.

*/ inline ListPackagesRequest& WithPackagePrefix(const Aws::String& value) { SetPackagePrefix(value); return *this;} /** *

A prefix used to filter requested packages. Only packages with names that * start with packagePrefix are returned.

*/ inline ListPackagesRequest& WithPackagePrefix(Aws::String&& value) { SetPackagePrefix(std::move(value)); return *this;} /** *

A prefix used to filter requested packages. Only packages with names that * start with packagePrefix are returned.

*/ inline ListPackagesRequest& WithPackagePrefix(const char* value) { SetPackagePrefix(value); return *this;} /** *

The maximum number of results to return per page.

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

The maximum number of results to return per page.

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

The maximum number of results to return per page.

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

The maximum number of results to return per page.

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

The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of results.

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

The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of results.

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

The value of the Publish package origin control restriction used * to filter requested packages. Only packages with the provided restriction are * returned. For more information, see PackageOriginRestrictions.

*/ inline const AllowPublish& GetPublish() const{ return m_publish; } /** *

The value of the Publish package origin control restriction used * to filter requested packages. Only packages with the provided restriction are * returned. For more information, see PackageOriginRestrictions.

*/ inline bool PublishHasBeenSet() const { return m_publishHasBeenSet; } /** *

The value of the Publish package origin control restriction used * to filter requested packages. Only packages with the provided restriction are * returned. For more information, see PackageOriginRestrictions.

*/ inline void SetPublish(const AllowPublish& value) { m_publishHasBeenSet = true; m_publish = value; } /** *

The value of the Publish package origin control restriction used * to filter requested packages. Only packages with the provided restriction are * returned. For more information, see PackageOriginRestrictions.

*/ inline void SetPublish(AllowPublish&& value) { m_publishHasBeenSet = true; m_publish = std::move(value); } /** *

The value of the Publish package origin control restriction used * to filter requested packages. Only packages with the provided restriction are * returned. For more information, see PackageOriginRestrictions.

*/ inline ListPackagesRequest& WithPublish(const AllowPublish& value) { SetPublish(value); return *this;} /** *

The value of the Publish package origin control restriction used * to filter requested packages. Only packages with the provided restriction are * returned. For more information, see PackageOriginRestrictions.

*/ inline ListPackagesRequest& WithPublish(AllowPublish&& value) { SetPublish(std::move(value)); return *this;} /** *

The value of the Upstream package origin control restriction * used to filter requested packages. Only packages with the provided restriction * are returned. For more information, see PackageOriginRestrictions.

*/ inline const AllowUpstream& GetUpstream() const{ return m_upstream; } /** *

The value of the Upstream package origin control restriction * used to filter requested packages. Only packages with the provided restriction * are returned. For more information, see PackageOriginRestrictions.

*/ inline bool UpstreamHasBeenSet() const { return m_upstreamHasBeenSet; } /** *

The value of the Upstream package origin control restriction * used to filter requested packages. Only packages with the provided restriction * are returned. For more information, see PackageOriginRestrictions.

*/ inline void SetUpstream(const AllowUpstream& value) { m_upstreamHasBeenSet = true; m_upstream = value; } /** *

The value of the Upstream package origin control restriction * used to filter requested packages. Only packages with the provided restriction * are returned. For more information, see PackageOriginRestrictions.

*/ inline void SetUpstream(AllowUpstream&& value) { m_upstreamHasBeenSet = true; m_upstream = std::move(value); } /** *

The value of the Upstream package origin control restriction * used to filter requested packages. Only packages with the provided restriction * are returned. For more information, see PackageOriginRestrictions.

*/ inline ListPackagesRequest& WithUpstream(const AllowUpstream& value) { SetUpstream(value); return *this;} /** *

The value of the Upstream package origin control restriction * used to filter requested packages. Only packages with the provided restriction * are returned. For more information, see PackageOriginRestrictions.

*/ inline ListPackagesRequest& WithUpstream(AllowUpstream&& value) { SetUpstream(std::move(value)); return *this;} private: Aws::String m_domain; bool m_domainHasBeenSet = false; Aws::String m_domainOwner; bool m_domainOwnerHasBeenSet = false; Aws::String m_repository; bool m_repositoryHasBeenSet = false; PackageFormat m_format; bool m_formatHasBeenSet = false; Aws::String m_namespace; bool m_namespaceHasBeenSet = false; Aws::String m_packagePrefix; bool m_packagePrefixHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; AllowPublish m_publish; bool m_publishHasBeenSet = false; AllowUpstream m_upstream; bool m_upstreamHasBeenSet = false; }; } // namespace Model } // namespace CodeArtifact } // namespace Aws