com.google.api.ads.adwords.v201109.cm
Class BulkMutateJob

java.lang.Object
  com.google.api.ads.adwords.v201109.cm.Job
      com.google.api.ads.adwords.v201109.cm.BulkMutateJob

All Implemented Interfaces:

Serializable

public class BulkMutateJob
extends Job
implements Serializable

A BulkMutateJob is essentially a mixed collection of mutate operations from the following AdWords API campaign management services:

• CampaignService
• CampaignTargetService
• CampaignCriterionService
• AdGroupService
• AdGroupAdService
• AdGroupCriterionService

The mutate operations in a job's request are constructed in exactly the same way as they are for synchronous calls to these services.

The mutate operations are grouped by their scoping entity in the AdWords customer tree. Currently, mutate operations can be grouped either by the customer or by their parent campaign. However, they cannot be grouped both ways - some by customer and others by campaigns - in the same job.

Note: A job may have no more than 500,000 mutate operations in total, and no more than 10 different scoping campaigns.

The mutate operations must be packaged into containers called Operation Streams, each tagged with the ID of the scoping entity of its operations.

To facilitate the building of very large bulk mutate jobs, the operation streams of a job can be submitted using multiple request parts. A job is queued for processing as soon as it can be determined that all of its request parts have been received.

Note: A job may have no more than 100 request parts. Each part may have no more than 25 operation streams and no more than 10,000 operations in total.

See Also:

Serialized Form

Constructor Summary

BulkMutateJob()

BulkMutateJob(String customerJobKey, ApiErrorReason failureReason, JobStats stats, BillingSummary billingSummary, String jobType, Long id, BulkMutateJobPolicy policy, BulkMutateRequest request, BasicJobStatus status, BulkMutateJobEvent[] history, BulkMutateResult result, Integer numRequestParts, Integer numRequestPartsReceived)

Method Summary

boolean	equals(Object obj)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
BulkMutateJobEvent[]	getHistory() Gets the history value for this BulkMutateJob.
BulkMutateJobEvent	getHistory(int i)
Long	getId() Gets the id value for this BulkMutateJob.
Integer	getNumRequestParts() Gets the numRequestParts value for this BulkMutateJob.
Integer	getNumRequestPartsReceived() Gets the numRequestPartsReceived value for this BulkMutateJob.
BulkMutateJobPolicy	getPolicy() Gets the policy value for this BulkMutateJob.
BulkMutateRequest	getRequest() Gets the request value for this BulkMutateJob.
BulkMutateResult	getResult() Gets the result value for this BulkMutateJob.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
BasicJobStatus	getStatus() Gets the status value for this BulkMutateJob.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setHistory(BulkMutateJobEvent[] history) Sets the history value for this BulkMutateJob.
void	setHistory(int i, BulkMutateJobEvent _value)
void	setId(Long id) Sets the id value for this BulkMutateJob.
void	setNumRequestParts(Integer numRequestParts) Sets the numRequestParts value for this BulkMutateJob.
void	setNumRequestPartsReceived(Integer numRequestPartsReceived) Sets the numRequestPartsReceived value for this BulkMutateJob.
void	setPolicy(BulkMutateJobPolicy policy) Sets the policy value for this BulkMutateJob.
void	setRequest(BulkMutateRequest request) Sets the request value for this BulkMutateJob.
void	setResult(BulkMutateResult result) Sets the result value for this BulkMutateJob.
void	setStatus(BasicJobStatus status) Sets the status value for this BulkMutateJob.

Methods inherited from class com.google.api.ads.adwords.v201109.cm.Job

getBillingSummary, getCustomerJobKey, getFailureReason, getJobType, getStats, setBillingSummary, setCustomerJobKey, setFailureReason, setJobType, setStats

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkMutateJob

public BulkMutateJob()

BulkMutateJob

public BulkMutateJob(String customerJobKey,
                     ApiErrorReason failureReason,
                     JobStats stats,
                     BillingSummary billingSummary,
                     String jobType,
                     Long id,
                     BulkMutateJobPolicy policy,
                     BulkMutateRequest request,
                     BasicJobStatus status,
                     BulkMutateJobEvent[] history,
                     BulkMutateResult result,
                     Integer numRequestParts,
                     Integer numRequestPartsReceived)

