com.google.api.ads.adwords.jaxws.v201809.cm

Enum BatchJobStatus

java.lang.Object

java.lang.Enum<BatchJobStatus>

com.google.api.ads.adwords.jaxws.v201809.cm.BatchJobStatus

All Implemented Interfaces:

Serializable, Comparable<BatchJobStatus>

public enum BatchJobStatus
extends Enum<BatchJobStatus>

Java class for BatchJobStatus.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="BatchJobStatus">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="UNKNOWN"/>
     <enumeration value="AWAITING_FILE"/>
     <enumeration value="ACTIVE"/>
     <enumeration value="CANCELING"/>
     <enumeration value="CANCELED"/>
     <enumeration value="DONE"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Indicates that a job has an associated file and is being executed.
AWAITING_FILE Initial state of a BatchJob.
CANCELED Indicates that a job has been canceled.
CANCELING Indicates that a job is being canceled.
DONE Indicates that a job has completed.
UNKNOWN Used for return value only.

Method Summary

Modifier and Type	Method and Description
static BatchJobStatus	fromValue(String v)
String	value()
static BatchJobStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static BatchJobStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final BatchJobStatus UNKNOWN

Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.

AWAITING_FILE

public static final BatchJobStatus AWAITING_FILE

Initial state of a BatchJob. While a job has this status, it is awaiting a file upload to Google Cloud Storage.

ACTIVE

public static final BatchJobStatus ACTIVE

Indicates that a job has an associated file and is being executed.

CANCELING

public static final BatchJobStatus CANCELING

Indicates that a job is being canceled. It will remain in this status until any partial results are written, and then will be marked CANCELED. Send this status in a SET operation to cancel a job that is in progress. This is the only status that can be explicitly set.

CANCELED

public static final BatchJobStatus CANCELED

Indicates that a job has been canceled. It will be garbage-collected 30 days after cancellation.

DONE

public static final BatchJobStatus DONE

Indicates that a job has completed. It will be garbage-collected 30 days after completion.

Method Detail

values

public static BatchJobStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BatchJobStatus c : BatchJobStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BatchJobStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static BatchJobStatus fromValue(String v)