com.ibm.streams.management.resource

Class ResourceSpecification

java.lang.Object

com.ibm.streams.management.resource.ResourceSpecification

public class ResourceSpecification
extends java.lang.Object

ResourceSpecification contains information for specifying how resources are chosen to be added to an instance for the purpose of running instance services and jobs.

See Also:

InstanceMXBean.addResourceSpecification(ResourceSpecification, String)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IBM_COPYRIGHT

Constructor Summary

Constructors

Constructor and Description
ResourceSpecification(int resourceCount) Constructs a ResourceSpecification object identifying the number of resources to add to an instance.
ResourceSpecification(int resourceCount, java.util.Set<java.lang.String> requiredResourceTags) Constructs a ResourceSpecification object identifying the number of resources to add to an instance as well as the resource tags the resources are required to have.
ResourceSpecification(int resourceCount, java.util.Set<java.lang.String> requiredResourceTags, boolean resourcesExclusiveToInstance) Constructs a ResourceSpecification object identifying the number of resources to add to an instance as well as the resource tags the resources are required to have and whether the resources are not required to be allocated exclusively to the instance to which this resource specification is assigned.
ResourceSpecification(int resourceCount, java.util.Set<java.lang.String> requiredResourceTags, boolean resourcesExclusiveToInstance, java.util.Set<java.lang.String> restrictedResourceTags) Constructs a ResourceSpecification object identifying the number of resources to add to an instance as well as information about the resource tags the resources are required to have and whether the resources are not required to be allocated exclusively to the instance to which this resource specification is assigned.
ResourceSpecification(java.lang.String id, int resourceCount, java.util.Set<java.lang.String> requiredResourceTags, boolean resourcesExclusiveToInstance) Constructs a ResourceSpecification object identifying an existing resource specification.
ResourceSpecification(java.lang.String id, int resourceCount, java.util.Set<java.lang.String> requiredResourceTags, boolean resourcesExclusiveToInstance, java.util.Set<java.lang.String> restrictedResourceTags) Constructs a ResourceSpecification object identifying an existing resource specification.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the unique identifier for the resource specification or null if an identifier was not set.
java.util.Set<java.lang.String>	getRequiredResourceTags() Returns the set of resource tags the added resources must have before being added to the instance.
int	getResourceCount() Returns the number of resources to add to the instance.
boolean	getResourcesExclusiveToInstance() Indicates whether the resources must be added exclusively for the instance.
java.util.Set<java.lang.String>	getRestrictedResourceTags() Returns the set of resource tags the added resources must have before being added to the instance.

Methods inherited from class java.lang.Object

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

Field Detail

IBM_COPYRIGHT

public static final java.lang.String IBM_COPYRIGHT

See Also:

Constant Field Values

Constructor Detail

ResourceSpecification

@ConstructorProperties(value="resourceCount")
public ResourceSpecification(int resourceCount)

Constructs a ResourceSpecification object identifying the number of resources to add to an instance. The resources are not required to have any resource tags and the resources do not need to be allocated exclusively to the instance to which this resource specification is assigned.

Note: the id property of this object is null. This constructor is suitable to create an object for use on an addResourceSpecification call.

Parameters:

resourceCount - identifies the number of resources to add to the instance.

See Also:

ResourceTag

ResourceSpecification

@ConstructorProperties(value={"resourceCount","requiredResourceTags"})
public ResourceSpecification(int resourceCount,
                                                                                                    java.util.Set<java.lang.String> requiredResourceTags)

Constructs a ResourceSpecification object identifying the number of resources to add to an instance as well as the resource tags the resources are required to have. The resources are not required to be allocated exclusively to the instance to which this resource specification is assigned.

Note: the id property of this object is null. This constructor is suitable to create an object for use on an addResourceSpecification call.

Parameters:

resourceCount - identifies the number of resources to add to the instance.

requiredResourceTags - specifies the set of resource tags the resources to add to the instance are required to have.

See Also:

ResourceTag

ResourceSpecification

@ConstructorProperties(value={"resourceCount","requiredResourceTags","resourcesExclusiveToInstance"})
public ResourceSpecification(int resourceCount,
                                                                                                                                   java.util.Set<java.lang.String> requiredResourceTags,
                                                                                                                                   boolean resourcesExclusiveToInstance)

Constructs a ResourceSpecification object identifying the number of resources to add to an instance as well as the resource tags the resources are required to have and whether the resources are not required to be allocated exclusively to the instance to which this resource specification is assigned.

Note: the id property of this object is null. This constructor is suitable to create an object for use on an addResourceSpecification call.

Parameters:

resourceCount - identifies the number of resources to add to the instance.

requiredResourceTags - specifies the set of resource tags the resources to add to the instance are required to have.

resourcesExclusiveToInstance - indicates whether the resources need to be allocated exclusively to the instance.