Method Detail

getId

public Long getId()

Gets the id value for this BulkMutateJob.

Returns:

id * ID of this bulk mutate job, which is returned by BulkMutateJobService after adding a new job. This field is read only and should not be set for following Operators : ADD. If this field is sent to the API, it will be ignored.

setId

public void setId(Long id)

Sets the id value for this BulkMutateJob.

Parameters:

id - * ID of this bulk mutate job, which is returned by BulkMutateJobService after adding a new job. This field is read only and should not be set for following Operators : ADD. If this field is sent to the API, it will be ignored.

getPolicy

public BulkMutateJobPolicy getPolicy()

Gets the policy value for this BulkMutateJob.

Returns:

policy * Defines which existing jobs are required to successfully process before starting this job. This field can only be set when adding a new job. This field is read only and should not be set for following Operators : SET. If this field is sent to the API, it will be ignored.

setPolicy

public void setPolicy(BulkMutateJobPolicy policy)

Sets the policy value for this BulkMutateJob.

Parameters:

policy - * Defines which existing jobs are required to successfully process before starting this job. This field can only be set when adding a new job. This field is read only and should not be set for following Operators : SET. If this field is sent to the API, it will be ignored.

getRequest

public BulkMutateRequest getRequest()

Gets the request value for this BulkMutateJob.

Returns:

request * A request part of this job. Even though a BulkMutateJob can contain up to 100 request parts (each with a unique partIndex), only one can be added or updated at a time for optimization purposes. This field is required and should not be null when it is contained within Operators : ADD.

setRequest

public void setRequest(BulkMutateRequest request)

Sets the request value for this BulkMutateJob.

Parameters:

request - * A request part of this job. Even though a BulkMutateJob can contain up to 100 request parts (each with a unique partIndex), only one can be added or updated at a time for optimization purposes. This field is required and should not be null when it is contained within Operators : ADD.

getStatus

public BasicJobStatus getStatus()

Gets the status value for this BulkMutateJob.

Returns:

status * Status of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setStatus

public void setStatus(BasicJobStatus status)

Sets the status value for this BulkMutateJob.

Parameters:

status - * Status of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getHistory

public BulkMutateJobEvent[] getHistory()

Gets the history value for this BulkMutateJob.

Returns:

history * History of status changes of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setHistory

public void setHistory(BulkMutateJobEvent[] history)

Sets the history value for this BulkMutateJob.

Parameters:

history - * History of status changes of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getHistory

public BulkMutateJobEvent getHistory(int i)

setHistory

public void setHistory(int i,
                       BulkMutateJobEvent _value)

getResult

public BulkMutateResult getResult()

Gets the result value for this BulkMutateJob.

Returns:

result * The selected result part of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setResult

public void setResult(BulkMutateResult result)

Sets the result value for this BulkMutateJob.

Parameters:

result - * The selected result part of this job. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getNumRequestParts

public Integer getNumRequestParts()

Gets the numRequestParts value for this BulkMutateJob.

Returns:

numRequestParts * Total number of request parts (maximum of 100) in this job.

setNumRequestParts

public void setNumRequestParts(Integer numRequestParts)

Sets the numRequestParts value for this BulkMutateJob.

Parameters:

numRequestParts - * Total number of request parts (maximum of 100) in this job.

getNumRequestPartsReceived

public Integer getNumRequestPartsReceived()

Gets the numRequestPartsReceived value for this BulkMutateJob.

Returns:

numRequestPartsReceived * Number of request parts currently received via ADD and SET operations. This job will begin processing when numRequestPartsReceived equals numRequestParts. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setNumRequestPartsReceived

public void setNumRequestPartsReceived(Integer numRequestPartsReceived)

Sets the numRequestPartsReceived value for this BulkMutateJob.

Parameters:

numRequestPartsReceived - * Number of request parts currently received via ADD and SET operations. This job will begin processing when numRequestPartsReceived equals numRequestParts. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

equals

public boolean equals(Object obj)

Overrides:

equals in class Job

hashCode

public int hashCode()

Overrides:

hashCode in class Job

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer