/*
 * 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
{
    /// <summary>
    /// Specifies the target API entity to which the documentation applies.
    /// </summary>
    public partial class DocumentationPartLocation
    {
        private string _method;
        private string _name;
        private string _path;
        private string _statusCode;
        private DocumentationPartType _type;

        /// <summary>
        /// Gets and sets the property Method. 
        /// <para>
        /// The HTTP verb of a method. It is a valid field for the API entity types of <code>METHOD</code>,
        /// <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>,
        /// <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and
        /// <code>RESPONSE_BODY</code>. The default value is <code>*</code> for any method. When
        /// an applicable child entity inherits the content of an entity of the same type with
        /// more general specifications of the other <code>location</code> attributes, the child
        /// entity's <code>method</code> attribute must match that of the parent entity exactly.
        /// </para>
        /// </summary>
        public string Method
        {
            get { return this._method; }
            set { this._method = value; }
        }

        // Check to see if Method property is set
        internal bool IsSetMethod()
        {
            return this._method != null;
        }

        /// <summary>
        /// Gets and sets the property Name. 
        /// <para>
        /// The name of the targeted API entity. It is a valid and required field for the API
        /// entity types of <code>AUTHORIZER</code>, <code>MODEL</code>, <code>PATH_PARAMETER</code>,
        /// <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>
        /// and <code>RESPONSE_HEADER</code>. It is an invalid field for any other entity type.
        /// </para>
        /// </summary>
        public string Name
        {
            get { return this._name; }
            set { this._name = value; }
        }

        // Check to see if Name property is set
        internal bool IsSetName()
        {
            return this._name != null;
        }

        /// <summary>
        /// Gets and sets the property Path. 
        /// <para>
        /// The URL path of the target. It is a valid field for the API entity types of <code>RESOURCE</code>,
        /// <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>,
        /// <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and
        /// <code>RESPONSE_BODY</code>. The default value is <code>/</code> for the root resource.
        /// When an applicable child entity inherits the content of another entity of the same
        /// type with more general specifications of the other <code>location</code> attributes,
        /// the child entity's <code>path</code> attribute must match that of the parent entity
        /// as a prefix.
        /// </para>
        /// </summary>
        public string Path
        {
            get { return this._path; }
            set { this._path = value; }
        }

        // Check to see if Path property is set
        internal bool IsSetPath()
        {
            return this._path != null;
        }

        /// <summary>
        /// Gets and sets the property StatusCode. 
        /// <para>
        /// The HTTP status code of a response. It is a valid field for the API entity types of
        /// <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>.
        /// The default value is <code>*</code> for any status code. When an applicable child
        /// entity inherits the content of an entity of the same type with more general specifications
        /// of the other <code>location</code> attributes, the child entity's <code>statusCode</code>
        /// attribute must match that of the parent entity exactly.
        /// </para>
        /// </summary>
        public string StatusCode
        {
            get { return this._statusCode; }
            set { this._statusCode = value; }
        }

        // Check to see if StatusCode property is set
        internal bool IsSetStatusCode()
        {
            return this._statusCode != null;
        }

        /// <summary>
        /// Gets and sets the property Type. 
        /// <para>
        /// The type of API entity to which the documentation content applies. Valid values are
        /// <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>,
        /// <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>,
        /// <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and
        /// <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the
        /// <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>,
        /// <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public DocumentationPartType Type
        {
            get { return this._type; }
            set { this._type = value; }
        }

        // Check to see if Type property is set
        internal bool IsSetType()
        {
            return this._type != null;
        }

    }
}