AWS SDK for C++  1.8.93
AWS SDK for C++
Public Member Functions | List of all members
Aws::EventBridge::Model::BatchParameters Class Reference

#include <BatchParameters.h>

Public Member Functions

 BatchParameters ()
 
 BatchParameters (Aws::Utils::Json::JsonView jsonValue)
 
BatchParametersoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobDefinition () const
 
bool JobDefinitionHasBeenSet () const
 
void SetJobDefinition (const Aws::String &value)
 
void SetJobDefinition (Aws::String &&value)
 
void SetJobDefinition (const char *value)
 
BatchParametersWithJobDefinition (const Aws::String &value)
 
BatchParametersWithJobDefinition (Aws::String &&value)
 
BatchParametersWithJobDefinition (const char *value)
 
const Aws::StringGetJobName () const
 
bool JobNameHasBeenSet () const
 
void SetJobName (const Aws::String &value)
 
void SetJobName (Aws::String &&value)
 
void SetJobName (const char *value)
 
BatchParametersWithJobName (const Aws::String &value)
 
BatchParametersWithJobName (Aws::String &&value)
 
BatchParametersWithJobName (const char *value)
 
const BatchArrayPropertiesGetArrayProperties () const
 
bool ArrayPropertiesHasBeenSet () const
 
void SetArrayProperties (const BatchArrayProperties &value)
 
void SetArrayProperties (BatchArrayProperties &&value)
 
BatchParametersWithArrayProperties (const BatchArrayProperties &value)
 
BatchParametersWithArrayProperties (BatchArrayProperties &&value)
 
const BatchRetryStrategyGetRetryStrategy () const
 
bool RetryStrategyHasBeenSet () const
 
void SetRetryStrategy (const BatchRetryStrategy &value)
 
void SetRetryStrategy (BatchRetryStrategy &&value)
 
BatchParametersWithRetryStrategy (const BatchRetryStrategy &value)
 
BatchParametersWithRetryStrategy (BatchRetryStrategy &&value)
 

Detailed Description

The custom parameters to be used when the target is an AWS Batch job.

See Also:

AWS API Reference

Definition at line 34 of file BatchParameters.h.

Constructor & Destructor Documentation

◆ BatchParameters() [1/2]

Aws::EventBridge::Model::BatchParameters::BatchParameters ( )

◆ BatchParameters() [2/2]

Aws::EventBridge::Model::BatchParameters::BatchParameters ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArrayPropertiesHasBeenSet()

bool Aws::EventBridge::Model::BatchParameters::ArrayPropertiesHasBeenSet ( ) const
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

Definition at line 155 of file BatchParameters.h.

◆ GetArrayProperties()

const BatchArrayProperties& Aws::EventBridge::Model::BatchParameters::GetArrayProperties ( ) const
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

Definition at line 147 of file BatchParameters.h.

◆ GetJobDefinition()

const Aws::String& Aws::EventBridge::Model::BatchParameters::GetJobDefinition ( ) const
inline

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Definition at line 47 of file BatchParameters.h.

◆ GetJobName()

const Aws::String& Aws::EventBridge::Model::BatchParameters::GetJobName ( ) const
inline

The name to use for this execution of the job, if the target is an AWS Batch job.

Definition at line 96 of file BatchParameters.h.

◆ GetRetryStrategy()

const BatchRetryStrategy& Aws::EventBridge::Model::BatchParameters::GetRetryStrategy ( ) const
inline

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Definition at line 196 of file BatchParameters.h.

◆ JobDefinitionHasBeenSet()

bool Aws::EventBridge::Model::BatchParameters::JobDefinitionHasBeenSet ( ) const
inline

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Definition at line 53 of file BatchParameters.h.

◆ JobNameHasBeenSet()

bool Aws::EventBridge::Model::BatchParameters::JobNameHasBeenSet ( ) const
inline

The name to use for this execution of the job, if the target is an AWS Batch job.

Definition at line 102 of file BatchParameters.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EventBridge::Model::BatchParameters::Jsonize ( ) const

◆ operator=()

BatchParameters& Aws::EventBridge::Model::BatchParameters::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RetryStrategyHasBeenSet()

