/*
* 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 codeguru-reviewer-2019-09-19.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.CodeGuruReviewer.Model
{
///
/// Information about recommendations.
///
public partial class RecommendationSummary
{
private string _description;
private int? _endLine;
private string _filePath;
private RecommendationCategory _recommendationCategory;
private string _recommendationId;
private RuleMetadata _ruleMetadata;
private Severity _severity;
private int? _startLine;
///
/// Gets and sets the property Description.
///
/// A description of the recommendation generated by CodeGuru Reviewer for the lines of
/// code between the start line and the end line.
///
///
[AWSProperty(Min=1, Max=5000)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
///
/// Gets and sets the property EndLine.
///
/// Last line where the recommendation is applicable in the source commit or source branch.
/// For a single line comment the start line and end line values are the same.
///
///
public int EndLine
{
get { return this._endLine.GetValueOrDefault(); }
set { this._endLine = value; }
}
// Check to see if EndLine property is set
internal bool IsSetEndLine()
{
return this._endLine.HasValue;
}
///
/// Gets and sets the property FilePath.
///
/// Name of the file on which a recommendation is provided.
///
///
[AWSProperty(Min=1, Max=1024)]
public string FilePath
{
get { return this._filePath; }
set { this._filePath = value; }
}
// Check to see if FilePath property is set
internal bool IsSetFilePath()
{
return this._filePath != null;
}
///
/// Gets and sets the property RecommendationCategory.
///
/// The type of a recommendation.
///
///
public RecommendationCategory RecommendationCategory
{
get { return this._recommendationCategory; }
set { this._recommendationCategory = value; }
}
// Check to see if RecommendationCategory property is set
internal bool IsSetRecommendationCategory()
{
return this._recommendationCategory != null;
}
///
/// Gets and sets the property RecommendationId.
///
/// The recommendation ID that can be used to track the provided recommendations. Later
/// on it can be used to collect the feedback.
///
///
[AWSProperty(Min=1, Max=64)]
public string RecommendationId
{
get { return this._recommendationId; }
set { this._recommendationId = value; }
}
// Check to see if RecommendationId property is set
internal bool IsSetRecommendationId()
{
return this._recommendationId != null;
}
///
/// Gets and sets the property RuleMetadata.
///
/// Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a
/// short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's
/// recommendation is included in analysis results if code is detected that violates the
/// rule.
///
///
public RuleMetadata RuleMetadata
{
get { return this._ruleMetadata; }
set { this._ruleMetadata = value; }
}
// Check to see if RuleMetadata property is set
internal bool IsSetRuleMetadata()
{
return this._ruleMetadata != null;
}
///
/// Gets and sets the property Severity.
///
/// The severity of the issue in the code that generated this recommendation.
///
///
public Severity Severity
{
get { return this._severity; }
set { this._severity = value; }
}
// Check to see if Severity property is set
internal bool IsSetSeverity()
{
return this._severity != null;
}
///
/// Gets and sets the property StartLine.
///
/// Start line from where the recommendation is applicable in the source commit or source
/// branch.
///
///
public int StartLine
{
get { return this._startLine.GetValueOrDefault(); }
set { this._startLine = value; }
}
// Check to see if StartLine property is set
internal bool IsSetStartLine()
{
return this._startLine.HasValue;
}
}
}