RetrieveRequest (Salesforce Marketing Cloud Java SDK 1.2.1 API)

java.lang.Object
- com.exacttarget.fuelsdk.internal.RetrieveRequest

public class RetrieveRequest
extends Object

Java class for RetrieveRequest complex type.

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

 <complexType name="RetrieveRequest">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="ClientIDs" type="{http://exacttarget.com/wsdl/partnerAPI}ClientID" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ObjectType" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="Properties" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Filter" type="{http://exacttarget.com/wsdl/partnerAPI}FilterPart" minOccurs="0"/>
         <element name="RespondTo" type="{http://exacttarget.com/wsdl/partnerAPI}AsyncResponse" maxOccurs="unbounded" minOccurs="0"/>
         <element name="PartnerProperties" type="{http://exacttarget.com/wsdl/partnerAPI}APIProperty" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ContinueRequest" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="QueryAllAccounts" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="RetrieveAllSinceLastBatch" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="RepeatLastResult" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="Retrieves" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="Request" type="{http://exacttarget.com/wsdl/partnerAPI}Request" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="Options" type="{http://exacttarget.com/wsdl/partnerAPI}RetrieveOptions" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RetrieveRequest.Retrieves
Java class for anonymous complex type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RetrieveRequest.Retrieves` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<ClientID>`	`clientIDs`
`protected String`	`continueRequest`
`protected FilterPart`	`filter`
`protected String`	`objectType`
`protected RetrieveOptions`	`options`
`protected List<APIProperty>`	`partnerProperties`
`protected List<String>`	`properties`
`protected Boolean`	`queryAllAccounts`
`protected Boolean`	`repeatLastResult`
`protected List<AsyncResponse>`	`respondTo`
`protected Boolean`	`retrieveAllSinceLastBatch`
`protected RetrieveRequest.Retrieves`	`retrieves`

Constructor Summary

Constructors
Constructor and Description

RetrieveRequest()

Constructors
Constructor and Description
`RetrieveRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<ClientID>`	`getClientIDs()` Gets the value of the clientIDs property.
`String`	`getContinueRequest()` Gets the value of the continueRequest property.
`FilterPart`	`getFilter()` Gets the value of the filter property.
`String`	`getObjectType()` Gets the value of the objectType property.
`RetrieveOptions`	`getOptions()` Gets the value of the options property.
`List<APIProperty>`	`getPartnerProperties()` Gets the value of the partnerProperties property.
`List<String>`	`getProperties()` Gets the value of the properties property.
`Boolean`	`getQueryAllAccounts()` Gets the value of the queryAllAccounts property.
`Boolean`	`getRepeatLastResult()` Gets the value of the repeatLastResult property.
`List<AsyncResponse>`	`getRespondTo()` Gets the value of the respondTo property.
`Boolean`	`getRetrieveAllSinceLastBatch()` Gets the value of the retrieveAllSinceLastBatch property.
`RetrieveRequest.Retrieves`	`getRetrieves()` Gets the value of the retrieves property.
`void`	`setContinueRequest(String value)` Sets the value of the continueRequest property.
`void`	`setFilter(FilterPart value)` Sets the value of the filter property.
`void`	`setObjectType(String value)` Sets the value of the objectType property.
`void`	`setOptions(RetrieveOptions value)` Sets the value of the options property.
`void`	`setQueryAllAccounts(Boolean value)` Sets the value of the queryAllAccounts property.
`void`	`setRepeatLastResult(Boolean value)` Sets the value of the repeatLastResult property.
`void`	`setRetrieveAllSinceLastBatch(Boolean value)` Sets the value of the retrieveAllSinceLastBatch property.
`void`	`setRetrieves(RetrieveRequest.Retrieves value)` Sets the value of the retrieves property.
`String`	`toString()` Generates a String representation of the contents of this type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - clientIDs
```
protected List<ClientID> clientIDs
```
  - objectType
```
protected String objectType
```
  - properties
```
protected List<String> properties
```
  - filter
```
protected FilterPart filter
```
  - respondTo
```
protected List<AsyncResponse> respondTo
```
  - partnerProperties
```
protected List<APIProperty> partnerProperties
```
  - continueRequest
```
protected String continueRequest
```
  - queryAllAccounts
```
protected Boolean queryAllAccounts
```
  - retrieveAllSinceLastBatch
```
protected Boolean retrieveAllSinceLastBatch
```
  - repeatLastResult
```
protected Boolean repeatLastResult
```
  - retrieves
```
protected RetrieveRequest.Retrieves retrieves
```
  - options
```
protected RetrieveOptions options
```
- Constructor Detail
  - RetrieveRequest
```
public RetrieveRequest()
```
- Method Detail
  - getClientIDs
```
public List<ClientID> getClientIDs()
```
    Gets the value of the clientIDs property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the clientIDs property.
    For example, to add a new item, do as follows:
```
    getClientIDs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ClientID
  - getObjectType
```
public String getObjectType()
```
    Gets the value of the objectType property.
    
    Returns:
    
    possible object is String
  - setObjectType
```
public void setObjectType(String value)
```
    Sets the value of the objectType property.
    
    Parameters:
    
    value - allowed object is String
  - getProperties
```
public List<String> getProperties()
```
    Gets the value of the properties property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the properties property.
    For example, to add a new item, do as follows:
```
    getProperties().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getFilter
```
public FilterPart getFilter()
```
    Gets the value of the filter property.
    
    Returns:
    
    possible object is FilterPart
  - setFilter
```
public void setFilter(FilterPart value)
```
    Sets the value of the filter property.
    
    Parameters:
    
    value - allowed object is FilterPart
  - getRespondTo
```
public List<AsyncResponse> getRespondTo()
```
    Gets the value of the respondTo property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the respondTo property.
    For example, to add a new item, do as follows:
```
    getRespondTo().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AsyncResponse
  - getPartnerProperties
```
public List<APIProperty> getPartnerProperties()
```
    Gets the value of the partnerProperties property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the partnerProperties property.
    For example, to add a new item, do as follows:
```
    getPartnerProperties().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list APIProperty
  - getContinueRequest
```
public String getContinueRequest()
```
    Gets the value of the continueRequest property.
    
    Returns:
    
    possible object is String
  - setContinueRequest
```
public void setContinueRequest(String value)
```
    Sets the value of the continueRequest property.
    
    Parameters:
    
    value - allowed object is String
  - getQueryAllAccounts
```
public Boolean getQueryAllAccounts()
```
    Gets the value of the queryAllAccounts property.
    
    Returns:
    
    possible object is Boolean
  - setQueryAllAccounts
```
public void setQueryAllAccounts(Boolean value)
```
    Sets the value of the queryAllAccounts property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getRetrieveAllSinceLastBatch
```
public Boolean getRetrieveAllSinceLastBatch()
```
    Gets the value of the retrieveAllSinceLastBatch property.
    
    Returns:
    
    possible object is Boolean
  - setRetrieveAllSinceLastBatch
```
public void setRetrieveAllSinceLastBatch(Boolean value)
```
    Sets the value of the retrieveAllSinceLastBatch property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getRepeatLastResult
```
public Boolean getRepeatLastResult()
```
    Gets the value of the repeatLastResult property.
    
    Returns:
    
    possible object is Boolean
  - setRepeatLastResult
```
public void setRepeatLastResult(Boolean value)
```
    Sets the value of the repeatLastResult property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getRetrieves
```
public RetrieveRequest.Retrieves getRetrieves()
```
    Gets the value of the retrieves property.
    
    Returns:
    
    possible object is RetrieveRequest.Retrieves
  - setRetrieves
```
public void setRetrieves(RetrieveRequest.Retrieves value)
```
    Sets the value of the retrieves property.
    
    Parameters:
    
    value - allowed object is RetrieveRequest.Retrieves
  - getOptions
```
public RetrieveOptions getOptions()
```
    Gets the value of the options property.
    
    Returns:
    
    possible object is RetrieveOptions
  - setOptions
```
public void setOptions(RetrieveOptions value)
```
    Sets the value of the options property.
    
    Parameters:
    
    value - allowed object is RetrieveOptions
  - toString
```
public String toString()
```
    Generates a String representation of the contents of this type. This is an extension method, produced by the 'ts' xjc plugin
    
    Overrides:
    
    toString in class Object

Class RetrieveRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

clientIDs

objectType

properties

filter

respondTo

partnerProperties

continueRequest

queryAllAccounts

retrieveAllSinceLastBatch

repeatLastResult

retrieves

options

Constructor Detail

RetrieveRequest

Method Detail

getClientIDs

getObjectType

setObjectType

getProperties

getFilter

setFilter

getRespondTo

getPartnerProperties

getContinueRequest

setContinueRequest

getQueryAllAccounts

setQueryAllAccounts

getRetrieveAllSinceLastBatch

setRetrieveAllSinceLastBatch

getRepeatLastResult

setRepeatLastResult

getRetrieves

setRetrieves

getOptions

setOptions

toString