This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-ssm/include/aws/ssm/model/DescribeDocumentRequest.h

198 lines
7.4 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/ssm/SSM_EXPORTS.h>
#include <aws/ssm/SSMRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace SSM
{
namespace Model
{
/**
*/
class AWS_SSM_API DescribeDocumentRequest : public SSMRequest
{
public:
DescribeDocumentRequest();
// 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 "DescribeDocument"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The name of the Systems Manager document.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name of the Systems Manager document.</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>The name of the Systems Manager document.</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>The name of the Systems Manager document.</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>The name of the Systems Manager document.</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>The name of the Systems Manager document.</p>
*/
inline DescribeDocumentRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name of the Systems Manager document.</p>
*/
inline DescribeDocumentRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name of the Systems Manager document.</p>
*/
inline DescribeDocumentRequest& WithName(const char* value) { SetName(value); return *this;}
/**
* <p>The document version for which you want information. Can be a specific
* version or the default version.</p>
*/
inline const Aws::String& GetDocumentVersion() const{ return m_documentVersion; }
/**
* <p>The document version for which you want information. Can be a specific
* version or the default version.</p>
*/
inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; }
/**
* <p>The document version for which you want information. Can be a specific
* version or the default version.</p>
*/
inline void SetDocumentVersion(const Aws::String& value) { m_documentVersionHasBeenSet = true; m_documentVersion = value; }
/**
* <p>The document version for which you want information. Can be a specific
* version or the default version.</p>
*/
inline void SetDocumentVersion(Aws::String&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::move(value); }
/**
* <p>The document version for which you want information. Can be a specific
* version or the default version.</p>
*/
inline void SetDocumentVersion(const char* value) { m_documentVersionHasBeenSet = true; m_documentVersion.assign(value); }
/**
* <p>The document version for which you want information. Can be a specific
* version or the default version.</p>
*/
inline DescribeDocumentRequest& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;}
/**
* <p>The document version for which you want information. Can be a specific
* version or the default version.</p>
*/
inline DescribeDocumentRequest& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;}
/**
* <p>The document version for which you want information. Can be a specific
* version or the default version.</p>
*/
inline DescribeDocumentRequest& WithDocumentVersion(const char* value) { SetDocumentVersion(value); return *this;}
/**
* <p>An optional field specifying the version of the artifact associated with the
* document. For example, "Release 12, Update 6". This value is unique across all
* versions of a document, and cannot be changed.</p>
*/
inline const Aws::String& GetVersionName() const{ return m_versionName; }
/**
* <p>An optional field specifying the version of the artifact associated with the
* document. For example, "Release 12, Update 6". This value is unique across all
* versions of a document, and cannot be changed.</p>
*/
inline bool VersionNameHasBeenSet() const { return m_versionNameHasBeenSet; }
/**
* <p>An optional field specifying the version of the artifact associated with the
* document. For example, "Release 12, Update 6". This value is unique across all
* versions of a document, and cannot be changed.</p>
*/
inline void SetVersionName(const Aws::String& value) { m_versionNameHasBeenSet = true; m_versionName = value; }
/**
* <p>An optional field specifying the version of the artifact associated with the
* document. For example, "Release 12, Update 6". This value is unique across all
* versions of a document, and cannot be changed.</p>
*/
inline void SetVersionName(Aws::String&& value) { m_versionNameHasBeenSet = true; m_versionName = std::move(value); }
/**
* <p>An optional field specifying the version of the artifact associated with the
* document. For example, "Release 12, Update 6". This value is unique across all
* versions of a document, and cannot be changed.</p>
*/
inline void SetVersionName(const char* value) { m_versionNameHasBeenSet = true; m_versionName.assign(value); }
/**
* <p>An optional field specifying the version of the artifact associated with the
* document. For example, "Release 12, Update 6". This value is unique across all
* versions of a document, and cannot be changed.</p>
*/
inline DescribeDocumentRequest& WithVersionName(const Aws::String& value) { SetVersionName(value); return *this;}
/**
* <p>An optional field specifying the version of the artifact associated with the
* document. For example, "Release 12, Update 6". This value is unique across all
* versions of a document, and cannot be changed.</p>
*/
inline DescribeDocumentRequest& WithVersionName(Aws::String&& value) { SetVersionName(std::move(value)); return *this;}
/**
* <p>An optional field specifying the version of the artifact associated with the
* document. For example, "Release 12, Update 6". This value is unique across all
* versions of a document, and cannot be changed.</p>
*/
inline DescribeDocumentRequest& WithVersionName(const char* value) { SetVersionName(value); return *this;}
private:
Aws::String m_name;
bool m_nameHasBeenSet;
Aws::String m_documentVersion;
bool m_documentVersionHasBeenSet;
Aws::String m_versionName;
bool m_versionNameHasBeenSet;
};
} // namespace Model
} // namespace SSM
} // namespace Aws