This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-mediaconvert/include/aws/mediaconvert/model/CreateJobTemplateRequest.h

560 lines
24 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/mediaconvert/MediaConvert_EXPORTS.h>
#include <aws/mediaconvert/MediaConvertRequest.h>
#include <aws/mediaconvert/model/AccelerationSettings.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/mediaconvert/model/JobTemplateSettings.h>
#include <aws/mediaconvert/model/StatusUpdateInterval.h>
#include <aws/core/utils/memory/stl/AWSMap.h>
#include <aws/mediaconvert/model/HopDestination.h>
#include <utility>
namespace Aws
{
namespace MediaConvert
{
namespace Model
{
/**
*/
class AWS_MEDIACONVERT_API CreateJobTemplateRequest : public MediaConvertRequest
{
public:
CreateJobTemplateRequest();
// Service request name is the Operation name which will send this request out,
// each operation should has unique request name, so that we can get operation's name from this request.
// Note: this is not true for response, multiple operations may have the same response name,
// so we can not get operation's name from response.
inline virtual const char* GetServiceRequestName() const override { return "CreateJobTemplate"; }
Aws::String SerializePayload() const override;
/**
* Accelerated transcoding can significantly speed up jobs with long, visually
* complex content. Outputs that use this feature incur pro-tier pricing. For
* information about feature limitations, see the AWS Elemental MediaConvert User
* Guide.
*/
inline const AccelerationSettings& GetAccelerationSettings() const{ return m_accelerationSettings; }
/**
* Accelerated transcoding can significantly speed up jobs with long, visually
* complex content. Outputs that use this feature incur pro-tier pricing. For
* information about feature limitations, see the AWS Elemental MediaConvert User
* Guide.
*/
inline bool AccelerationSettingsHasBeenSet() const { return m_accelerationSettingsHasBeenSet; }
/**
* Accelerated transcoding can significantly speed up jobs with long, visually
* complex content. Outputs that use this feature incur pro-tier pricing. For
* information about feature limitations, see the AWS Elemental MediaConvert User
* Guide.
*/
inline void SetAccelerationSettings(const AccelerationSettings& value) { m_accelerationSettingsHasBeenSet = true; m_accelerationSettings = value; }
/**
* Accelerated transcoding can significantly speed up jobs with long, visually
* complex content. Outputs that use this feature incur pro-tier pricing. For
* information about feature limitations, see the AWS Elemental MediaConvert User
* Guide.
*/
inline void SetAccelerationSettings(AccelerationSettings&& value) { m_accelerationSettingsHasBeenSet = true; m_accelerationSettings = std::move(value); }
/**
* Accelerated transcoding can significantly speed up jobs with long, visually
* complex content. Outputs that use this feature incur pro-tier pricing. For
* information about feature limitations, see the AWS Elemental MediaConvert User
* Guide.
*/
inline CreateJobTemplateRequest& WithAccelerationSettings(const AccelerationSettings& value) { SetAccelerationSettings(value); return *this;}
/**
* Accelerated transcoding can significantly speed up jobs with long, visually
* complex content. Outputs that use this feature incur pro-tier pricing. For
* information about feature limitations, see the AWS Elemental MediaConvert User
* Guide.
*/
inline CreateJobTemplateRequest& WithAccelerationSettings(AccelerationSettings&& value) { SetAccelerationSettings(std::move(value)); return *this;}
/**
* Optional. A category for the job template you are creating
*/
inline const Aws::String& GetCategory() const{ return m_category; }
/**
* Optional. A category for the job template you are creating
*/
inline bool CategoryHasBeenSet() const { return m_categoryHasBeenSet; }
/**
* Optional. A category for the job template you are creating
*/
inline void SetCategory(const Aws::String& value) { m_categoryHasBeenSet = true; m_category = value; }
/**
* Optional. A category for the job template you are creating
*/
inline void SetCategory(Aws::String&& value) { m_categoryHasBeenSet = true; m_category = std::move(value); }
/**
* Optional. A category for the job template you are creating
*/
inline void SetCategory(const char* value) { m_categoryHasBeenSet = true; m_category.assign(value); }
/**
* Optional. A category for the job template you are creating
*/
inline CreateJobTemplateRequest& WithCategory(const Aws::String& value) { SetCategory(value); return *this;}
/**
* Optional. A category for the job template you are creating
*/
inline CreateJobTemplateRequest& WithCategory(Aws::String&& value) { SetCategory(std::move(value)); return *this;}
/**
* Optional. A category for the job template you are creating
*/
inline CreateJobTemplateRequest& WithCategory(const char* value) { SetCategory(value); return *this;}
/**
* Optional. A description of the job template you are creating.
*/
inline const Aws::String& GetDescription() const{ return m_description; }
/**
* Optional. A description of the job template you are creating.
*/
inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
/**
* Optional. A description of the job template you are creating.
*/
inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
/**
* Optional. A description of the job template you are creating.
*/
inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
/**
* Optional. A description of the job template you are creating.
*/
inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
/**
* Optional. A description of the job template you are creating.
*/
inline CreateJobTemplateRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
/**
* Optional. A description of the job template you are creating.
*/
inline CreateJobTemplateRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
/**
* Optional. A description of the job template you are creating.
*/
inline CreateJobTemplateRequest& WithDescription(const char* value) { SetDescription(value); return *this;}
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the
* queue that you submit your job to. Specify an alternate queue and the maximum
* time that your job will wait in the initial queue before hopping. For more
* information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
inline const Aws::Vector<HopDestination>& GetHopDestinations() const{ return m_hopDestinations; }
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the
* queue that you submit your job to. Specify an alternate queue and the maximum
* time that your job will wait in the initial queue before hopping. For more
* information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
inline bool HopDestinationsHasBeenSet() const { return m_hopDestinationsHasBeenSet; }
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the
* queue that you submit your job to. Specify an alternate queue and the maximum
* time that your job will wait in the initial queue before hopping. For more
* information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
inline void SetHopDestinations(const Aws::Vector<HopDestination>& value) { m_hopDestinationsHasBeenSet = true; m_hopDestinations = value; }
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the
* queue that you submit your job to. Specify an alternate queue and the maximum
* time that your job will wait in the initial queue before hopping. For more
* information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
inline void SetHopDestinations(Aws::Vector<HopDestination>&& value) { m_hopDestinationsHasBeenSet = true; m_hopDestinations = std::move(value); }
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the
* queue that you submit your job to. Specify an alternate queue and the maximum
* time that your job will wait in the initial queue before hopping. For more
* information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
inline CreateJobTemplateRequest& WithHopDestinations(const Aws::Vector<HopDestination>& value) { SetHopDestinations(value); return *this;}
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the
* queue that you submit your job to. Specify an alternate queue and the maximum
* time that your job will wait in the initial queue before hopping. For more
* information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
inline CreateJobTemplateRequest& WithHopDestinations(Aws::Vector<HopDestination>&& value) { SetHopDestinations(std::move(value)); return *this;}
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the
* queue that you submit your job to. Specify an alternate queue and the maximum
* time that your job will wait in the initial queue before hopping. For more
* information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
inline CreateJobTemplateRequest& AddHopDestinations(const HopDestination& value) { m_hopDestinationsHasBeenSet = true; m_hopDestinations.push_back(value); return *this; }
/**
* Optional. Use queue hopping to avoid overly long waits in the backlog of the
* queue that you submit your job to. Specify an alternate queue and the maximum
* time that your job will wait in the initial queue before hopping. For more
* information about this feature, see the AWS Elemental MediaConvert User Guide.
*/
inline CreateJobTemplateRequest& AddHopDestinations(HopDestination&& value) { m_hopDestinationsHasBeenSet = true; m_hopDestinations.push_back(std::move(value)); return *this; }
/**
* The name of the job template you are creating.
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* The name of the job template you are creating.
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* The name of the job template you are creating.
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* The name of the job template you are creating.
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* The name of the job template you are creating.
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* The name of the job template you are creating.
*/
inline CreateJobTemplateRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* The name of the job template you are creating.
*/
inline CreateJobTemplateRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* The name of the job template you are creating.
*/
inline CreateJobTemplateRequest& WithName(const char* value) { SetName(value); return *this;}
/**
* Specify the relative priority for this job. In any given queue, the service
* begins processing the job with the highest value first. When more than one job
* has the same priority, the service begins processing the job that you submitted
* first. If you don't specify a priority, the service uses the default value 0.
*/
inline int GetPriority() const{ return m_priority; }
/**
* Specify the relative priority for this job. In any given queue, the service
* begins processing the job with the highest value first. When more than one job
* has the same priority, the service begins processing the job that you submitted
* first. If you don't specify a priority, the service uses the default value 0.
*/
inline bool PriorityHasBeenSet() const { return m_priorityHasBeenSet; }
/**
* Specify the relative priority for this job. In any given queue, the service
* begins processing the job with the highest value first. When more than one job
* has the same priority, the service begins processing the job that you submitted
* first. If you don't specify a priority, the service uses the default value 0.
*/
inline void SetPriority(int value) { m_priorityHasBeenSet = true; m_priority = value; }
/**
* Specify the relative priority for this job. In any given queue, the service
* begins processing the job with the highest value first. When more than one job
* has the same priority, the service begins processing the job that you submitted
* first. If you don't specify a priority, the service uses the default value 0.
*/
inline CreateJobTemplateRequest& WithPriority(int value) { SetPriority(value); return *this;}
/**
* Optional. The queue that jobs created from this template are assigned to. If you
* don't specify this, jobs will go to the default queue.
*/
inline const Aws::String& GetQueue() const{ return m_queue; }
/**
* Optional. The queue that jobs created from this template are assigned to. If you
* don't specify this, jobs will go to the default queue.
*/
inline bool QueueHasBeenSet() const { return m_queueHasBeenSet; }
/**
* Optional. The queue that jobs created from this template are assigned to. If you
* don't specify this, jobs will go to the default queue.
*/
inline void SetQueue(const Aws::String& value) { m_queueHasBeenSet = true; m_queue = value; }
/**
* Optional. The queue that jobs created from this template are assigned to. If you
* don't specify this, jobs will go to the default queue.
*/
inline void SetQueue(Aws::String&& value) { m_queueHasBeenSet = true; m_queue = std::move(value); }
/**
* Optional. The queue that jobs created from this template are assigned to. If you
* don't specify this, jobs will go to the default queue.
*/
inline void SetQueue(const char* value) { m_queueHasBeenSet = true; m_queue.assign(value); }
/**
* Optional. The queue that jobs created from this template are assigned to. If you
* don't specify this, jobs will go to the default queue.
*/
inline CreateJobTemplateRequest& WithQueue(const Aws::String& value) { SetQueue(value); return *this;}
/**
* Optional. The queue that jobs created from this template are assigned to. If you
* don't specify this, jobs will go to the default queue.
*/
inline CreateJobTemplateRequest& WithQueue(Aws::String&& value) { SetQueue(std::move(value)); return *this;}
/**
* Optional. The queue that jobs created from this template are assigned to. If you
* don't specify this, jobs will go to the default queue.
*/
inline CreateJobTemplateRequest& WithQueue(const char* value) { SetQueue(value); return *this;}
/**
* JobTemplateSettings contains all the transcode settings saved in the template
* that will be applied to jobs created from it.
*/
inline const JobTemplateSettings& GetSettings() const{ return m_settings; }
/**
* JobTemplateSettings contains all the transcode settings saved in the template
* that will be applied to jobs created from it.
*/
inline bool SettingsHasBeenSet() const { return m_settingsHasBeenSet; }
/**
* JobTemplateSettings contains all the transcode settings saved in the template
* that will be applied to jobs created from it.
*/
inline void SetSettings(const JobTemplateSettings& value) { m_settingsHasBeenSet = true; m_settings = value; }
/**
* JobTemplateSettings contains all the transcode settings saved in the template
* that will be applied to jobs created from it.
*/
inline void SetSettings(JobTemplateSettings&& value) { m_settingsHasBeenSet = true; m_settings = std::move(value); }
/**
* JobTemplateSettings contains all the transcode settings saved in the template
* that will be applied to jobs created from it.
*/
inline CreateJobTemplateRequest& WithSettings(const JobTemplateSettings& value) { SetSettings(value); return *this;}
/**
* JobTemplateSettings contains all the transcode settings saved in the template
* that will be applied to jobs created from it.
*/
inline CreateJobTemplateRequest& WithSettings(JobTemplateSettings&& value) { SetSettings(std::move(value)); return *this;}
/**
* Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch
* Events. Set the interval, in seconds, between status updates. MediaConvert sends
* an update at this interval from the time the service begins processing your job
* to the time it completes the transcode or encounters an error.
*/
inline const StatusUpdateInterval& GetStatusUpdateInterval() const{ return m_statusUpdateInterval; }
/**
* Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch
* Events. Set the interval, in seconds, between status updates. MediaConvert sends
* an update at this interval from the time the service begins processing your job
* to the time it completes the transcode or encounters an error.
*/
inline bool StatusUpdateIntervalHasBeenSet() const { return m_statusUpdateIntervalHasBeenSet; }
/**
* Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch
* Events. Set the interval, in seconds, between status updates. MediaConvert sends
* an update at this interval from the time the service begins processing your job
* to the time it completes the transcode or encounters an error.
*/
inline void SetStatusUpdateInterval(const StatusUpdateInterval& value) { m_statusUpdateIntervalHasBeenSet = true; m_statusUpdateInterval = value; }
/**
* Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch
* Events. Set the interval, in seconds, between status updates. MediaConvert sends
* an update at this interval from the time the service begins processing your job
* to the time it completes the transcode or encounters an error.
*/
inline void SetStatusUpdateInterval(StatusUpdateInterval&& value) { m_statusUpdateIntervalHasBeenSet = true; m_statusUpdateInterval = std::move(value); }
/**
* Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch
* Events. Set the interval, in seconds, between status updates. MediaConvert sends
* an update at this interval from the time the service begins processing your job
* to the time it completes the transcode or encounters an error.
*/
inline CreateJobTemplateRequest& WithStatusUpdateInterval(const StatusUpdateInterval& value) { SetStatusUpdateInterval(value); return *this;}
/**
* Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch
* Events. Set the interval, in seconds, between status updates. MediaConvert sends
* an update at this interval from the time the service begins processing your job
* to the time it completes the transcode or encounters an error.
*/
inline CreateJobTemplateRequest& WithStatusUpdateInterval(StatusUpdateInterval&& value) { SetStatusUpdateInterval(std::move(value)); return *this;}
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline const Aws::Map<Aws::String, Aws::String>& GetTags() const{ return m_tags; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline void SetTags(const Aws::Map<Aws::String, Aws::String>& value) { m_tagsHasBeenSet = true; m_tags = value; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline void SetTags(Aws::Map<Aws::String, Aws::String>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& WithTags(const Aws::Map<Aws::String, Aws::String>& value) { SetTags(value); return *this;}
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& WithTags(Aws::Map<Aws::String, Aws::String>&& value) { SetTags(std::move(value)); return *this;}
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& AddTags(const Aws::String& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& AddTags(Aws::String&& key, const Aws::String& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& AddTags(const Aws::String& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& AddTags(Aws::String&& key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), std::move(value)); return *this; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& AddTags(const char* key, Aws::String&& value) { m_tagsHasBeenSet = true; m_tags.emplace(key, std::move(value)); return *this; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& AddTags(Aws::String&& key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(std::move(key), value); return *this; }
/**
* The tags that you want to add to the resource. You can tag resources with a
* key-value pair or with only a key.
*/
inline CreateJobTemplateRequest& AddTags(const char* key, const char* value) { m_tagsHasBeenSet = true; m_tags.emplace(key, value); return *this; }
private:
AccelerationSettings m_accelerationSettings;
bool m_accelerationSettingsHasBeenSet;
Aws::String m_category;
bool m_categoryHasBeenSet;
Aws::String m_description;
bool m_descriptionHasBeenSet;
Aws::Vector<HopDestination> m_hopDestinations;
bool m_hopDestinationsHasBeenSet;
Aws::String m_name;
bool m_nameHasBeenSet;
int m_priority;
bool m_priorityHasBeenSet;
Aws::String m_queue;
bool m_queueHasBeenSet;
JobTemplateSettings m_settings;
bool m_settingsHasBeenSet;
StatusUpdateInterval m_statusUpdateInterval;
bool m_statusUpdateIntervalHasBeenSet;
Aws::Map<Aws::String, Aws::String> m_tags;
bool m_tagsHasBeenSet;
};
} // namespace Model
} // namespace MediaConvert
} // namespace Aws