Package com.softlayer.api.service.container.search

Class ObjectType

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.container.search.ObjectType

@ApiType("SoftLayer_Container_Search_ObjectType")
public class ObjectType
extends Entity

This data type is a container that stores information about a single indexed object type. Object type information can be used for discovery of searchable data and for creation or validation of object index search strings. Each of these containers holds a collection of [[SoftLayer_Container_Search_ObjectType_Property (type)|SoftLayer_Container_Search_ObjectType_Property]] objects, specifying which object properties are exposed for the current user. Refer to the the documentation for the [[SoftLayer_Search/search|search()]] method for information on using object types in search strings.

See Also:

SoftLayer_Container_Search_ObjectType

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObjectType.Mask

Field Summary

Fields

Modifier and Type	Field	Description
protected String	name	Name of object type.
protected boolean	nameSpecified
protected List<Property>	properties	A collection of [[SoftLayer_Container_Search_ObjectType_Property|object properties]].
protected boolean	propertiesSpecified

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
ObjectType()

Method Summary

Modifier and Type	Method	Description
String	getName()
List<Property>	getProperties()
boolean	isNameSpecified()
boolean	isPropertiesSpecified()
void	setName(String name)
void	unsetName()
void	unsetProperties()

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

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

Field Details

name

@ApiProperty(canBeNullOrNotSet=true)
protected String name

Name of object type.

nameSpecified

protected boolean nameSpecified

properties

@ApiProperty(canBeNullOrNotSet=true)
protected List<Property> properties

A collection of [[SoftLayer_Container_Search_ObjectType_Property|object properties]].

propertiesSpecified

protected boolean propertiesSpecified

Constructor Details

ObjectType

public ObjectType()

Method Details

getName

public String getName()

setName

public void setName(String name)

isNameSpecified

public boolean isNameSpecified()

unsetName

public void unsetName()

getProperties

public List<Property> getProperties()

isPropertiesSpecified

public boolean isPropertiesSpecified()

unsetProperties

public void unsetProperties()