Package com.spotfire.ws.pub

Class UpdateAnalysis

  • public class UpdateAnalysis
extends java.lang.Object
    Describes the properties needed to submit an external scheduled update via the dedicated SOAP web service.

    • Constructor Summary

      Constructors 
      Constructor Description
      UpdateAnalysis()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getClientUpdate()
      Gets the value of the clientUpdate property.
      java.lang.Integer getKeepAliveMinutes()
      Gets the value of the keepAliveMinutes property.
      java.lang.String getPath()
      Gets the value of the path property.
      java.lang.String getResourcePool()
      Gets the value of the resourcePool property.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UpdateAnalysis

        public UpdateAnalysis()

    • Method Detail

      • getPath

        public java.lang.String getPath()
        Gets the value of the path property. Required.
        Returns:
        the library path to the analysis that should be updated

      • getClientUpdate

        public java.lang.String getClientUpdate()
        Gets the value of the clientUpdate property. Optional. Use the automatic value to update all running web browser clients. Use the manual value to have normal update where each client should update manually, as in Spotfire 2.2. If the manual or automatic client update behavior is supplied and is valid, this value is used for the update. If the value is not supplied or if it is invalid, the manual update behavior is used.
        Returns:
        client update mode, one of {manual, automatic}

      • getKeepAliveMinutes

        public java.lang.Integer getKeepAliveMinutes()
        Gets the value of the keepAliveMinutes property. Optional.
        Returns:
        the number of minutes that the web player server should keep an inactive analysis before it's recycled.

      • getResourcePool

        public java.lang.String getResourcePool()
        Gets the value of the resourcePool property. Optional.
        Returns:
        resource pool name