bool Aws::EventBridge::Model::BatchParameters::RetryStrategyHasBeenSet ( ) const
inline

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Definition at line 204 of file BatchParameters.h.

◆ SetArrayProperties() [1/2]

void Aws::EventBridge::Model::BatchParameters::SetArrayProperties ( const BatchArrayProperties value)
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

Definition at line 163 of file BatchParameters.h.

◆ SetArrayProperties() [2/2]

void Aws::EventBridge::Model::BatchParameters::SetArrayProperties ( BatchArrayProperties &&  value)
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

Definition at line 171 of file BatchParameters.h.

◆ SetJobDefinition() [1/3]

void Aws::EventBridge::Model::BatchParameters::SetJobDefinition ( const Aws::String value)
inline

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Definition at line 59 of file BatchParameters.h.

◆ SetJobDefinition() [2/3]

void Aws::EventBridge::Model::BatchParameters::SetJobDefinition ( Aws::String &&  value)
inline

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Definition at line 65 of file BatchParameters.h.

◆ SetJobDefinition() [3/3]

void Aws::EventBridge::Model::BatchParameters::SetJobDefinition ( const char *  value)
inline

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Definition at line 71 of file BatchParameters.h.

◆ SetJobName() [1/3]

void Aws::EventBridge::Model::BatchParameters::SetJobName ( const Aws::String value)
inline

The name to use for this execution of the job, if the target is an AWS Batch job.

Definition at line 108 of file BatchParameters.h.

◆ SetJobName() [2/3]

void Aws::EventBridge::Model::BatchParameters::SetJobName ( Aws::String &&  value)
inline

The name to use for this execution of the job, if the target is an AWS Batch job.

Definition at line 114 of file BatchParameters.h.

◆ SetJobName() [3/3]

void Aws::EventBridge::Model::BatchParameters::SetJobName ( const char *  value)
inline

The name to use for this execution of the job, if the target is an AWS Batch job.

Definition at line 120 of file BatchParameters.h.

◆ SetRetryStrategy() [1/2]

void Aws::EventBridge::Model::BatchParameters::SetRetryStrategy ( const BatchRetryStrategy value)
inline

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Definition at line 212 of file BatchParameters.h.

◆ SetRetryStrategy() [2/2]

void Aws::EventBridge::Model::BatchParameters::SetRetryStrategy ( BatchRetryStrategy &&  value)
inline

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Definition at line 220 of file BatchParameters.h.

◆ WithArrayProperties() [1/2]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithArrayProperties ( const BatchArrayProperties value)
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

Definition at line 179 of file BatchParameters.h.

◆ WithArrayProperties() [2/2]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithArrayProperties ( BatchArrayProperties &&  value)
inline

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

Definition at line 187 of file BatchParameters.h.

◆ WithJobDefinition() [1/3]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithJobDefinition ( const Aws::String value)
inline

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Definition at line 77 of file BatchParameters.h.

◆ WithJobDefinition() [2/3]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithJobDefinition ( Aws::String &&  value)
inline

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Definition at line 83 of file BatchParameters.h.

◆ WithJobDefinition() [3/3]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithJobDefinition ( const char *  value)
inline

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

Definition at line 89 of file BatchParameters.h.

◆ WithJobName() [1/3]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithJobName ( const Aws::String value)
inline

The name to use for this execution of the job, if the target is an AWS Batch job.

Definition at line 126 of file BatchParameters.h.

◆ WithJobName() [2/3]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithJobName ( Aws::String &&  value)
inline

The name to use for this execution of the job, if the target is an AWS Batch job.

Definition at line 132 of file BatchParameters.h.

◆ WithJobName() [3/3]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithJobName ( const char *  value)
inline

The name to use for this execution of the job, if the target is an AWS Batch job.

Definition at line 138 of file BatchParameters.h.

◆ WithRetryStrategy() [1/2]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithRetryStrategy ( const BatchRetryStrategy value)
inline

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Definition at line 228 of file BatchParameters.h.

◆ WithRetryStrategy() [2/2]

BatchParameters& Aws::EventBridge::Model::BatchParameters::WithRetryStrategy ( BatchRetryStrategy &&  value)
inline

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

Definition at line 236 of file BatchParameters.h.


The documentation for this class was generated from the following file: