/*
* 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
{
///
/// This is the response object from the DescribeFeatureGroup operation.
///
public partial class DescribeFeatureGroupResponse : AmazonWebServiceResponse
{
private DateTime? _creationTime;
private string _description;
private string _eventTimeFeatureName;
private string _failureReason;
private List _featureDefinitions = new List();
private string _featureGroupArn;
private string _featureGroupName;
private FeatureGroupStatus _featureGroupStatus;
private DateTime? _lastModifiedTime;
private LastUpdateStatus _lastUpdateStatus;
private string _nextToken;
private OfflineStoreConfig _offlineStoreConfig;
private OfflineStoreStatus _offlineStoreStatus;
private OnlineStoreConfig _onlineStoreConfig;
private long? _onlineStoreTotalSizeBytes;
private string _recordIdentifierFeatureName;
private string _roleArn;
///
/// Gets and sets the property CreationTime.
///
/// A timestamp indicating when SageMaker created the FeatureGroup
.
///
///
[AWSProperty(Required=true)]
public DateTime CreationTime
{
get { return this._creationTime.GetValueOrDefault(); }
set { this._creationTime = value; }
}
// Check to see if CreationTime property is set
internal bool IsSetCreationTime()
{
return this._creationTime.HasValue;
}
///
/// Gets and sets the property Description.
///
/// A free form description of the feature group.
///
///
[AWSProperty(Max=128)]
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 EventTimeFeatureName.
///
/// The name of the feature that stores the EventTime
of a Record in a FeatureGroup
.
///
///
///
/// An EventTime
is a point in time when a new event occurs that corresponds
/// to the creation or update of a Record
in a FeatureGroup
.
/// All Records
in the FeatureGroup
have a corresponding EventTime
.
///
///
[AWSProperty(Required=true, Min=1, Max=64)]
public string EventTimeFeatureName
{
get { return this._eventTimeFeatureName; }
set { this._eventTimeFeatureName = value; }
}
// Check to see if EventTimeFeatureName property is set
internal bool IsSetEventTimeFeatureName()
{
return this._eventTimeFeatureName != null;
}
///
/// Gets and sets the property FailureReason.
///
/// The reason that the FeatureGroup
failed to be replicated in the OfflineStore
.
/// This is failure can occur because:
///
/// -
///
/// The
FeatureGroup
could not be created in the OfflineStore
.
///
/// -
///
/// The
FeatureGroup
could not be deleted from the OfflineStore
.
///
///
///
[AWSProperty(Max=1024)]
public string FailureReason
{
get { return this._failureReason; }
set { this._failureReason = value; }
}
// Check to see if FailureReason property is set
internal bool IsSetFailureReason()
{
return this._failureReason != null;
}
///
/// Gets and sets the property FeatureDefinitions.
///
/// A list of the Features
in the FeatureGroup
. Each feature
/// is defined by a FeatureName
and FeatureType
.
///
///
[AWSProperty(Required=true, Min=1, Max=2500)]
public List FeatureDefinitions
{
get { return this._featureDefinitions; }
set { this._featureDefinitions = value; }
}
// Check to see if FeatureDefinitions property is set
internal bool IsSetFeatureDefinitions()
{
return this._featureDefinitions != null && this._featureDefinitions.Count > 0;
}
///
/// Gets and sets the property FeatureGroupArn.
///
/// The Amazon Resource Name (ARN) of the FeatureGroup
.
///
///
[AWSProperty(Required=true, Max=256)]
public string FeatureGroupArn
{
get { return this._featureGroupArn; }
set { this._featureGroupArn = value; }
}
// Check to see if FeatureGroupArn property is set
internal bool IsSetFeatureGroupArn()
{
return this._featureGroupArn != null;
}
///
/// Gets and sets the property FeatureGroupName.
///
/// he name of the FeatureGroup
.
///
///
[AWSProperty(Required=true, Min=1, Max=64)]
public string FeatureGroupName
{
get { return this._featureGroupName; }
set { this._featureGroupName = value; }
}
// Check to see if FeatureGroupName property is set
internal bool IsSetFeatureGroupName()
{
return this._featureGroupName != null;
}
///
/// Gets and sets the property FeatureGroupStatus.
///
/// The status of the feature group.
///
///
public FeatureGroupStatus FeatureGroupStatus
{
get { return this._featureGroupStatus; }
set { this._featureGroupStatus = value; }
}
// Check to see if FeatureGroupStatus property is set
internal bool IsSetFeatureGroupStatus()
{
return this._featureGroupStatus != null;
}
///
/// Gets and sets the property LastModifiedTime.
///
/// A timestamp indicating when the feature group was last updated.
///
///
public DateTime LastModifiedTime
{
get { return this._lastModifiedTime.GetValueOrDefault(); }
set { this._lastModifiedTime = value; }
}
// Check to see if LastModifiedTime property is set
internal bool IsSetLastModifiedTime()
{
return this._lastModifiedTime.HasValue;
}
///
/// Gets and sets the property LastUpdateStatus.
///
/// A value indicating whether the update made to the feature group was successful.
///
///
public LastUpdateStatus LastUpdateStatus
{
get { return this._lastUpdateStatus; }
set { this._lastUpdateStatus = value; }
}
// Check to see if LastUpdateStatus property is set
internal bool IsSetLastUpdateStatus()
{
return this._lastUpdateStatus != null;
}
///
/// Gets and sets the property NextToken.
///
/// A token to resume pagination of the list of Features
(FeatureDefinitions
).
///
///
[AWSProperty(Required=true, 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 OfflineStoreConfig.
///
/// The configuration of the offline store. It includes the following configurations:
///
/// -
///
/// Amazon S3 location of the offline store.
///
///
-
///
/// Configuration of the Glue data catalog.
///
///
-
///
/// Table format of the offline store.
///
///
-
///
/// Option to disable the automatic creation of a Glue table for the offline store.
///
///
-
///
/// Encryption configuration.
///
///
///
public OfflineStoreConfig OfflineStoreConfig
{
get { return this._offlineStoreConfig; }
set { this._offlineStoreConfig = value; }
}
// Check to see if OfflineStoreConfig property is set
internal bool IsSetOfflineStoreConfig()
{
return this._offlineStoreConfig != null;
}
///
/// Gets and sets the property OfflineStoreStatus.
///
/// The status of the OfflineStore
. Notifies you if replicating data into
/// the OfflineStore
has failed. Returns either: Active
or Blocked
///
///
///
public OfflineStoreStatus OfflineStoreStatus
{
get { return this._offlineStoreStatus; }
set { this._offlineStoreStatus = value; }
}
// Check to see if OfflineStoreStatus property is set
internal bool IsSetOfflineStoreStatus()
{
return this._offlineStoreStatus != null;
}
///
/// Gets and sets the property OnlineStoreConfig.
///
/// The configuration for the OnlineStore
.
///
///
public OnlineStoreConfig OnlineStoreConfig
{
get { return this._onlineStoreConfig; }
set { this._onlineStoreConfig = value; }
}
// Check to see if OnlineStoreConfig property is set
internal bool IsSetOnlineStoreConfig()
{
return this._onlineStoreConfig != null;
}
///
/// Gets and sets the property OnlineStoreTotalSizeBytes.
///
/// The size of the OnlineStore
in bytes.
///
///
public long OnlineStoreTotalSizeBytes
{
get { return this._onlineStoreTotalSizeBytes.GetValueOrDefault(); }
set { this._onlineStoreTotalSizeBytes = value; }
}
// Check to see if OnlineStoreTotalSizeBytes property is set
internal bool IsSetOnlineStoreTotalSizeBytes()
{
return this._onlineStoreTotalSizeBytes.HasValue;
}
///
/// Gets and sets the property RecordIdentifierFeatureName.
///
/// The name of the Feature
used for RecordIdentifier
, whose
/// value uniquely identifies a record stored in the feature store.
///
///
[AWSProperty(Required=true, Min=1, Max=64)]
public string RecordIdentifierFeatureName
{
get { return this._recordIdentifierFeatureName; }
set { this._recordIdentifierFeatureName = value; }
}
// Check to see if RecordIdentifierFeatureName property is set
internal bool IsSetRecordIdentifierFeatureName()
{
return this._recordIdentifierFeatureName != null;
}
///
/// Gets and sets the property RoleArn.
///
/// The Amazon Resource Name (ARN) of the IAM execution role used to persist data into
/// the OfflineStore if an OfflineStoreConfig is provided.
///
///
[AWSProperty(Min=20, Max=2048)]
public string RoleArn
{
get { return this._roleArn; }
set { this._roleArn = value; }
}
// Check to see if RoleArn property is set
internal bool IsSetRoleArn()
{
return this._roleArn != null;
}
}
}