/*
* 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 iot-2015-05-28.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.IoT.Model
{
///
/// Container for the parameters to the UpdateJob operation.
/// Updates supported fields of the specified job.
///
///
///
/// Requires permission to access the UpdateJob
/// action.
///
///
public partial class UpdateJobRequest : AmazonIoTRequest
{
private AbortConfig _abortConfig;
private string _description;
private JobExecutionsRetryConfig _jobExecutionsRetryConfig;
private JobExecutionsRolloutConfig _jobExecutionsRolloutConfig;
private string _jobId;
private string _namespaceId;
private PresignedUrlConfig _presignedUrlConfig;
private TimeoutConfig _timeoutConfig;
///
/// Gets and sets the property AbortConfig.
///
/// Allows you to create criteria to abort a job.
///
///
public AbortConfig AbortConfig
{
get { return this._abortConfig; }
set { this._abortConfig = value; }
}
// Check to see if AbortConfig property is set
internal bool IsSetAbortConfig()
{
return this._abortConfig != null;
}
///
/// Gets and sets the property Description.
///
/// A short text description of the job.
///
///
[AWSProperty(Max=2028)]
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 JobExecutionsRetryConfig.
///
/// Allows you to create the criteria to retry a job.
///
///
public JobExecutionsRetryConfig JobExecutionsRetryConfig
{
get { return this._jobExecutionsRetryConfig; }
set { this._jobExecutionsRetryConfig = value; }
}
// Check to see if JobExecutionsRetryConfig property is set
internal bool IsSetJobExecutionsRetryConfig()
{
return this._jobExecutionsRetryConfig != null;
}
///
/// Gets and sets the property JobExecutionsRolloutConfig.
///
/// Allows you to create a staged rollout of the job.
///
///
public JobExecutionsRolloutConfig JobExecutionsRolloutConfig
{
get { return this._jobExecutionsRolloutConfig; }
set { this._jobExecutionsRolloutConfig = value; }
}
// Check to see if JobExecutionsRolloutConfig property is set
internal bool IsSetJobExecutionsRolloutConfig()
{
return this._jobExecutionsRolloutConfig != null;
}
///
/// Gets and sets the property JobId.
///
/// The ID of the job to be updated.
///
///
[AWSProperty(Required=true, Min=1, Max=64)]
public string JobId
{
get { return this._jobId; }
set { this._jobId = value; }
}
// Check to see if JobId property is set
internal bool IsSetJobId()
{
return this._jobId != null;
}
///
/// Gets and sets the property NamespaceId.
///
/// The namespace used to indicate that a job is a customer-managed job.
///
///
///
/// When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs
/// notifications to MQTT topics that contain the value in the following format.
///
///
///
/// $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/
///
///
///
///
/// The namespaceId
feature is in public preview.
///
///
///
public string NamespaceId
{
get { return this._namespaceId; }
set { this._namespaceId = value; }
}
// Check to see if NamespaceId property is set
internal bool IsSetNamespaceId()
{
return this._namespaceId != null;
}
///
/// Gets and sets the property PresignedUrlConfig.
///
/// Configuration information for pre-signed S3 URLs.
///
///
public PresignedUrlConfig PresignedUrlConfig
{
get { return this._presignedUrlConfig; }
set { this._presignedUrlConfig = value; }
}
// Check to see if PresignedUrlConfig property is set
internal bool IsSetPresignedUrlConfig()
{
return this._presignedUrlConfig != null;
}
///
/// Gets and sets the property TimeoutConfig.
///
/// Specifies the amount of time each device has to finish its execution of the job. The
/// timer is started when the job execution status is set to IN_PROGRESS
.
/// If the job execution status is not set to another terminal state before the time expires,
/// it will be automatically set to TIMED_OUT
.
///
///
public TimeoutConfig TimeoutConfig
{
get { return this._timeoutConfig; }
set { this._timeoutConfig = value; }
}
// Check to see if TimeoutConfig property is set
internal bool IsSetTimeoutConfig()
{
return this._timeoutConfig != null;
}
}
}