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

java.lang.Object
  extended by org.apache.axis.client.Stub
      extended by com.google.api.ads.adwords.v201109.cm.MutateJobServiceSoapBindingStub
All Implemented Interfaces:
MutateJobServiceInterface, Remote, javax.xml.rpc.Stub

public class MutateJobServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements MutateJobServiceInterface


Field Summary
 
Fields inherited from class org.apache.axis.client.Stub
_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service
 
Fields inherited from interface javax.xml.rpc.Stub
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY
 
Constructor Summary
MutateJobServiceSoapBindingStub()
           
MutateJobServiceSoapBindingStub(javax.xml.rpc.Service service)
           
MutateJobServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
protected  org.apache.axis.client.Call createCall()
           
 Job[] get(JobSelector selector)
          Query the status of existing jobs, both simple and bulk API.
Use a JobSelector to query and return a list which may contain both BulkMutateJob and/or SimpleMutateJob.
 JobResult getResult(JobSelector selector)
          Query mutation results, of a COMPLETED job.
Use a JobSelector to query and return either a BulkMutateResult or a SimpleMutateResult.
 SimpleMutateJob mutate(Operation[] operations, BulkMutateJobPolicy policy)
          Simplified way of submitting a mutation job.
 
Methods inherited from class org.apache.axis.client.Stub
_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MutateJobServiceSoapBindingStub

public MutateJobServiceSoapBindingStub()
                                throws org.apache.axis.AxisFault
Throws:
org.apache.axis.AxisFault

MutateJobServiceSoapBindingStub

public MutateJobServiceSoapBindingStub(URL endpointURL,
                                       javax.xml.rpc.Service service)
                                throws org.apache.axis.AxisFault
Throws:
org.apache.axis.AxisFault

MutateJobServiceSoapBindingStub

public MutateJobServiceSoapBindingStub(javax.xml.rpc.Service service)
                                throws org.apache.axis.AxisFault
Throws:
org.apache.axis.AxisFault
Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException
Throws:
RemoteException

get

public Job[] get(JobSelector selector)
          throws RemoteException,
                 ApiException
Description copied from interface: MutateJobServiceInterface
Query the status of existing jobs, both simple and bulk API.
Use a JobSelector to query and return a list which may contain both BulkMutateJob and/or SimpleMutateJob.

This method will limit the number of returned results to the most recent 100 jobs. You should use a selector which will return a reasonable number of jobs in the result.

Specified by:
get in interface MutateJobServiceInterface
Throws:
RemoteException
ApiException

getResult

public JobResult getResult(JobSelector selector)
                    throws RemoteException,
                           ApiException
Description copied from interface: MutateJobServiceInterface
Query mutation results, of a COMPLETED job.
Use a JobSelector to query and return either a BulkMutateResult or a SimpleMutateResult.

Specified by:
getResult in interface MutateJobServiceInterface
Throws:
RemoteException
ApiException

mutate

public SimpleMutateJob mutate(Operation[] operations,
                              BulkMutateJobPolicy policy)
                       throws RemoteException,
                              ApiException
Description copied from interface: MutateJobServiceInterface
Simplified way of submitting a mutation job. The provided list of operations, if valid, will create a new job with a unique id, which will be returned. This id can later be used in invocations of MutateJobServiceInterface.get(com.google.api.ads.adwords.v201109.cm.JobSelector) and MutateJobServiceInterface.getResult(com.google.api.ads.adwords.v201109.cm.JobSelector). policy can optionally be specified.

When this method returns with success, the job will be in PROCESSING or PENDING state and no further action is needed for the job to get executed.
You should not use the returned BulkMutateJobId with bulk API BulkMutateJobService#mutate method.

Specified by:
mutate in interface MutateJobServiceInterface
Throws:
RemoteException
ApiException


Copyright © 2011. All Rights Reserved.