Package org.elasticsearch.client.license

Class StartTrialResponse

  • public class StartTrialResponse
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      StartTrialResponse​(boolean acknowledged, boolean trialWasStarted, java.lang.String licenseType, java.lang.String errorMessage, java.lang.String acknowledgeHeader, java.util.Map<java.lang.String,​java.lang.String[]> acknowledgeMessages)  

    • Method Summary

      Modifier and Type Method Description
      static StartTrialResponse fromXContent​(XContentParser parser)  
      java.lang.String getAcknowledgeHeader()
      If the request corresponding to this response did not acknowledge licensing changes that would result from starting a trial license (see isAcknowledged()), returns a message describing how the user must acknowledge licensing changes as a result of such a request.
      java.util.Map<java.lang.String,​java.lang.String[]> getAcknowledgeMessages()
      If the request corresponding to this response did not acknowledge licensing changes that would result from starting a trial license (see isAcknowledged(), returns a map.
      java.lang.String getErrorMessage()
      If a trial license was not started as a result of the request corresponding to this response (see isTrialWasStarted() then returns a brief message explaining why the trial could not be started.
      java.lang.String getLicenseType()
      If a trial license was started as a result of the request corresponding to this response (see isTrialWasStarted()) then returns the type of license that was started on the cluster.
      boolean isAcknowledged()
      Returns true if the request that corresponds to this response acknowledged license changes that would occur as a result of starting a trial license
      boolean isTrialWasStarted()
      Returns true if a trial license was started as a result of the request corresponding to this response.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • StartTrialResponse

        public StartTrialResponse​(boolean acknowledged,
                          boolean trialWasStarted,
                          java.lang.String licenseType,
                          java.lang.String errorMessage,
                          java.lang.String acknowledgeHeader,
                          java.util.Map<java.lang.String,​java.lang.String[]> acknowledgeMessages)

    • Method Detail

      • isAcknowledged

        public boolean isAcknowledged()
        Returns true if the request that corresponds to this response acknowledged license changes that would occur as a result of starting a trial license

      • isTrialWasStarted

        public boolean isTrialWasStarted()
        Returns true if a trial license was started as a result of the request corresponding to this response. Returns false if the cluster did not start a trial, or a trial had already been started before the corresponding request was made

      • getLicenseType

        public java.lang.String getLicenseType()
        If a trial license was started as a result of the request corresponding to this response (see isTrialWasStarted()) then returns the type of license that was started on the cluster. Returns null otherwise

      • getErrorMessage

        public java.lang.String getErrorMessage()
        If a trial license was not started as a result of the request corresponding to this response (see isTrialWasStarted() then returns a brief message explaining why the trial could not be started. Returns false otherwise

      • getAcknowledgeHeader

        public java.lang.String getAcknowledgeHeader()
        If the request corresponding to this response did not acknowledge licensing changes that would result from starting a trial license (see isAcknowledged()), returns a message describing how the user must acknowledge licensing changes as a result of such a request. Returns null otherwise

      • getAcknowledgeMessages

        public java.util.Map<java.lang.String,​java.lang.String[]> getAcknowledgeMessages()
        If the request corresponding to this response did not acknowledge licensing changes that would result from starting a trial license (see isAcknowledged(), returns a map. The map's keys are names of commercial Elasticsearch features, and their values are messages about how those features will be affected by licensing changes as a result of starting a trial license