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-apigateway/include/aws/apigateway/model/CreateDocumentationPartRequest.h

189 lines
7.3 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/apigateway/APIGateway_EXPORTS.h>
#include <aws/apigateway/APIGatewayRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/apigateway/model/DocumentationPartLocation.h>
#include <utility>
namespace Aws
{
namespace APIGateway
{
namespace Model
{
/**
* <p>Creates a new documentation part of a given API.</p><p><h3>See Also:</h3>
* <a
* href="http://docs.aws.amazon.com/goto/WebAPI/apigateway-2015-07-09/CreateDocumentationPartRequest">AWS
* API Reference</a></p>
*/
class AWS_APIGATEWAY_API CreateDocumentationPartRequest : public APIGatewayRequest
{
public:
CreateDocumentationPartRequest();
// 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 "CreateDocumentationPart"; }
Aws::String SerializePayload() const override;
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline const Aws::String& GetRestApiId() const{ return m_restApiId; }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline bool RestApiIdHasBeenSet() const { return m_restApiIdHasBeenSet; }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline void SetRestApiId(const Aws::String& value) { m_restApiIdHasBeenSet = true; m_restApiId = value; }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline void SetRestApiId(Aws::String&& value) { m_restApiIdHasBeenSet = true; m_restApiId = std::move(value); }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline void SetRestApiId(const char* value) { m_restApiIdHasBeenSet = true; m_restApiId.assign(value); }
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline CreateDocumentationPartRequest& WithRestApiId(const Aws::String& value) { SetRestApiId(value); return *this;}
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline CreateDocumentationPartRequest& WithRestApiId(Aws::String&& value) { SetRestApiId(std::move(value)); return *this;}
/**
* <p>[Required] The string identifier of the associated <a>RestApi</a>.</p>
*/
inline CreateDocumentationPartRequest& WithRestApiId(const char* value) { SetRestApiId(value); return *this;}
/**
* <p>[Required] The location of the targeted API entity of the to-be-created
* documentation part.</p>
*/
inline const DocumentationPartLocation& GetLocation() const{ return m_location; }
/**
* <p>[Required] The location of the targeted API entity of the to-be-created
* documentation part.</p>
*/
inline bool LocationHasBeenSet() const { return m_locationHasBeenSet; }
/**
* <p>[Required] The location of the targeted API entity of the to-be-created
* documentation part.</p>
*/
inline void SetLocation(const DocumentationPartLocation& value) { m_locationHasBeenSet = true; m_location = value; }
/**
* <p>[Required] The location of the targeted API entity of the to-be-created
* documentation part.</p>
*/
inline void SetLocation(DocumentationPartLocation&& value) { m_locationHasBeenSet = true; m_location = std::move(value); }
/**
* <p>[Required] The location of the targeted API entity of the to-be-created
* documentation part.</p>
*/
inline CreateDocumentationPartRequest& WithLocation(const DocumentationPartLocation& value) { SetLocation(value); return *this;}
/**
* <p>[Required] The location of the targeted API entity of the to-be-created
* documentation part.</p>
*/
inline CreateDocumentationPartRequest& WithLocation(DocumentationPartLocation&& value) { SetLocation(std::move(value)); return *this;}
/**
* <p>[Required] The new documentation content map of the targeted API entity.
* Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value
* pairs can be exported and, hence, published.</p>
*/
inline const Aws::String& GetProperties() const{ return m_properties; }
/**
* <p>[Required] The new documentation content map of the targeted API entity.
* Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value
* pairs can be exported and, hence, published.</p>
*/
inline bool PropertiesHasBeenSet() const { return m_propertiesHasBeenSet; }
/**
* <p>[Required] The new documentation content map of the targeted API entity.
* Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value
* pairs can be exported and, hence, published.</p>
*/
inline void SetProperties(const Aws::String& value) { m_propertiesHasBeenSet = true; m_properties = value; }
/**
* <p>[Required] The new documentation content map of the targeted API entity.
* Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value
* pairs can be exported and, hence, published.</p>
*/
inline void SetProperties(Aws::String&& value) { m_propertiesHasBeenSet = true; m_properties = std::move(value); }
/**
* <p>[Required] The new documentation content map of the targeted API entity.
* Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value
* pairs can be exported and, hence, published.</p>
*/
inline void SetProperties(const char* value) { m_propertiesHasBeenSet = true; m_properties.assign(value); }
/**
* <p>[Required] The new documentation content map of the targeted API entity.
* Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value
* pairs can be exported and, hence, published.</p>
*/
inline CreateDocumentationPartRequest& WithProperties(const Aws::String& value) { SetProperties(value); return *this;}
/**
* <p>[Required] The new documentation content map of the targeted API entity.
* Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value
* pairs can be exported and, hence, published.</p>
*/
inline CreateDocumentationPartRequest& WithProperties(Aws::String&& value) { SetProperties(std::move(value)); return *this;}
/**
* <p>[Required] The new documentation content map of the targeted API entity.
* Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value
* pairs can be exported and, hence, published.</p>
*/
inline CreateDocumentationPartRequest& WithProperties(const char* value) { SetProperties(value); return *this;}
private:
Aws::String m_restApiId;
bool m_restApiIdHasBeenSet;
DocumentationPartLocation m_location;
bool m_locationHasBeenSet;
Aws::String m_properties;
bool m_propertiesHasBeenSet;
};
} // namespace Model
} // namespace APIGateway
} // namespace Aws