APIObject (Salesforce Marketing Cloud Java SDK 1.2.1 API)

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

Direct Known Subclasses:

Account, AccountPrivateLabel, AccountUser, AsyncRequestResult, Attribute, AttributeSet, AudienceItem, Authentication, AutomationActivity, AutomationInstances, AutomationNotification, AutomationTask, BaseMOKeyword, Brand, BrandTag, BusinessRule, ContactEvent, ContentArea, ContentValidation, DataExtension, DataExtensionTemplate, DataFolder, DeliveryProfile, Email, ExtractTemplate, FileTransferLocation, FileTrigger, FileTriggerTypeLastPull, FilterDefinition, GlobalUnsubscribeCategory, Group, ImportDefinitionFieldMap, ImportFileDestination, ImportResultsSummary, IntegrationProfile, IntegrationProfileDefinition, InteractionBaseObject, LandingPage, Layout, Link, LinkSend, List, ListAttribute, ListAttributeRestrictedValue, ListSend, ListSubscriber, Locale, Message, MessagingConfiguration, MessagingVendorKind, ObjectExtension, Permission, PermissionSet, PlatformApplication, PlatformApplicationPackage, Portfolio, PrivateDomain, PrivateDomainSet, PrivateIP, ProgramManifestTemplate, PropertyDefinition, Publication, PublicationSubscriber, PublicKeyManagement, ReplyMailManagementConfiguration, ResourceSpecification, ResultItem, ResultMessage, Role, ScheduleDefinition, SecurityObject, Send, SendAdditionalAttribute, SendClassification, SenderProfile, SendSummary, SMSMOEvent, SMSMTEvent, SMSSharedKeyword, SMSTriggeredSend, SsoIdentity, Subscriber, SubscriberList, SubscriberSendResult, SuppressionListContext, SuppressionListData, SuppressionListDefinition, Template, TimeZone, TrackingEvent, TrackingUser, TriggeredSend, TriggeredSendSummary, UserAccess, VoiceTriggeredSend
```
public class APIObject
extends Object
```
Java class for APIObject complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="APIObject">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Client" type="{http://exacttarget.com/wsdl/partnerAPI}ClientID" minOccurs="0"/>
         <element name="PartnerKey" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="PartnerProperties" type="{http://exacttarget.com/wsdl/partnerAPI}APIProperty" maxOccurs="unbounded" minOccurs="0"/>
         <element name="CreatedDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="ModifiedDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="ID" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="ObjectID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CustomerKey" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Owner" type="{http://exacttarget.com/wsdl/partnerAPI}Owner" minOccurs="0"/>
         <element name="CorrelationID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ObjectState" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected ClientID`	`client`
`protected String`	`correlationID`
`protected Date`	`createdDate`
`protected String`	`customerKey`
`protected Integer`	`id`
`protected Date`	`modifiedDate`
`protected String`	`objectID`
`protected String`	`objectState`
`protected Owner`	`owner`
`protected String`	`partnerKey`
`protected List<APIProperty>`	`partnerProperties`

Constructor Summary

Constructors
Constructor and Description

APIObject()

Constructors
Constructor and Description
`APIObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientID`	`getClient()` Gets the value of the client property.
`String`	`getCorrelationID()` Gets the value of the correlationID property.
`Date`	`getCreatedDate()` Gets the value of the createdDate property.
`String`	`getCustomerKey()` Gets the value of the customerKey property.
`Integer`	`getId()` Gets the value of the id property.
`Date`	`getModifiedDate()` Gets the value of the modifiedDate property.
`String`	`getObjectID()` Gets the value of the objectID property.
`String`	`getObjectState()` Gets the value of the objectState property.
`Owner`	`getOwner()` Gets the value of the owner property.
`String`	`getPartnerKey()` Gets the value of the partnerKey property.
`List<APIProperty>`	`getPartnerProperties()` Gets the value of the partnerProperties property.
`void`	`setClient(ClientID value)` Sets the value of the client property.
`void`	`setCorrelationID(String value)` Sets the value of the correlationID property.
`void`	`setCreatedDate(Date value)` Sets the value of the createdDate property.
`void`	`setCustomerKey(String value)` Sets the value of the customerKey property.
`void`	`setId(Integer value)` Sets the value of the id property.
`void`	`setModifiedDate(Date value)` Sets the value of the modifiedDate property.
`void`	`setObjectID(String value)` Sets the value of the objectID property.
`void`	`setObjectState(String value)` Sets the value of the objectState property.
`void`	`setOwner(Owner value)` Sets the value of the owner property.
`void`	`setPartnerKey(String value)` Sets the value of the partnerKey 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
  - client
```
protected ClientID client
```
  - partnerKey
```
protected String partnerKey
```
  - partnerProperties
```
protected List<APIProperty> partnerProperties
```
  - createdDate
```
protected Date createdDate
```
  - modifiedDate
```
protected Date modifiedDate
```
  - id
```
protected Integer id
```
  - objectID
```
protected String objectID
```
  - customerKey
```
protected String customerKey
```
  - owner
```
protected Owner owner
```
  - correlationID
```
protected String correlationID
```
  - objectState
```
protected String objectState
```
- Constructor Detail
  - APIObject
```
public APIObject()
```
- Method Detail
  - getClient
```
public ClientID getClient()
```
    Gets the value of the client property.
    
    Returns:
    
    possible object is ClientID
  - setClient
```
public void setClient(ClientID value)
```
    Sets the value of the client property.
    
    Parameters:
    
    value - allowed object is ClientID
  - getPartnerKey
```
public String getPartnerKey()
```
    Gets the value of the partnerKey property.
    
    Returns:
    
    possible object is String
  - setPartnerKey
```
public void setPartnerKey(String value)
```
    Sets the value of the partnerKey property.
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getCreatedDate
```
public Date getCreatedDate()
```
    Gets the value of the createdDate property.
    
    Returns:
    
    possible object is String
  - setCreatedDate
```
public void setCreatedDate(Date value)
```
    Sets the value of the createdDate property.
    
    Parameters:
    
    value - allowed object is String
  - getModifiedDate
```
public Date getModifiedDate()
```
    Gets the value of the modifiedDate property.
    
    Returns:
    
    possible object is String
  - setModifiedDate
```
public void setModifiedDate(Date value)
```
    Sets the value of the modifiedDate property.
    
    Parameters:
    
    value - allowed object is String
  - getId
```
public Integer getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is Integer
  - setId
```
public void setId(Integer value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is Integer
  - getObjectID
```
public String getObjectID()
```
    Gets the value of the objectID property.
    
    Returns:
    
    possible object is String
  - setObjectID
```
public void setObjectID(String value)
```
    Sets the value of the objectID property.
    
    Parameters:
    
    value - allowed object is String
  - getCustomerKey
```
public String getCustomerKey()
```
    Gets the value of the customerKey property.
    
    Returns:
    
    possible object is String
  - setCustomerKey
```
public void setCustomerKey(String value)
```
    Sets the value of the customerKey property.
    
    Parameters:
    
    value - allowed object is String
  - getOwner
```
public Owner getOwner()
```
    Gets the value of the owner property.
    
    Returns:
    
    possible object is Owner
  - setOwner
```
public void setOwner(Owner value)
```
    Sets the value of the owner property.
    
    Parameters:
    
    value - allowed object is Owner
  - getCorrelationID
```
public String getCorrelationID()
```
    Gets the value of the correlationID property.
    
    Returns:
    
    possible object is String
  - setCorrelationID
```
public void setCorrelationID(String value)
```
    Sets the value of the correlationID property.
    
    Parameters:
    
    value - allowed object is String
  - getObjectState
```
public String getObjectState()
```
    Gets the value of the objectState property.
    
    Returns:
    
    possible object is String
  - setObjectState
```
public void setObjectState(String value)
```
    Sets the value of the objectState property.
    
    Parameters:
    
    value - allowed object is String
  - 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 APIObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

client

partnerKey

partnerProperties

createdDate

modifiedDate

id

objectID

customerKey

owner

correlationID

objectState

Constructor Detail

APIObject

Method Detail

getClient

setClient

getPartnerKey

setPartnerKey

getPartnerProperties

getCreatedDate

setCreatedDate

getModifiedDate

setModifiedDate

getId

setId

getObjectID

setObjectID

getCustomerKey

setCustomerKey

getOwner

setOwner

getCorrelationID

setCorrelationID

getObjectState

setObjectState

toString