/*
* 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 iotfleetwise-2021-06-17.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.IoTFleetWise.Model
{
///
/// Information about a campaign.
///
///
///
/// You can use the API operation to return this information about multiple created campaigns.
///
///
public partial class CampaignSummary
{
private string _arn;
private DateTime? _creationTime;
private string _description;
private DateTime? _lastModificationTime;
private string _name;
private string _signalCatalogArn;
private CampaignStatus _status;
private string _targetArn;
///
/// Gets and sets the property Arn.
///
/// The Amazon Resource Name (ARN) of a campaign.
///
///
public string Arn
{
get { return this._arn; }
set { this._arn = value; }
}
// Check to see if Arn property is set
internal bool IsSetArn()
{
return this._arn != null;
}
///
/// Gets and sets the property CreationTime.
///
/// The time the campaign was created.
///
///
[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.
///
/// The description of the campaign.
///
///
[AWSProperty(Min=1, Max=2048)]
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 LastModificationTime.
///
/// The last time the campaign was modified.
///
///
[AWSProperty(Required=true)]
public DateTime LastModificationTime
{
get { return this._lastModificationTime.GetValueOrDefault(); }
set { this._lastModificationTime = value; }
}
// Check to see if LastModificationTime property is set
internal bool IsSetLastModificationTime()
{
return this._lastModificationTime.HasValue;
}
///
/// Gets and sets the property Name.
///
/// The name of a campaign.
///
///
[AWSProperty(Min=1, Max=100)]
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;
}
///
/// Gets and sets the property SignalCatalogArn.
///
/// The ARN of the signal catalog associated with the campaign.
///
///
public string SignalCatalogArn
{
get { return this._signalCatalogArn; }
set { this._signalCatalogArn = value; }
}
// Check to see if SignalCatalogArn property is set
internal bool IsSetSignalCatalogArn()
{
return this._signalCatalogArn != null;
}
///
/// Gets and sets the property Status.
///
/// The state of a campaign. The status can be one of the following:
///
/// -
///
///
CREATING
- Amazon Web Services IoT FleetWise is processing your request
/// to create the campaign.
///
/// -
///
///
WAITING_FOR_APPROVAL
- After a campaign is created, it enters the WAITING_FOR_APPROVAL
/// state. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target
/// vehicle or fleet, use the API operation to approve the campaign.
///
/// -
///
///
RUNNING
- The campaign is active.
///
/// -
///
///
SUSPENDED
- The campaign is suspended. To resume the campaign, use the
/// API operation.
///
///
///
public CampaignStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
///
/// Gets and sets the property TargetArn.
///
/// The ARN of a vehicle or fleet to which the campaign is deployed.
///
///
public string TargetArn
{
get { return this._targetArn; }
set { this._targetArn = value; }
}
// Check to see if TargetArn property is set
internal bool IsSetTargetArn()
{
return this._targetArn != null;
}
}
}