com.ibm.streams.management.instance
Enum InstanceMXBean.PropertyId
- java.lang.Object
-
- java.lang.Enum<InstanceMXBean.PropertyId>
-
- com.ibm.streams.management.instance.InstanceMXBean.PropertyId
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable<InstanceMXBean.PropertyId>
- Enclosing interface:
- InstanceMXBean
public static enum InstanceMXBean.PropertyId extends java.lang.Enum<InstanceMXBean.PropertyId>
Enumeration for the instance configuration properties.
-
-
Enum Constant Summary
Enum Constants Enum Constant and Description APP_INITIAL_JVM_SIZESpecifies the initial amount of memory, in megabytes, to allocate to the Java environment for the application deployment service.APP_MAXIMUM_JVM_SIZESpecifies the maximum amount of memory, in megabytes, to allocate to the Java environment for the application deployment service.APP_PORTSpecifies the SSL port number for the application deployment service.APP_SSL_OPTIONSpecifies the cryptographic protocols to support for application deployment service connections.APP_START_TIMEOUTSpecifies the period, in seconds, that Streams waits for the application deployment service to start.APP_STOP_TIMEOUTSpecifies the period, in seconds, that Streams waits for the application deployment service to stop.APP_TRACE_LEVELSpecifies the trace level for the application deployment service.APPLICATION_BUNDLES_PATHSpecifies the directory path to the location where the application bundle files are stored.APPLICATION_CURRENT_WORKING_PATHSpecifies the current working directory to be used by streams processing applications for file operations which do not reference the job'sdata path.APPLICATION_NETWORKSpecifies the value to use for the instance's application network.APPLICATION_ON_MANAGEMENT_RESOURCE_ALLOWEDSpecifies whether IBM Streams should allow applications to run on management resources when not explicitly tagged as an application resource.APPLICATION_RESOURCE_ALLOCATION_MODESpecifies the behavior for how application resources are allocated to jobs within an instance.APPLICATION_UMASKSpecifies the value to use for the instance's application processing element's process umask (for example, 022).CAN_SET_PE_OS_CAPABILITIESSpecifies whether processing elements for a job within the instance can be set with operating system capabilities.CHECKPOINT_REPOSITORYSpecifies the repository that is used to store application checkpoint information.CHECKPOINT_REPOSITORY_CONFIGURATIONSpecifies the configuration information for the repository that is used to store checkpoint information.CONFIGURATION_VERSIONSpecifies the version of the instance configuration data.CREATION_TIMESpecifies the time (in milliseconds since the epoch) when the instance was created.CREATION_USERSpecifies the user who created the instance.DYNAMIC_RESOURCE_ALLOCATION_ENABLEDSpecifies whether Streams should dynamically allocate resources for the instance.DYNAMIC_THREADING_ELASTICSpecifies whether a PE should dynamically adapt the number of threads used for dynamic threading in the PE, based on performance.DYNAMIC_THREADING_THREAD_COUNTSpecifies the initial number of threads used for dynamic threading in a PE.FUSION_SCHEMESpecifies the scheme used to determine how to fuse an application's operators into PEs.GOVERNANCE_ENABLEDSpecifies whether governance is enabled for the instance.GOVERNANCE_URLSpecifies the URL of the service where application governance information is sent.HC_METRIC_COLLECTION_INTERVALSpecifies the period, in seconds, that the host controller service waits between metric collections from the processing elements.HC_PEC_START_TIMEOUTSpecifies the maximum period, in seconds, that the host controller service waits for a processing element container (PEC) to start.HC_PEC_STOP_TIMEOUTSpecifies the maximum period, in seconds, that the host controller service waits for a processing element container (PEC) to stop.HC_PEC_TRACE_LEVELSpecifies the trace level for processing element containers (PECs).HC_START_TIMEOUTSpecifies the period, in seconds, that Streams waits for the host controller service to start.HC_TRACE_LEVELSpecifies the trace level for the host controller service.HIGH_AVAILABILITY_COUNTSpecifies the total number of each Streams instance management service.JOB_RESOURCE_SHARINGSpecifies if and how jobs can run on resources where other jobs are running.JVM_SIZE_COMPUTATION_ENABLEDSpecifies whether Streams should calculate the maximum amount of memory to allocate to the Java environment when starting Streams services if a maximum value is not configured.MANAGEMENT_RESOURCE_ALLOCATION_TAGSIdentifies the set of tags to include on an allocation request for a resource used to run instance services.NETWORK_LLM_INFINIBAND_INTERFACE_NAMESpecifies the InfiniBand interface to be used by LLM when using the LLM InfiniBand transport (LLM_RUM_IB).NETWORK_LLM_INPUT_PORT_CONFIGURATION_FILEWhen you use the LLM transport (LL_RUM_TCP and LLM_RUM_IB), this property specifies the location of a configuration file to set advanced configuration parameters for a PE's input ports.NETWORK_LLM_OUTPUT_PORT_CONFIGURATION_FILEWhen you use the LLM transport (LL_RUM_TCP and LLM_RUM_IB), this property specifies the location of a configuration file to set advanced configuration parameters for a PE's output ports.NETWORK_LLM_PACKET_SIZESpecifies the LLM packet size in bytes when using the LLM transport (LLM_RUM_TCP or LLM_RUM_IB).PLACEMENT_SCHEMESpecifies the scheme used to determine how to place PEs on resources.PRELOAD_APPLICATION_BUNDLESSpecifies whether the application bundle file that is associated with a submitted job is preloaded on every resource in the instance to which the job is submitted.PROPOSED_OPERATORS_PER_RESOURCESpecifies the proposed number of operators to be placed on each resource for a job.REPOSITORY_CONFIGURATION_APPLICATION_CACHESpecifies the configuration information for the repository used to cache application bundles.RESOURCE_CPU_USAGE_LOWER_THRESHOLDSpecifies the CPU usage percentage below which a resource is considered underutilized.RESOURCE_CPU_USAGE_UPPER_THRESHOLDSpecifies the CPU usage percentage above which a resource is considered overloaded.RESOURCE_LOAD_PROTECTION_ENABLEDSpecifies whether resources with loads higher than the resource load threshold are eligible for placement of processing elements from new job submissions.RESOURCE_LOAD_THRESHOLDSpecifies the resource load threshold value, which is used to determine whether to treat a resource as being fully loaded.RESOURCE_MEMORY_USAGE_LOWER_THRESHOLDSpecifies the memory usage percentage below which a resource is considered underutilized.RESOURCE_MEMORY_USAGE_UPPER_THRESHOLDSpecifies the memory usage percentage above which a resource is considered overloaded.RESOURCE_NETWORK_BANDWIDTH_USAGE_LOWER_THRESHOLDSpecifies the network bandwidth usage percentage below which a resource is considered underutilized.RESOURCE_NETWORK_BANDWIDTH_USAGE_UPPER_THRESHOLDSpecifies the network bandwidth usage percentage above which a resource is considered overloaded.RESTART_PES_ON_RESOURCE_FAILURESpecifies whether processing elements are restarted after a resource failure.RESTART_PES_ON_RESOURCE_FAILURE_WAIT_TIMESpecifies the period, in seconds, that Streams waits before it restarts processing elements when a resource fails.RUN_AS_USERSpecifies the user Streams instance services and user job's processing elements run as.SAM_JMX_HTTP_PORTSpecifies the HTTPS port number to use for large data transfers.SAM_JMX_PORTSpecifies the SSL port number for the management support within the application management service.SAM_PORTSpecifies the SSL port number for the application management service.SAM_SSL_OPTIONSpecifies the cryptographic protocols to support for application management service connections.SAM_START_TIMEOUTSpecifies the period, in seconds, that Streams waits for the application manager service to start.SAM_STOP_TIMEOUTSpecifies the period, in seconds, that Streams waits for the application manager service to stop.SAM_TRACE_LEVELSpecifies the trace level for the application manager service.SCH_START_TIMEOUTSpecifies the period, in seconds, that Streams waits for the scheduler service to start.SCH_STOP_TIMEOUTSpecifies the period, in seconds, that Streams waits for the scheduler service to stop.SCH_TRACE_LEVELSpecifies the trace level for the scheduler service.SERVICE_CONTAINER_INITIAL_JVM_SIZESpecifies the initial amount of memory to allocate to the Java environment used to run multiple instance services.SERVICE_CONTAINER_MAXIMUM_JVM_SIZESpecifies the maximum amount of memory to allocate to the Java environment used to run multiple instance services.SRM_PORTSpecifies the SSL port number for the application metrics service.SRM_SSL_OPTIONSpecifies the cryptographic protocols to support for application metrics service connections.SRM_START_TIMEOUTSpecifies the period, in seconds, that Streams waits for the application metrics service to start.SRM_STOP_TIMEOUTSpecifies the period, in seconds, that Streams waits for the application metrics service to stop.SRM_TRACE_LEVELSpecifies the trace level for the application metrics service.START_AS_VERSIONSpecifies the Streams installation version to use when starting the instance.THREADING_MODELSpecifies the model which determines how threads run operators in a PE.TRACE_DEFAULT_LEVELSpecifies the default trace level to use for debugging problems with Streams instance services.TRACE_MAXIMUM_FILE_COUNTSpecifies the maximum number of trace files to save per service.TRACE_MAXIMUM_FILE_SIZESpecifies the maximum size, in kilobytes, of trace files.TRANSPORT_SECURITY_TYPESpecifies the cryptographic protocol to use when transporting data between processing elements (PEs).VIEW_HTTP_PORTSpecifies the HTTPS port number to use to retrieve view data.VIEW_INITIAL_JVM_SIZESpecifies the initial amount of memory, in megabytes, to allocate to the Java environment for the view service.VIEW_MAXIMUM_JVM_SIZESpecifies the maximum amount of memory, in megabytes, to allocate to the Java environment for view service.VIEW_PORTSpecifies the SSL port number for the view service.VIEW_SSL_OPTIONSpecifies the cryptographic protocols to support for view service connections.VIEW_START_TIMEOUTSpecifies the period, in seconds, that Streams waits for the view service to start.VIEW_STOP_TIMEOUTSpecifies the period, in seconds, that Streams waits for the view service to stop.VIEW_TRACE_LEVELSpecifies the trace level for the view service.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static InstanceMXBean.PropertyIdfromString(java.lang.String id)Converts from a string representation of a property identifier to the corresponding enumeration value.java.lang.StringtoString()Converts the enumeration value to a string.static InstanceMXBean.PropertyIdvalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static InstanceMXBean.PropertyId[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CONFIGURATION_VERSION
public static final InstanceMXBean.PropertyId CONFIGURATION_VERSION
Specifies the version of the instance configuration data.
-
RESOURCE_LOAD_THRESHOLD
public static final InstanceMXBean.PropertyId RESOURCE_LOAD_THRESHOLD
Specifies the resource load threshold value, which is used to determine whether to treat a resource as being fully loaded. This value can be compared to standard Linux load metrics by multiplying the resource load average that is listed in /proc/loadavg by 100 and then dividing the result by the number of processors that are listed in the /proc/cpuinfo location. Resource load protection prevents new jobs from being deployed to resources that are over the threshold. Processing element (PE) restart recommendations also recommend restarting PEs that are on resources that are over the threshold. The default is 100. When you update this property value, the change only affects new job submissions.
-
RESOURCE_LOAD_PROTECTION_ENABLED
public static final InstanceMXBean.PropertyId RESOURCE_LOAD_PROTECTION_ENABLED
Specifies whether resources with loads higher than the resource load threshold are eligible for placement of processing elements from new job submissions. If the property value is true, those resources are not eligible. The default is false. When you update this property value, the change only affects new job submissions.
-
APPLICATION_NETWORK
public static final InstanceMXBean.PropertyId APPLICATION_NETWORK
Specifies the value to use for the instance's application network. The default behavior is to use the value specified byDomainMXBean.PropertyId#APPLICATION_NETWORK. When you update this property value, the change does not occur until the instance restarts.
-
APPLICATION_UMASK
public static final InstanceMXBean.PropertyId APPLICATION_UMASK
Specifies the value to use for the instance's application processing element's process umask (for example, 022). The default is to use the system default. When you update this property value, the change affects only new or restarted processing elements.
-
CREATION_USER
public static final InstanceMXBean.PropertyId CREATION_USER
Specifies the user who created the instance.
-
CREATION_TIME
public static final InstanceMXBean.PropertyId CREATION_TIME
Specifies the time (in milliseconds since the epoch) when the instance was created.
-
RUN_AS_USER
public static final InstanceMXBean.PropertyId RUN_AS_USER
Specifies the user Streams instance services and user job's processing elements run as. This property pertains only to environments where Streams is running as a system service. No user is set by default. When you update this property value, the change does not occur until the instance restarts.
-
CAN_SET_PE_OS_CAPABILITIES
public static final InstanceMXBean.PropertyId CAN_SET_PE_OS_CAPABILITIES
Specifies whether processing elements for a job within the instance can be set with operating system capabilities. This property pertains only to resources where the domain controller service is registered as a system service. The default is false. If the value of this property istrue, setting operating system capabilities is allowed. When you update this property value, the change does not occur until the instance restarts.
-
PRELOAD_APPLICATION_BUNDLES
public static final InstanceMXBean.PropertyId PRELOAD_APPLICATION_BUNDLES
Specifies whether the application bundle file that is associated with a submitted job is preloaded on every resource in the instance to which the job is submitted. If the value is false, the application bundle file is only loaded on the resources that are currently needed to run one or more of the processing elements for the job. The default is false.
-
APPLICATION_BUNDLES_PATH
public static final InstanceMXBean.PropertyId APPLICATION_BUNDLES_PATH
Specifies the directory path to the location where the application bundle files are stored. This property value is the root level directory that contains the application bundle files. More subdirectories are created as needed. The default behavior is to use the value that is specified byDomainMXBean.PropertyId.APPLICATION_BUNDLES_PATHWhen you update this property value, the change does not occur until the instance restarts.
-
APPLICATION_CURRENT_WORKING_PATH
public static final InstanceMXBean.PropertyId APPLICATION_CURRENT_WORKING_PATH
Specifies the current working directory to be used by streams processing applications for file operations which do not reference the job'sdata path. This directory is the root level directory that contains the Streams application data files. More subdirectories are created as needed. The default behavior is to use the value that is specified byDomainMXBean.PropertyId.APPLICATION_CURRENT_WORKING_PATHWhen you update this property value, the change does not occur until the instance restarts.
-
CHECKPOINT_REPOSITORY
public static final InstanceMXBean.PropertyId CHECKPOINT_REPOSITORY
Specifies the repository that is used to store application checkpoint information. The default behavior is to use the value that is specified byDomainMXBean.PropertyId CHECKPOINT_REPOSITORYSee the domain property description for more details. When you update this property value, the change does not occur until the instance restarts.
-
CHECKPOINT_REPOSITORY_CONFIGURATION
public static final InstanceMXBean.PropertyId CHECKPOINT_REPOSITORY_CONFIGURATION
Specifies the configuration information for the repository that is used to store checkpoint information. The default behavior is to use the value that is specified byDomainMXBean.PropertyId CHECKPOINT_REPOSITORY_CONFIGURATIONSee the domain property description for more details. When you update this property value, the change does not occur until the instance restarts.
-
REPOSITORY_CONFIGURATION_APPLICATION_CACHE
public static final InstanceMXBean.PropertyId REPOSITORY_CONFIGURATION_APPLICATION_CACHE
Specifies the configuration information for the repository used to cache application bundles. Application bundles are cached to provide application high availability. The default behavior is to use the value that is specified byDomainMXBean.PropertyId REPOSITORY_CONFIGURATIONSee the domain property description for more details. When you update this property value, the change does not occur until the instance restarts.
-
FUSION_SCHEME
public static final InstanceMXBean.PropertyId FUSION_SCHEME
Specifies the scheme used to determine how to fuse an application's operators into PEs. The default behavior is to use the value that is specified byDomainMXBean.PropertyId FUSION_SCHEMESee the domain property description for more details.
-
PLACEMENT_SCHEME
public static final InstanceMXBean.PropertyId PLACEMENT_SCHEME
Specifies the scheme used to determine how to place PEs on resources. The default behavior is to use the value that is specified byDomainMXBean.PropertyId PLACEMENT_SCHEMESee the domain property description for more details.
-
THREADING_MODEL
public static final InstanceMXBean.PropertyId THREADING_MODEL
Specifies the model which determines how threads run operators in a PE. The default behavior is to use the value that is specified byDomainMXBean.PropertyId THREADING_MODELSee the domain property description for more details.
-
DYNAMIC_THREADING_ELASTIC
public static final InstanceMXBean.PropertyId DYNAMIC_THREADING_ELASTIC
Specifies whether a PE should dynamically adapt the number of threads used for dynamic threading in the PE, based on performance. The default behavior is to use the value that is specified byDomainMXBean.PropertyId DYNAMIC_THREADING_ELASTICSee the domain property description for more details.
-
DYNAMIC_THREADING_THREAD_COUNT
public static final InstanceMXBean.PropertyId DYNAMIC_THREADING_THREAD_COUNT
Specifies the initial number of threads used for dynamic threading in a PE. The default behavior is to use the value that is specified byDomainMXBean.PropertyId DYNAMIC_THREADING_THREAD_COUNTSee the domain property description for more details.
-
START_AS_VERSION
public static final InstanceMXBean.PropertyId START_AS_VERSION
Specifies the Streams installation version to use when starting the instance. The specified version must be installed on the resource where the management API service is running and it must be within the same base installation path as the version used to start the domain; otherwise, the instance fails to start. The format of the version is v.r.m.f<.h> where v, r, m, f, and h are all numeric values identifying the version, release, modification, fix, and optional hot fix levels. The version must be 4.2.0.0 or newer. If this value is not set, the default behavior is start the instance using the same version as the operation used to start the instance.
-
TRANSPORT_SECURITY_TYPE
public static final InstanceMXBean.PropertyId TRANSPORT_SECURITY_TYPE
Specifies the cryptographic protocol to use when transporting data between processing elements (PEs). The default behavior is to use the value that is specified byDomainMXBean.PropertyId TRANSPORT_SECURITY_TYPESee the domain property description for more details. When you update this property value, the change does not occur until the instance restarts.
-
GOVERNANCE_ENABLED
public static final InstanceMXBean.PropertyId GOVERNANCE_ENABLED
Specifies whether governance is enabled for the instance. If this value is true, application governance information is sent to the governance service identified by the value of theGOVERNANCE_URLproperty. If there is no value set forGOVERNANCE_URL, no governance information is sent. The default behavior is to use the value that is specified byDomainMXBean.PropertyId GOVERNANCE_ENABLEDhttp://www.ibm.com/software/products/en/infosphere-information-governance-catalog
-
GOVERNANCE_URL
public static final InstanceMXBean.PropertyId GOVERNANCE_URL
Specifies the URL of the service where application governance information is sent. If the value of theGOVERNANCE_ENABLEDproperty isfalse, this property is ignored. The default behavior is to use the value that is specified byDomainMXBean.PropertyId GOVERNANCE_URL
-
APP_SSL_OPTION
public static final InstanceMXBean.PropertyId APP_SSL_OPTION
Specifies the cryptographic protocols to support for application deployment service connections.DomainServiceMXBean.SSLOptiondefines possible values. The default behavior is to use the value that is specified byDomainMXBean.PropertyId SSL_OPTIONSee the domain property description for more details. When you update this property value, the change does not occur until the instance restarts.
-
JVM_SIZE_COMPUTATION_ENABLED
public static final InstanceMXBean.PropertyId JVM_SIZE_COMPUTATION_ENABLED
Specifies whether Streams should calculate the maximum amount of memory to allocate to the Java environment when starting Streams services if a maximum value is not configured. If this value is false, the maximum amount of memory to allocate to the Java environment is determined by the Java environment at startup. The default behavior is to use the value that is specified byDomainMXBean.PropertyId JVM_SIZE_COMPUTATION_ENABLEDWhen you update this property value, the change does not occur until the instance restarts.
-
APPLICATION_ON_MANAGEMENT_RESOURCE_ALLOWED
public static final InstanceMXBean.PropertyId APPLICATION_ON_MANAGEMENT_RESOURCE_ALLOWED
Specifies whether IBM Streams should allow applications to run on management resources when not explicitly tagged as an application resource. The default behavior is that Streams will allow applications to run on management resources if there is no alternative.
-
DYNAMIC_RESOURCE_ALLOCATION_ENABLED
public static final InstanceMXBean.PropertyId DYNAMIC_RESOURCE_ALLOCATION_ENABLED
Specifies whether Streams should dynamically allocate resources for the instance. If this value is true, Streams will dynamically allocate resources for the instance. The default behavior is to use the value that is specified byDomainMXBean.PropertyId DYNAMIC_RESOURCE_ALLOCAITON_ENABLEDWhen you update this property value, the change does not occur until the instance restarts.
-
APPLICATION_RESOURCE_ALLOCATION_MODE
public static final InstanceMXBean.PropertyId APPLICATION_RESOURCE_ALLOCATION_MODE
Specifies the behavior for how application resources are allocated to jobs within an instance. The default behavior is to use the value that is specified byDomainMXBean.PropertyId APPLICATION_RESOURCE_ALLOCATION_MODESee the domain property description for more details.
-
JOB_RESOURCE_SHARING
public static final InstanceMXBean.PropertyId JOB_RESOURCE_SHARING
Specifies if and how jobs can run on resources where other jobs are running. This property only applies ifAPPLICATION_RESOURCE_ALLOCATION_MODEisJOB. The default behavior is to use the value that is specified byDomainMXBean.PropertyId JOB_RESOURCE_SHARINGSee the domain property description for more details.
-
PROPOSED_OPERATORS_PER_RESOURCE
public static final InstanceMXBean.PropertyId PROPOSED_OPERATORS_PER_RESOURCE
Specifies the proposed number of operators to be placed on each resource for a job. This property only applies ifAPPLICATION_RESOURCE_ALLOCATION_MODEisJOB. The default behavior is to use the value that is specified byDomainMXBean.PropertyId PROPOSED_OPERATORS_PER_RESOURCESee the domain property description for more details.
-
RESOURCE_CPU_USAGE_LOWER_THRESHOLD
public static final InstanceMXBean.PropertyId RESOURCE_CPU_USAGE_LOWER_THRESHOLD
Specifies the CPU usage percentage below which a resource is considered underutilized. This value is one factor considered when placing a PE on a resource. The default behavior is to use the value that is specified byDomainMXBean.PropertyId RESOURCE_CPU_USAGE_LOWER_THRESHOLDSee the domain property description for more details.
-
RESOURCE_CPU_USAGE_UPPER_THRESHOLD
public static final InstanceMXBean.PropertyId RESOURCE_CPU_USAGE_UPPER_THRESHOLD
Specifies the CPU usage percentage above which a resource is considered overloaded. This value is one factor considered when placing a PE on a resource. The default behavior is to use the value that is specified byDomainMXBean.PropertyId RESOURCE_CPU_USAGE_UPPER_THRESHOLDSee the domain property description for more details.
-
RESOURCE_MEMORY_USAGE_LOWER_THRESHOLD
public static final InstanceMXBean.PropertyId RESOURCE_MEMORY_USAGE_LOWER_THRESHOLD
Specifies the memory usage percentage below which a resource is considered underutilized. This value is one factor considered when placing a PE on a resource. The default behavior is to use the value that is specified byDomainMXBean.PropertyId RESOURCE_MEMORY_USAGE_LOWER_THRESHOLDSee the domain property description for more details.
-
RESOURCE_MEMORY_USAGE_UPPER_THRESHOLD
public static final InstanceMXBean.PropertyId RESOURCE_MEMORY_USAGE_UPPER_THRESHOLD
Specifies the memory usage percentage above which a resource is considered overloaded. This value is one factor considered when placing a PE on a resource. The default behavior is to use the value that is specified byDomainMXBean.PropertyId RESOURCE_MEMORY_USAGE_UPPER_THRESHOLDSee the domain property description for more details.
-
RESOURCE_NETWORK_BANDWIDTH_USAGE_LOWER_THRESHOLD
public static final InstanceMXBean.PropertyId RESOURCE_NETWORK_BANDWIDTH_USAGE_LOWER_THRESHOLD
Specifies the network bandwidth usage percentage below which a resource is considered underutilized. This value is one factor considered when placing a PE on a resource. The default behavior is to use the value that is specified byDomainMXBean.PropertyId RESOURCE_NETWORK_BANDWIDTH_USAGE_LOWER_THRESHOLDSee the domain property description for more details.
-
RESOURCE_NETWORK_BANDWIDTH_USAGE_UPPER_THRESHOLD
public static final InstanceMXBean.PropertyId RESOURCE_NETWORK_BANDWIDTH_USAGE_UPPER_THRESHOLD
Specifies the network bandwidth usage percentage above which a resource is considered overloaded. This value is one factor considered when placing a PE on a resource. The default behavior is to use the value that is specified byDomainMXBean.PropertyId RESOURCE_NETWORK_BANDWIDTH_USAGE_UPPER_THRESHOLDSee the domain property description for more details.
-
SAM_SSL_OPTION
public static final InstanceMXBean.PropertyId SAM_SSL_OPTION
Specifies the cryptographic protocols to support for application management service connections.DomainServiceMXBean.SSLOptiondefines possible values. The default behavior is to use the value that is specified byDomainMXBean.PropertyId SSL_OPTIONSee the domain property description for more details. When you update this property value, the change does not occur until the instance restarts.
-
SRM_SSL_OPTION
public static final InstanceMXBean.PropertyId SRM_SSL_OPTION
Specifies the cryptographic protocols to support for application metrics service connections.DomainServiceMXBean.SSLOptiondefines possible values. The default behavior is to use the value that is specified byDomainMXBean.PropertyId SSL_OPTIONSee the domain property description for more details. When you update this property value, the change does not occur until the instance restarts.
-
VIEW_SSL_OPTION
public static final InstanceMXBean.PropertyId VIEW_SSL_OPTION
Specifies the cryptographic protocols to support for view service connections.DomainServiceMXBean.SSLOptiondefines possible values. The default behavior is to use the value that is specified byDomainMXBean.PropertyId SSL_OPTIONSee the domain property description for more details. When you update this property value, the change does not occur until the instance restarts.
-
MANAGEMENT_RESOURCE_ALLOCATION_TAGS
public static final InstanceMXBean.PropertyId MANAGEMENT_RESOURCE_ALLOCATION_TAGS
Identifies the set of tags to include on an allocation request for a resource used to run instance services. These tags are used to control which services run on the same resource and which run on a separate resource. This property is only used if an external resource manager is used for the allocation. If the Streams resource manager is used, this property is ignored and any tags added to the hosts are used to determine service placement. If this value does not include themanagementtag, themanagementtag is added. The following tags are also valid:view. The services for all specified tags are started on the same resource. The services for all omitted tags are each started on a separate resource. User-defined tags can also be included in this property value. The format of the value is a comma separated list of tag names. The default value is:management,view. When you update this property value, the change does not occur until the instance restarts.
-
HIGH_AVAILABILITY_COUNT
public static final InstanceMXBean.PropertyId HIGH_AVAILABILITY_COUNT
Specifies the total number of each Streams instance management service. The value must be between 1 and 5, inclusive. To configure high availability in Streams enterprise domains, specify a value greater than 1. The default value is 1. For more information about high availability with Streams instances see the product documentation at http://www.ibm.com/support/knowledgecenter/SSCRJU_4.1.0/com.ibm.streams.cfg.doc/doc/hacount-instance.html
-
RESTART_PES_ON_RESOURCE_FAILURE
public static final InstanceMXBean.PropertyId RESTART_PES_ON_RESOURCE_FAILURE
Specifies whether processing elements are restarted after a resource failure. The default is true.
-
RESTART_PES_ON_RESOURCE_FAILURE_WAIT_TIME
public static final InstanceMXBean.PropertyId RESTART_PES_ON_RESOURCE_FAILURE_WAIT_TIME
Specifies the period, in seconds, that Streams waits before it restarts processing elements when a resource fails. The default is 5 minutes.
-
TRACE_DEFAULT_LEVEL
public static final InstanceMXBean.PropertyId TRACE_DEFAULT_LEVEL
Specifies the default trace level to use for debugging problems with Streams instance services.DomainTracingPropertiesMXBean.Leveldefines valid values. The default value isERROR.
-
TRACE_MAXIMUM_FILE_SIZE
public static final InstanceMXBean.PropertyId TRACE_MAXIMUM_FILE_SIZE
Specifies the maximum size, in kilobytes, of trace files. The value must be greater than or equal to 1024. The default is 5000 kilobytes. When you update this property value, the change does not occur for a service until the service restarts.
-
TRACE_MAXIMUM_FILE_COUNT
public static final InstanceMXBean.PropertyId TRACE_MAXIMUM_FILE_COUNT
Specifies the maximum number of trace files to save per service. The default is 3 trace files. When you update this property value, the change does not occur for a service until the service restarts.
-
NETWORK_LLM_INFINIBAND_INTERFACE_NAME
public static final InstanceMXBean.PropertyId NETWORK_LLM_INFINIBAND_INTERFACE_NAME
Specifies the InfiniBand interface to be used by LLM when using the LLM InfiniBand transport (LLM_RUM_IB). The default value is ib1. When you update this property value, the change does not occur until the instance restarts.
-
NETWORK_LLM_PACKET_SIZE
public static final InstanceMXBean.PropertyId NETWORK_LLM_PACKET_SIZE
Specifies the LLM packet size in bytes when using the LLM transport (LLM_RUM_TCP or LLM_RUM_IB). If this property is not set, the internal LLM default value is used. The valid range is from 300 to 65000. When you update this property value, the change does not occur until the instance restarts.
-
NETWORK_LLM_INPUT_PORT_CONFIGURATION_FILE
public static final InstanceMXBean.PropertyId NETWORK_LLM_INPUT_PORT_CONFIGURATION_FILE
When you use the LLM transport (LL_RUM_TCP and LLM_RUM_IB), this property specifies the location of a configuration file to set advanced configuration parameters for a PE's input ports. LLM RUM has several advanced configuration parameters that can be set by using a file. See the IBM Websphere MQ Low Latency Messaging information center link at http://www.ibm.com/software/integration/wmq/llm/ for more details of LLM advanced configuration parameters.When you update this property value, the change does not occur until the instance restarts.
-
NETWORK_LLM_OUTPUT_PORT_CONFIGURATION_FILE
public static final InstanceMXBean.PropertyId NETWORK_LLM_OUTPUT_PORT_CONFIGURATION_FILE
When you use the LLM transport (LL_RUM_TCP and LLM_RUM_IB), this property specifies the location of a configuration file to set advanced configuration parameters for a PE's output ports. LLM RUM has several advanced configuration parameters that can be set by using a file. See the IBM Websphere MQ Low Latency Messaging information center link at http://www.ibm.com/software/integration/wmq/llm/ for more details of LLM advanced configuration parameters.When you update this property value, the change does not occur until the instance restarts.
-
SERVICE_CONTAINER_INITIAL_JVM_SIZE
public static final InstanceMXBean.PropertyId SERVICE_CONTAINER_INITIAL_JVM_SIZE
Specifies the initial amount of memory to allocate to the Java environment used to run multiple instance services. The size is specified in megabytes (MB). This property only applies if the instance is running Version 4.1.0 or later, which causes some instance services to run in a shared Java environment. The value must be between 512 and the value ofSERVICE_CONTAINER_MAXIMUM_JVM_SIZE. The default behavior is to use the initial size determined by the Java environment at startup. If a value is set for this property, a value must also be set forSERVICE_CONTAINER_MAXIMUM_JVM_SIZE. Otherwise, the service fails to start. When you update this property value, the change does not occur until the instance restarts.
-
SERVICE_CONTAINER_MAXIMUM_JVM_SIZE
public static final InstanceMXBean.PropertyId SERVICE_CONTAINER_MAXIMUM_JVM_SIZE
Specifies the maximum amount of memory to allocate to the Java environment used to run multiple instance services. The size is specified in megabytes (MB). This property only applies if the instance is running Version 4.1.0 or later, which causes some instance services to run in a shared Java environment. The value must be greater than or equal to the value ofSERVICE_CONTAINER_INITIAL_JVM_SIZE. The default behavior is to use the maximum size determined by Streams at startup. If the value ofJVM_SIZE_COMPUTATION_ENABLEDis false, the default behavior is to use the maximum size determined by the Java environment at startup. When you update this property value, the change does not occur until the instance restarts.
-
VIEW_PORT
public static final InstanceMXBean.PropertyId VIEW_PORT
Specifies the SSL port number for the view service. The default value is 0, which means that an open port is dynamically chosen when the service starts. This value is chosen from thePORT_RANGEif it is set; otherwise, it is chosen from the system port range. When you update this property value, the change does not occur until the instance restarts.
-
VIEW_HTTP_PORT
public static final InstanceMXBean.PropertyId VIEW_HTTP_PORT
Specifies the HTTPS port number to use to retrieve view data. The default value is 0, which means that an open port is dynamically chosen when the instance starts. This value is chosen from thePORT_RANGEif it is set; otherwise, it is chosen from the system port range. When you update this property value, the change does not occur until the instance restarts.
-
VIEW_TRACE_LEVEL
public static final InstanceMXBean.PropertyId VIEW_TRACE_LEVEL
Specifies the trace level for the view service. If you specify a value for this property, it overridesTRACE_DEFAULT_LEVELfor the view service.DomainTracingPropertiesMXBean.Leveldefines valid values. The default behavior is to use the value that is specified byTRACE_DEFAULT_LEVEL
-
VIEW_START_TIMEOUT
public static final InstanceMXBean.PropertyId VIEW_START_TIMEOUT
Specifies the period, in seconds, that Streams waits for the view service to start. If the service is being started as part of the instance starting and it is not running after the timeout period ends, the instance fails to start. If the service is being restarted and it is not running after the timeout period ends, Streams tries to restart the service again. See theSERVICE_RETRY_COUNTproperty for more information about service restart retries. If set, this property overridesSERVICE_START_TIMEOUTfor the view service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_START_TIMEOUT
-
VIEW_STOP_TIMEOUT
public static final InstanceMXBean.PropertyId VIEW_STOP_TIMEOUT
Specifies the period, in seconds, that Streams waits for the view service to stop. If set, this property overridesSERVICE_STOP_TIMEOUTfor the view service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_STOP_TIMEOUT
-
VIEW_INITIAL_JVM_SIZE
public static final InstanceMXBean.PropertyId VIEW_INITIAL_JVM_SIZE
Specifies the initial amount of memory, in megabytes, to allocate to the Java environment for the view service. This property only applies if the instance is running Version 4.0.*, which causes the view service to run in its own Java environment. The value must be between 512 and the value ofVIEW_MAXIMUM_JVM_SIZE. By default, this service uses the initial size determined by the Java environment when the service starts. If this property has a value, you must also set theVIEW_MAXIMUM_JVM_SIZEproperty; otherwise, the service fails to start. When you update this property value, the change does not occur until the instance restarts.
-
VIEW_MAXIMUM_JVM_SIZE
public static final InstanceMXBean.PropertyId VIEW_MAXIMUM_JVM_SIZE
Specifies the maximum amount of memory, in megabytes, to allocate to the Java environment for view service. This property only applies if the instance is running Version 4.0.*, which causes the view service to run in its own Java environment. The value must be greater than or equal to the value ofVIEW_INITIAL_JVM_SIZE. The default behavior is to use the maximum size determined by Streams at startup. If the value ofJVM_SIZE_COMPUTATION_ENABLEDis false, the default behavior is to use the maximum size determined by the Java environment at startup. When you update this property value, the change does not occur until the instance restarts.
-
SAM_TRACE_LEVEL
public static final InstanceMXBean.PropertyId SAM_TRACE_LEVEL
Specifies the trace level for the application manager service. If you specify a value for this property, it overridesTRACE_DEFAULT_LEVELfor the application manager service.DomainTracingPropertiesMXBean.Leveldefines valid values. The default behavior is to use the value that is specified byTRACE_DEFAULT_LEVEL
-
SAM_START_TIMEOUT
public static final InstanceMXBean.PropertyId SAM_START_TIMEOUT
Specifies the period, in seconds, that Streams waits for the application manager service to start. If the service is being started as part of the instance starting and it is not running after the timeout period ends, the instance fails to start. If the service is being restarted and it is not running after the timeout period ends, Streams tries to restart the service again. See theSERVICE_RETRY_COUNTproperty for more information about service restart retries. If set, this property overridesSERVICE_START_TIMEOUTfor the application manager service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_START_TIMEOUT
-
SAM_STOP_TIMEOUT
public static final InstanceMXBean.PropertyId SAM_STOP_TIMEOUT
Specifies the period, in seconds, that Streams waits for the application manager service to stop. If set, this property overridesSERVICE_STOP_TIMEOUTfor the application manager service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_STOP_TIMEOUT
-
SAM_PORT
public static final InstanceMXBean.PropertyId SAM_PORT
Specifies the SSL port number for the application management service. If a value is set forDomainMXBean.PropertyId.PORT_RANGE, you must specify a value within that range or 0. The default value is 0, which means that an open port is dynamically chosen when the instance starts. This value is chosen from thePORT_RANGEif it is set; otherwise, it is chosen from the system port range. When you update this property value, the change does not occur until the instance restarts.
-
SAM_JMX_PORT
public static final InstanceMXBean.PropertyId SAM_JMX_PORT
Specifies the SSL port number for the management support within the application management service. The default value is 0, which means that an open port is dynamically chosen when the instance starts. This value is chosen from thePORT_RANGEif it is set; otherwise, it is chosen from the system port range. When you update this property value, the change does not occur until the instance restarts.
-
SAM_JMX_HTTP_PORT
public static final InstanceMXBean.PropertyId SAM_JMX_HTTP_PORT
Specifies the HTTPS port number to use for large data transfers. The default value is 0, which means that an open port is dynamically chosen when the instance starts. This value is chosen from thePORT_RANGEif it is set; otherwise, it is chosen from the system port range. When you update this property value, the change does not occur until the instance restarts.
-
SRM_PORT
public static final InstanceMXBean.PropertyId SRM_PORT
Specifies the SSL port number for the application metrics service. If a value is set forDomainMXBean.PropertyId.PORT_RANGE, you must specify a value within that range or 0. The default value is 0, which means that an open port is dynamically chosen when the instance starts. This value is chosen from thePORT_RANGEif it is set; otherwise, it is chosen from the system port range. When you update this property value, the change does not occur until the instance restarts.
-
SRM_TRACE_LEVEL
public static final InstanceMXBean.PropertyId SRM_TRACE_LEVEL
Specifies the trace level for the application metrics service. If you specify a value for this property, it overridesTRACE_DEFAULT_LEVELfor the application metrics service.DomainTracingPropertiesMXBean.Leveldefines valid values. The default behavior is to use the value that is specified byTRACE_DEFAULT_LEVEL
-
SRM_START_TIMEOUT
public static final InstanceMXBean.PropertyId SRM_START_TIMEOUT
Specifies the period, in seconds, that Streams waits for the application metrics service to start. If the service is being started as part of the instance starting and it is not running after the timeout period ends, the instance fails to start. If the service is being restarted and it is not running after the timeout period ends, Streams tries to restart the service again. See theSERVICE_RETRY_COUNTproperty for more information about service restart retries. If set, this property overridesSERVICE_START_TIMEOUTfor the application metrics service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_START_TIMEOUT
-
SRM_STOP_TIMEOUT
public static final InstanceMXBean.PropertyId SRM_STOP_TIMEOUT
Specifies the period, in seconds, that Streams waits for the application metrics service to stop. If set, this property overridesSERVICE_STOP_TIMEOUTfor the application metrics service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_STOP_TIMEOUT
-
SCH_TRACE_LEVEL
public static final InstanceMXBean.PropertyId SCH_TRACE_LEVEL
Specifies the trace level for the scheduler service. This property only applies if the instance is running Version 4.0.* or 4.1.*, which causes the scheduler to run as a separate service. If you specify a value for this property, it overridesTRACE_DEFAULT_LEVELfor the scheduler service.DomainTracingPropertiesMXBean.Leveldefines valid values. The default behavior is to use the value that is specified byTRACE_DEFAULT_LEVEL
-
SCH_START_TIMEOUT
public static final InstanceMXBean.PropertyId SCH_START_TIMEOUT
Specifies the period, in seconds, that Streams waits for the scheduler service to start. This property only applies if the instance is running Version 4.0.* or 4.1.*, which causes the scheduler to run as a separate service. If the service is being started as part of the instance starting and it is not running after the timeout period ends, the instance fails to start. If the service is being restarted and it is not running after the timeout period ends, Streams tries to restart the service again. See theSERVICE_RETRY_COUNTproperty for more information about service restart retries. If set, this property overridesSERVICE_START_TIMEOUTfor the scheduler service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_START_TIMEOUT
-
SCH_STOP_TIMEOUT
public static final InstanceMXBean.PropertyId SCH_STOP_TIMEOUT
Specifies the period, in seconds, that Streams waits for the scheduler service to stop. This property only applies if the instance is running Version 4.0.* or 4.1.*, which causes the scheduler to run as a separate service. If set, this property overridesSERVICE_STOP_TIMEOUTfor the scheduler service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_STOP_TIMEOUT
-
HC_METRIC_COLLECTION_INTERVAL
public static final InstanceMXBean.PropertyId HC_METRIC_COLLECTION_INTERVAL
Specifies the period, in seconds, that the host controller service waits between metric collections from the processing elements. The default is 3 seconds.
-
HC_PEC_START_TIMEOUT
public static final InstanceMXBean.PropertyId HC_PEC_START_TIMEOUT
Specifies the maximum period, in seconds, that the host controller service waits for a processing element container (PEC) to start. The value must be greater than or equal to 30. The default is 30 seconds.
-
HC_PEC_STOP_TIMEOUT
public static final InstanceMXBean.PropertyId HC_PEC_STOP_TIMEOUT
Specifies the maximum period, in seconds, that the host controller service waits for a processing element container (PEC) to stop. If the PEC does not stop within the timeout period, it is forced to stop immediately. The value must be greater than or equal to 30. The default is 30 seconds.
-
HC_TRACE_LEVEL
public static final InstanceMXBean.PropertyId HC_TRACE_LEVEL
Specifies the trace level for the host controller service. If you specify a value for this property, it overridesTRACE_DEFAULT_LEVELfor the host controller service.DomainTracingPropertiesMXBean.Leveldefines valid values. The default behavior is to use the value that is specified byTRACE_DEFAULT_LEVEL
-
HC_START_TIMEOUT
public static final InstanceMXBean.PropertyId HC_START_TIMEOUT
Specifies the period, in seconds, that Streams waits for the host controller service to start. If the service is being started as part of the instance starting and it is not running after the timeout period ends, the instance fails to start. If the service is being restarted and it is not running after the timeout period ends, Streams tries to restart the service again. See theSERVICE_RETRY_COUNTproperty for more information about service restart retries. If set, this property overridesSERVICE_START_TIMEOUTfor the host controller service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_START_TIMEOUT
-
HC_PEC_TRACE_LEVEL
public static final InstanceMXBean.PropertyId HC_PEC_TRACE_LEVEL
Specifies the trace level for processing element containers (PECs). If set, this property overridesTRACE_DEFAULT_LEVELfor PECs.DomainTracingPropertiesMXBean.Leveldefines valid values. By default, PECs use the value that is specified byTRACE_DEFAULT_LEVEL.
-
APP_PORT
public static final InstanceMXBean.PropertyId APP_PORT
Specifies the SSL port number for the application deployment service. The default value is 0, which means that an open port is dynamically chosen when the service starts. This value is chosen from thePORT_RANGEif it is set; otherwise, it is chosen from the system port range. When you update this property value, the change does not occur until the instance restarts.
-
APP_TRACE_LEVEL
public static final InstanceMXBean.PropertyId APP_TRACE_LEVEL
Specifies the trace level for the application deployment service. If you specify a value for this property, it overridesTRACE_DEFAULT_LEVELfor the application deployment service.DomainTracingPropertiesMXBean.Leveldefines valid values. The default behavior is to use the value that is specified byTRACE_DEFAULT_LEVEL
-
APP_START_TIMEOUT
public static final InstanceMXBean.PropertyId APP_START_TIMEOUT
Specifies the period, in seconds, that Streams waits for the application deployment service to start. If the service is being started as part of the instance starting and it is not running after the timeout period ends, the instance fails to start. If the service is being restarted and it is not running after the timeout period ends, Streams tries to restart the service again. See theSERVICE_RETRY_COUNTproperty for more information about service restart retries. If set, this property overridesSERVICE_START_TIMEOUTfor the application deployment service. The value must be greater than or equal to 30. The default behavior is to use the value that is specified bySERVICE_START_TIMEOUT
-
APP_STOP_TIMEOUT
public static final InstanceMXBean.PropertyId APP_STOP_TIMEOUT
Specifies the period, in seconds, that Streams waits for the application deployment service to stop. The value must be greater than or equal to 30. The default is 900.
-
APP_INITIAL_JVM_SIZE
public static final InstanceMXBean.PropertyId APP_INITIAL_JVM_SIZE
Specifies the initial amount of memory, in megabytes, to allocate to the Java environment for the application deployment service. This property only applies if the instance is running Version 4.0.*, which causes the application deployment service to run in its own Java environment. The value must be between 512 and the value ofAPP_MAXIMUM_JVM_SIZE. By default, this service uses the initial size determined by the Java environment when the service starts. If this property has a value, you must also set theAPP_MAXIMUM_JVM_SIZEproperty; otherwise, the service fails to start. When you update this property value, the change does not occur until the instance restarts.
-
APP_MAXIMUM_JVM_SIZE
public static final InstanceMXBean.PropertyId APP_MAXIMUM_JVM_SIZE
Specifies the maximum amount of memory, in megabytes, to allocate to the Java environment for the application deployment service. This property only applies if the instance is running Version 4.0.*, which causes the application deployment service to run in its own Java environment. The value must be greater than or equal to the value ofAPP_INITIAL_JVM_SIZE. The default behavior is to use the maximum size determined by Streams at startup. If the value ofJVM_SIZE_COMPUTATION_ENABLEDis false, the default behavior is to use the maximum size determined by the Java environment at startup. When you update this property value, the change does not occur until the instance restarts.
-
-
Method Detail
-
values
public static InstanceMXBean.PropertyId[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (InstanceMXBean.PropertyId c : InstanceMXBean.PropertyId.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static InstanceMXBean.PropertyId valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
toString
public java.lang.String toString()
Converts the enumeration value to a string.- Overrides:
toStringin classjava.lang.Enum<InstanceMXBean.PropertyId>- Returns:
- a string representation of the PropertyId value. This value is returned for the
nameof thePropertyMetadata. It is also used by streamtool to get and set the property value.
-
fromString
public static InstanceMXBean.PropertyId fromString(java.lang.String id)
Converts from a string representation of a property identifier to the corresponding enumeration value.- Parameters:
id- specifies a property identifier string value.- Returns:
- the corresponding PropertyId enumeration value.
- Throws:
java.lang.IllegalArgumentException- if the input string does not map to an enumeration value.java.lang.NullPointerException- if the input value is null.
-
-