See Also:

ResourceTag

ResourceSpecification

@ConstructorProperties(value={"resourceCount","requiredResourceTags","resourcesExclusiveToInstance","restrictedResourceTags"})
public ResourceSpecification(int resourceCount,
                                                                                                                                                            java.util.Set<java.lang.String> requiredResourceTags,
                                                                                                                                                            boolean resourcesExclusiveToInstance,
                                                                                                                                                            java.util.Set<java.lang.String> restrictedResourceTags)

Constructs a ResourceSpecification object identifying the number of resources to add to an instance as well as information about the resource tags the resources are required to have and whether the resources are not required to be allocated exclusively to the instance to which this resource specification is assigned.

Note: the id property of this object is null. This constructor is suitable to create an object for use on an addResourceSpecification call.

Parameters:

resourceCount - identifies the number of resources to add to the instance.

requiredResourceTags - specifies the set of resource tags the resources to add to the instance are required to have.

resourcesExclusiveToInstance - indicates whether the resources need to be allocated exclusively to the instance.

restrictedResourceTags - identifies all or a subset of the resource tags specified by the requiredResourceTags parameter. This subset specifies the set of resource tags the resources to add must have specified as restricted resource tags. Resources to add must not have any other restricted tags.

See Also:

ResourceTag, com.ibm.streams.management.resource.ResourceMXBean.getRestrictedTags(), com.ibm.streams.management.resource.StreamsHostResourceManagerMXBean.restrictDomainHost(String, String, boolean)

ResourceSpecification

@ConstructorProperties(value={"id","resourceCount","requiredResourceTags","resourcesExclusiveToInstance"})
public ResourceSpecification(java.lang.String id,
                                                                                                                                        int resourceCount,
                                                                                                                                        java.util.Set<java.lang.String> requiredResourceTags,
                                                                                                                                        boolean resourcesExclusiveToInstance)

Constructs a ResourceSpecification object identifying an existing resource specification. This constructor is used to return values on a getResourceSpecifications call. It is also suitable to specify new resource specification values on a changeResourceSpecification call.

Parameters:

id - specifies the unique identifier for resource specification. Identifiers are unique within an instance.

resourceCount - identifies the number of resources to add to the instance.

requiredResourceTags - specifies the set of resource tags the resources to add to the instance are required to have.

resourcesExclusiveToInstance - indicates whether the resources need to be allocated exclusively to the instance.

See Also:

ResourceTag

ResourceSpecification

@ConstructorProperties(value={"id","resourceCount","requiredResourceTags","resourcesExclusiveToInstance","restrictedResourceTags"})
public ResourceSpecification(java.lang.String id,
                                                                                                                                                                 int resourceCount,
                                                                                                                                                                 java.util.Set<java.lang.String> requiredResourceTags,
                                                                                                                                                                 boolean resourcesExclusiveToInstance,
                                                                                                                                                                 java.util.Set<java.lang.String> restrictedResourceTags)

Constructs a ResourceSpecification object identifying an existing resource specification. This constructor is used to return values on a getResourceSpecifications call. It is also suitable to specify new resource specification values on a changeResourceSpecification call.

Parameters:

id - specifies the unique identifier for resource specification. Identifiers are unique within an instance.

resourceCount - identifies the number of resources to add to the instance.

requiredResourceTags - specifies the set of resource tags the resources to add to the instance are required to have.

resourcesExclusiveToInstance - indicates whether the resources need to be allocated exclusively to the instance.

restrictedResourceTags - identifies all or a subset of the resource tags specified by the requiredResourceTags parameter. This subset specifies the set of resource tags the resources to add must have specified as restricted resource tags. Resources to add must not have any other restricted tags.

See Also:

ResourceTag, com.ibm.streams.management.resource.ResourceMXBean.getRestrictedTags(), com.ibm.streams.management.resource.StreamsHostResourceManagerMXBean.restrictDomainHost(String, String, boolean)

Method Detail

getId

public java.lang.String getId()

Returns the unique identifier for the resource specification or null if an identifier was not set.

Returns:

resource specification identifier.

getResourceCount

public int getResourceCount()

Returns the number of resources to add to the instance.

Returns:

the additional resource count.

getRequiredResourceTags

public java.util.Set<java.lang.String> getRequiredResourceTags()

Returns the set of resource tags the added resources must have before being added to the instance.

Returns:

the required resource tags of the added resources.

getResourcesExclusiveToInstance

public boolean getResourcesExclusiveToInstance()

Indicates whether the resources must be added exclusively for the instance.

Returns:

the exclusive resource indicator.

getRestrictedResourceTags

public java.util.Set<java.lang.String> getRestrictedResourceTags()

Returns the set of resource tags the added resources must have before being added to the instance.

Returns:

the required resource tags of the added resources.