/* * 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 ListTrainingJobs operation. /// Lists training jobs. /// /// /// /// When StatusEquals and MaxResults are set at the same time, /// the MaxResults number of training jobs are first retrieved ignoring the /// StatusEquals parameter and then they are filtered by the StatusEquals /// parameter, which is returned as a response. /// /// /// /// For example, if ListTrainingJobs is invoked with the following parameters: /// /// /// /// { ... MaxResults: 100, StatusEquals: InProgress ... } /// /// /// /// First, 100 trainings jobs with any status, including those other than InProgress, /// are selected (sorted according to the creation time, from the most current to the /// oldest). Next, those with a status of InProgress are returned. /// /// /// /// You can quickly test the API using the following Amazon Web Services CLI code. /// /// /// /// aws sagemaker list-training-jobs --max-results 100 --status-equals InProgress /// /// /// /// public partial class ListTrainingJobsRequest : AmazonSageMakerRequest { private DateTime? _creationTimeAfter; private DateTime? _creationTimeBefore; private DateTime? _lastModifiedTimeAfter; private DateTime? _lastModifiedTimeBefore; private int? _maxResults; private string _nameContains; private string _nextToken; private SortBy _sortBy; private SortOrder _sortOrder; private TrainingJobStatus _statusEquals; private WarmPoolResourceStatus _warmPoolStatusEquals; /// /// Gets and sets the property CreationTimeAfter. /// /// A filter that returns only training jobs created after the specified time (timestamp). /// /// public DateTime CreationTimeAfter { get { return this._creationTimeAfter.GetValueOrDefault(); } set { this._creationTimeAfter = value; } } // Check to see if CreationTimeAfter property is set internal bool IsSetCreationTimeAfter() { return this._creationTimeAfter.HasValue; } /// /// Gets and sets the property CreationTimeBefore. /// /// A filter that returns only training jobs created before the specified time (timestamp). /// /// public DateTime CreationTimeBefore { get { return this._creationTimeBefore.GetValueOrDefault(); } set { this._creationTimeBefore = value; } } // Check to see if CreationTimeBefore property is set internal bool IsSetCreationTimeBefore() { return this._creationTimeBefore.HasValue; } /// /// Gets and sets the property LastModifiedTimeAfter. /// /// A filter that returns only training jobs modified after the specified time (timestamp). /// /// public DateTime LastModifiedTimeAfter { get { return this._lastModifiedTimeAfter.GetValueOrDefault(); } set { this._lastModifiedTimeAfter = value; } } // Check to see if LastModifiedTimeAfter property is set internal bool IsSetLastModifiedTimeAfter() { return this._lastModifiedTimeAfter.HasValue; } /// /// Gets and sets the property LastModifiedTimeBefore. /// /// A filter that returns only training jobs modified before the specified time (timestamp). /// /// public DateTime LastModifiedTimeBefore { get { return this._lastModifiedTimeBefore.GetValueOrDefault(); } set { this._lastModifiedTimeBefore = value; } } // Check to see if LastModifiedTimeBefore property is set internal bool IsSetLastModifiedTimeBefore() { return this._lastModifiedTimeBefore.HasValue; } /// /// Gets and sets the property MaxResults. /// /// The maximum number of training jobs to return in the response. /// /// [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 NameContains. /// /// A string in the training job name. This filter returns only training jobs whose name /// contains the specified string. /// /// [AWSProperty(Max=63)] public string NameContains { get { return this._nameContains; } set { this._nameContains = value; } } // Check to see if NameContains property is set internal bool IsSetNameContains() { return this._nameContains != null; } /// /// Gets and sets the property NextToken. /// /// If the result of the previous ListTrainingJobs request was truncated, /// the response includes a NextToken. To retrieve the next set of training /// jobs, use the token in the next request. /// /// [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 field to sort results by. The default is CreationTime. /// /// public SortBy 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 for results. The default is Ascending. /// /// 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 StatusEquals. /// /// A filter that retrieves only training jobs with a specific status. /// /// public TrainingJobStatus StatusEquals { get { return this._statusEquals; } set { this._statusEquals = value; } } // Check to see if StatusEquals property is set internal bool IsSetStatusEquals() { return this._statusEquals != null; } /// /// Gets and sets the property WarmPoolStatusEquals. /// /// A filter that retrieves only training jobs with a specific warm pool status. /// /// public WarmPoolResourceStatus WarmPoolStatusEquals { get { return this._warmPoolStatusEquals; } set { this._warmPoolStatusEquals = value; } } // Check to see if WarmPoolStatusEquals property is set internal bool IsSetWarmPoolStatusEquals() { return this._warmPoolStatusEquals != null; } } }