co.cask.cdap.proto

Class BatchRunnableInstances

java.lang.Object

co.cask.cdap.proto.BatchProgram

co.cask.cdap.proto.BatchRunnable

co.cask.cdap.proto.BatchRunnableInstances

public class BatchRunnableInstances
extends BatchRunnable

Describes the instances of a program, as returned by the batch instances endpoint POST /namespaces/{namespace}/instances.

Field Summary

Fields inherited from class co.cask.cdap.proto.BatchRunnable

runnableId

Fields inherited from class co.cask.cdap.proto.BatchProgram

appId, programId, programType

Constructor Summary

Constructors

Constructor and Description
BatchRunnableInstances(BatchRunnable runnable, int statusCode, int provisioned, int requested)
BatchRunnableInstances(BatchRunnable runnable, int statusCode, String error)

Method Summary

Methods

Modifier and Type	Method and Description
String	getError()
Integer	getProvisioned()
Integer	getRequested()
int	getStatusCode()

Methods inherited from class co.cask.cdap.proto.BatchRunnable

getRunnableId

Methods inherited from class co.cask.cdap.proto.BatchProgram

equals, from, getAppId, getProgramId, getProgramType, hashCode, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchRunnableInstances

public BatchRunnableInstances(BatchRunnable runnable,
                      int statusCode,
                      int provisioned,
                      int requested)

BatchRunnableInstances

public BatchRunnableInstances(BatchRunnable runnable,
                      int statusCode,
                      String error)

Method Detail

getStatusCode

public int getStatusCode()

getProvisioned

@Nullable
public Integer getProvisioned()

Returns:

the number of provisioned instances, or null if there was an error getting instances.

getRequested

@Nullable
public Integer getRequested()

Returns:

the number of requested instances, or null if there was an error getting instances.

getError

@Nullable
public String getError()

Returns:

the error message, or null if there was no error.