/* * 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 { /// /// This is the response object from the GetCampaign operation. /// public partial class GetCampaignResponse : AmazonWebServiceResponse { private string _arn; private CollectionScheme _collectionScheme; private Compression _compression; private DateTime? _creationTime; private List _dataDestinationConfigs = new List(); private List _dataExtraDimensions = new List(); private string _description; private DiagnosticsMode _diagnosticsMode; private DateTime? _expiryTime; private DateTime? _lastModificationTime; private string _name; private long? _postTriggerCollectionDuration; private int? _priority; private string _signalCatalogArn; private List _signalsToCollect = new List(); private SpoolingMode _spoolingMode; private DateTime? _startTime; private CampaignStatus _status; private string _targetArn; /// /// Gets and sets the property Arn. /// /// The Amazon Resource Name (ARN) of the 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 CollectionScheme. /// /// Information about the data collection scheme associated with the campaign. /// /// public CollectionScheme CollectionScheme { get { return this._collectionScheme; } set { this._collectionScheme = value; } } // Check to see if CollectionScheme property is set internal bool IsSetCollectionScheme() { return this._collectionScheme != null; } /// /// Gets and sets the property Compression. /// /// Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. /// If OFF is specified, the signals aren't compressed. If it's not specified, /// SNAPPY is used. /// /// public Compression Compression { get { return this._compression; } set { this._compression = value; } } // Check to see if Compression property is set internal bool IsSetCompression() { return this._compression != null; } /// /// Gets and sets the property CreationTime. /// /// The time the campaign was created in seconds since epoch (January 1, 1970 at midnight /// UTC time). /// /// 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 DataDestinationConfigs. /// /// The destination where the campaign sends data. You can choose to send data to be stored /// in Amazon S3 or Amazon Timestream. /// /// /// /// Amazon S3 optimizes the cost of data storage and provides additional mechanisms to /// use vehicle data, such as data lakes, centralized data storage, data processing pipelines, /// and analytics. /// /// /// /// You can use Amazon Timestream to access and analyze time series data, and Timestream /// to query vehicle data so that you can identify trends and patterns. /// /// [AWSProperty(Min=1, Max=1)] public List DataDestinationConfigs { get { return this._dataDestinationConfigs; } set { this._dataDestinationConfigs = value; } } // Check to see if DataDestinationConfigs property is set internal bool IsSetDataDestinationConfigs() { return this._dataDestinationConfigs != null && this._dataDestinationConfigs.Count > 0; } /// /// Gets and sets the property DataExtraDimensions. /// /// A list of vehicle attributes associated with the campaign. /// /// [AWSProperty(Min=0, Max=5)] public List DataExtraDimensions { get { return this._dataExtraDimensions; } set { this._dataExtraDimensions = value; } } // Check to see if DataExtraDimensions property is set internal bool IsSetDataExtraDimensions() { return this._dataExtraDimensions != null && this._dataExtraDimensions.Count > 0; } /// /// 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 DiagnosticsMode. /// /// Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT /// FleetWise. /// /// public DiagnosticsMode DiagnosticsMode { get { return this._diagnosticsMode; } set { this._diagnosticsMode = value; } } // Check to see if DiagnosticsMode property is set internal bool IsSetDiagnosticsMode() { return this._diagnosticsMode != null; } /// /// Gets and sets the property ExpiryTime. /// /// The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight /// UTC time). Vehicle data won't be collected after the campaign expires. /// /// public DateTime ExpiryTime { get { return this._expiryTime.GetValueOrDefault(); } set { this._expiryTime = value; } } // Check to see if ExpiryTime property is set internal bool IsSetExpiryTime() { return this._expiryTime.HasValue; } /// /// Gets and sets the property LastModificationTime. /// /// The last time the campaign was modified. /// /// 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 the 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 PostTriggerCollectionDuration. /// /// How long (in seconds) to collect raw data after a triggering event initiates the /// collection. /// /// [AWSProperty(Min=0, Max=4294967295)] public long PostTriggerCollectionDuration { get { return this._postTriggerCollectionDuration.GetValueOrDefault(); } set { this._postTriggerCollectionDuration = value; } } // Check to see if PostTriggerCollectionDuration property is set internal bool IsSetPostTriggerCollectionDuration() { return this._postTriggerCollectionDuration.HasValue; } /// /// Gets and sets the property Priority. /// /// A number indicating the priority of one campaign over another campaign for a certain /// vehicle or fleet. A campaign with the lowest value is deployed to vehicles before /// any other campaigns. /// /// [AWSProperty(Min=0)] public int Priority { get { return this._priority.GetValueOrDefault(); } set { this._priority = value; } } // Check to see if Priority property is set internal bool IsSetPriority() { return this._priority.HasValue; } /// /// Gets and sets the property SignalCatalogArn. /// /// The ARN of a signal catalog. /// /// 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 SignalsToCollect. /// /// Information about a list of signals to collect data on. /// /// [AWSProperty(Min=0, Max=1000)] public List SignalsToCollect { get { return this._signalsToCollect; } set { this._signalsToCollect = value; } } // Check to see if SignalsToCollect property is set internal bool IsSetSignalsToCollect() { return this._signalsToCollect != null && this._signalsToCollect.Count > 0; } /// /// Gets and sets the property SpoolingMode. /// /// Whether to store collected data after a vehicle lost a connection with the cloud. /// After a connection is re-established, the data is automatically forwarded to Amazon /// Web Services IoT FleetWise. /// /// public SpoolingMode SpoolingMode { get { return this._spoolingMode; } set { this._spoolingMode = value; } } // Check to see if SpoolingMode property is set internal bool IsSetSpoolingMode() { return this._spoolingMode != null; } /// /// Gets and sets the property StartTime. /// /// The time, in milliseconds, to deliver a campaign after it was approved. /// /// public DateTime StartTime { get { return this._startTime.GetValueOrDefault(); } set { this._startTime = value; } } // Check to see if StartTime property is set internal bool IsSetStartTime() { return this._startTime.HasValue; } /// /// Gets and sets the property Status. /// /// The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, /// RUNNING, and SUSPENDED. /// /// 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 the vehicle or the fleet targeted by the campaign. /// /// 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; } } }