/*
* 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 sagemaker-2017-07-24.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.SageMaker.Model
{
///
/// Container for the parameters to the ListTrials operation.
/// Lists the trials in your account. Specify an experiment name to limit the list to
/// the trials that are part of that experiment. Specify a trial component name to limit
/// the list to the trials that associated with that trial component. The list can be
/// filtered to show only trials that were created in a specific time range. The list
/// can be sorted by trial name or creation time.
///
public partial class ListTrialsRequest : AmazonSageMakerRequest
{
private DateTime? _createdAfter;
private DateTime? _createdBefore;
private string _experimentName;
private int? _maxResults;
private string _nextToken;
private SortTrialsBy _sortBy;
private SortOrder _sortOrder;
private string _trialComponentName;
///
/// Gets and sets the property CreatedAfter.
///
/// A filter that returns only trials created after the specified time.
///
///
public DateTime CreatedAfter
{
get { return this._createdAfter.GetValueOrDefault(); }
set { this._createdAfter = value; }
}
// Check to see if CreatedAfter property is set
internal bool IsSetCreatedAfter()
{
return this._createdAfter.HasValue;
}
///
/// Gets and sets the property CreatedBefore.
///
/// A filter that returns only trials created before the specified time.
///
///
public DateTime CreatedBefore
{
get { return this._createdBefore.GetValueOrDefault(); }
set { this._createdBefore = value; }
}
// Check to see if CreatedBefore property is set
internal bool IsSetCreatedBefore()
{
return this._createdBefore.HasValue;
}
///
/// Gets and sets the property ExperimentName.
///
/// A filter that returns only trials that are part of the specified experiment.
///
///
[AWSProperty(Min=1, Max=120)]
public string ExperimentName
{
get { return this._experimentName; }
set { this._experimentName = value; }
}
// Check to see if ExperimentName property is set
internal bool IsSetExperimentName()
{
return this._experimentName != null;
}
///
/// Gets and sets the property MaxResults.
///
/// The maximum number of trials to return in the response. The default value is 10.
///
///
[AWSProperty(Min=1, Max=100)]
public int MaxResults
{
get { return this._maxResults.GetValueOrDefault(); }
set { this._maxResults = value; }
}
// Check to see if MaxResults property is set
internal bool IsSetMaxResults()
{
return this._maxResults.HasValue;
}
///
/// Gets and sets the property NextToken.
///
/// If the previous call to ListTrials
didn't return the full set of trials,
/// the call returns a token for getting the next set of trials.
///
///
[AWSProperty(Max=8192)]
public string NextToken
{
get { return this._nextToken; }
set { this._nextToken = value; }
}
// Check to see if NextToken property is set
internal bool IsSetNextToken()
{
return this._nextToken != null;
}
///
/// Gets and sets the property SortBy.
///
/// The property used to sort results. The default value is CreationTime
.
///
///
public SortTrialsBy SortBy
{
get { return this._sortBy; }
set { this._sortBy = value; }
}
// Check to see if SortBy property is set
internal bool IsSetSortBy()
{
return this._sortBy != null;
}
///
/// Gets and sets the property SortOrder.
///
/// The sort order. The default value is Descending
.
///
///
public SortOrder SortOrder
{
get { return this._sortOrder; }
set { this._sortOrder = value; }
}
// Check to see if SortOrder property is set
internal bool IsSetSortOrder()
{
return this._sortOrder != null;
}
///
/// Gets and sets the property TrialComponentName.
///
/// A filter that returns only trials that are associated with the specified trial component.
///
///
[AWSProperty(Min=1, Max=120)]
public string TrialComponentName
{
get { return this._trialComponentName; }
set { this._trialComponentName = value; }
}
// Check to see if TrialComponentName property is set
internal bool IsSetTrialComponentName()
{
return this._trialComponentName != null;
}
}
}