Share via


BatchPoolLifetimeOption Class

public final class BatchPoolLifetimeOption
extends ExpandableStringEnum<BatchPoolLifetimeOption>

BatchPoolLifetimeOption enums.

Field Summary

Modifier and Type Field and Description
static final BatchPoolLifetimeOption JOB

The Pool exists for the lifetime of the Job to which it is dedicated.

static final BatchPoolLifetimeOption JOB_SCHEDULE

The Pool exists for the lifetime of the Job Schedule.

Constructor Summary

Constructor Description
BatchPoolLifetimeOption()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchPoolLifetimeOption value.

Method Summary

Modifier and Type Method and Description
static BatchPoolLifetimeOption fromString(String name)

Creates or finds a BatchPoolLifetimeOption from its string representation.

static Collection<BatchPoolLifetimeOption> values()

Gets known BatchPoolLifetimeOption values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

JOB

public static final BatchPoolLifetimeOption JOB

The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule.

JOB_SCHEDULE

public static final BatchPoolLifetimeOption JOB_SCHEDULE

The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs.

Constructor Details

BatchPoolLifetimeOption

@Deprecated
public BatchPoolLifetimeOption()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchPoolLifetimeOption value.

Method Details

fromString

public static BatchPoolLifetimeOption fromString(String name)

Creates or finds a BatchPoolLifetimeOption from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding BatchPoolLifetimeOption.

values

public static Collection<BatchPoolLifetimeOption> values()

Gets known BatchPoolLifetimeOption values.

Returns:

known BatchPoolLifetimeOption values.

Applies to