AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::Batch::Model::NodeOverrides Class Reference

#include <NodeOverrides.h>

Public Member Functions

 NodeOverrides ()
 
 NodeOverrides (Aws::Utils::Json::JsonView jsonValue)
 
NodeOverridesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetNumNodes () const
 
bool NumNodesHasBeenSet () const
 
void SetNumNodes (int value)
 
NodeOverridesWithNumNodes (int value)
 
const Aws::Vector< NodePropertyOverride > & GetNodePropertyOverrides () const
 
bool NodePropertyOverridesHasBeenSet () const
 
void SetNodePropertyOverrides (const Aws::Vector< NodePropertyOverride > &value)
 
void SetNodePropertyOverrides (Aws::Vector< NodePropertyOverride > &&value)
 
NodeOverridesWithNodePropertyOverrides (const Aws::Vector< NodePropertyOverride > &value)
 
NodeOverridesWithNodePropertyOverrides (Aws::Vector< NodePropertyOverride > &&value)
 
NodeOverridesAddNodePropertyOverrides (const NodePropertyOverride &value)
 
NodeOverridesAddNodePropertyOverrides (NodePropertyOverride &&value)
 

Detailed Description

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

See Also:

AWS API Reference

Definition at line 33 of file NodeOverrides.h.

Constructor & Destructor Documentation

◆ NodeOverrides() [1/2]

Aws::Batch::Model::NodeOverrides::NodeOverrides ( )

◆ NodeOverrides() [2/2]

Aws::Batch::Model::NodeOverrides::NodeOverrides ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddNodePropertyOverrides() [1/2]

NodeOverrides& Aws::Batch::Model::NodeOverrides::AddNodePropertyOverrides ( const NodePropertyOverride value)
inline

The node property overrides for the job.

Definition at line 128 of file NodeOverrides.h.

◆ AddNodePropertyOverrides() [2/2]

NodeOverrides& Aws::Batch::Model::NodeOverrides::AddNodePropertyOverrides ( NodePropertyOverride &&  value)
inline

The node property overrides for the job.

Definition at line 133 of file NodeOverrides.h.

◆ GetNodePropertyOverrides()

const Aws::Vector<NodePropertyOverride>& Aws::Batch::Model::NodeOverrides::GetNodePropertyOverrides ( ) const
inline

The node property overrides for the job.

Definition at line 98 of file NodeOverrides.h.

◆ GetNumNodes()

int Aws::Batch::Model::NodeOverrides::GetNumNodes ( ) const
inline

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:

  • There must be at least one node range in your job definition that has an open upper boundary (such as : or n:).

  • The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.

  • The main node index specified in the job definition must be fewer than the number of nodes specified in the override.

Definition at line 53 of file NodeOverrides.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Batch::Model::NodeOverrides::Jsonize ( ) const

◆ NodePropertyOverridesHasBeenSet()

bool Aws::Batch::Model::NodeOverrides::NodePropertyOverridesHasBeenSet ( ) const
inline

The node property overrides for the job.

Definition at line 103 of file NodeOverrides.h.

◆ NumNodesHasBeenSet()

bool Aws::Batch::Model::NodeOverrides::NumNodesHasBeenSet ( ) const
inline

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:

  • There must be at least one node range in your job definition that has an open upper boundary (such as : or n:).

  • The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.

  • The main node index specified in the job definition must be fewer than the number of nodes specified in the override.

Definition at line 66 of file NodeOverrides.h.

◆ operator=()

NodeOverrides& Aws::Batch::Model::NodeOverrides::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetNodePropertyOverrides() [1/2]

void Aws::Batch::Model::NodeOverrides::SetNodePropertyOverrides ( const Aws::Vector< NodePropertyOverride > &  value)
inline

The node property overrides for the job.

Definition at line 108 of file NodeOverrides.h.

◆ SetNodePropertyOverrides() [2/2]

void Aws::Batch::Model::NodeOverrides::SetNodePropertyOverrides ( Aws::Vector< NodePropertyOverride > &&  value)
inline

The node property overrides for the job.

Definition at line 113 of file NodeOverrides.h.

◆ SetNumNodes()

void Aws::Batch::Model::NodeOverrides::SetNumNodes ( int  value)
inline

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:

  • There must be at least one node range in your job definition that has an open upper boundary (such as : or n:).

  • The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.

  • The main node index specified in the job definition must be fewer than the number of nodes specified in the override.

Definition at line 79 of file NodeOverrides.h.

◆ WithNodePropertyOverrides() [1/2]

NodeOverrides& Aws::Batch::Model::NodeOverrides::WithNodePropertyOverrides ( const Aws::Vector< NodePropertyOverride > &  value)
inline

The node property overrides for the job.

Definition at line 118 of file NodeOverrides.h.

◆ WithNodePropertyOverrides() [2/2]

NodeOverrides& Aws::Batch::Model::NodeOverrides::WithNodePropertyOverrides ( Aws::Vector< NodePropertyOverride > &&  value)
inline

The node property overrides for the job.

Definition at line 123 of file NodeOverrides.h.

◆ WithNumNodes()

NodeOverrides& Aws::Batch::Model::NodeOverrides::WithNumNodes ( int  value)
inline

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:

  • There must be at least one node range in your job definition that has an open upper boundary (such as : or n:).

  • The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.

  • The main node index specified in the job definition must be fewer than the number of nodes specified in the override.

Definition at line 92 of file NodeOverrides.h.


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