org.apache.ambari.server.api.resources

Class SubResourceDefinition

java.lang.Object

org.apache.ambari.server.api.resources.SubResourceDefinition

public class SubResourceDefinition
extends Object

Definition of a sub-resource. Defines a resource instance that is added to another resource as a sub-resource.

Constructor Summary

Constructors

Constructor and Description
SubResourceDefinition(Resource.Type type) Constructor.
SubResourceDefinition(Resource.Type type, Set<Resource.Type> setForeignKeys, boolean isCollection) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<Resource.Type>	getAdditionalForeignKeys() Get the set of additional foreign key properties that are included in the resource by default.
Resource.Type	getType() Obtain the sub-resource type.
boolean	isCollection() Whether the sub-resource is a collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubResourceDefinition

public SubResourceDefinition(Resource.Type type)

Constructor. Simple constructor which uses default state for everything except resource type.

Parameters:

type - resource type

SubResourceDefinition

public SubResourceDefinition(Resource.Type type,
                             Set<Resource.Type> setForeignKeys,
                             boolean isCollection)

Constructor. This constructor allows all state to be set.

Parameters:

type - resource type

setForeignKeys - set of additional foreign keys to include in resource by default

isCollection - whether the sub-resource is a collection

Method Detail

getType

public Resource.Type getType()

Obtain the sub-resource type.

Returns:

the sub-resource type

getAdditionalForeignKeys

public Set<Resource.Type> getAdditionalForeignKeys()

Get the set of additional foreign key properties that are included in the resource by default.

Returns:

set of additional foreign key properties

isCollection

public boolean isCollection()

Whether the sub-resource is a collection.

Returns:

true if a collection, false if an instance