/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the apigateway-2015-07-09.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.APIGateway.Model
{
///
/// Container for the parameters to the ImportRestApi operation.
/// A feature of the API Gateway control service for creating a new API from an external
/// API definition file.
///
public partial class ImportRestApiRequest : AmazonAPIGatewayRequest
{
private MemoryStream _body;
private bool? _failOnWarnings;
private Dictionary _parameters = new Dictionary();
///
/// Gets and sets the property Body.
///
/// The POST request body containing external API definitions. Currently, only OpenAPI
/// definition JSON/YAML files are supported. The maximum size of the API definition file
/// is 6MB.
///
///
[AWSProperty(Required=true)]
public MemoryStream Body
{
get { return this._body; }
set { this._body = value; }
}
// Check to see if Body property is set
internal bool IsSetBody()
{
return this._body != null;
}
///
/// Gets and sets the property FailOnWarnings.
///
/// A query parameter to indicate whether to rollback the API creation (true
)
/// or not (false
) when a warning is encountered. The default value is false
.
///
///
public bool FailOnWarnings
{
get { return this._failOnWarnings.GetValueOrDefault(); }
set { this._failOnWarnings = value; }
}
// Check to see if FailOnWarnings property is set
internal bool IsSetFailOnWarnings()
{
return this._failOnWarnings.HasValue;
}
///
/// Gets and sets the property Parameters.
///
/// A key-value map of context-specific query string parameters specifying the behavior
/// of different API importing operations. The following shows operation-specific parameters
/// and their supported values.
///
///
///
/// To exclude DocumentationParts from the import, set parameters
as ignore=documentation
.
///
///
///
/// To configure the endpoint type, set parameters
as endpointConfigurationTypes=EDGE
,
/// endpointConfigurationTypes=REGIONAL
, or endpointConfigurationTypes=PRIVATE
.
/// The default endpoint type is EDGE
.
///
///
///
/// To handle imported basepath
, set parameters
as basepath=ignore
,
/// basepath=prepend
or basepath=split
.
///
///
///
/// For example, the AWS CLI command to exclude documentation from the imported API is:
///
///
///
/// The AWS CLI command to set the regional endpoint on the imported API is:
///
///
public Dictionary Parameters
{
get { return this._parameters; }
set { this._parameters = value; }
}
// Check to see if Parameters property is set
internal bool IsSetParameters()
{
return this._parameters != null && this._parameters.Count > 0;
}
}
}