Class UpdateAnswerRequest

    • Method Detail

      • workloadId

        public final String workloadId()
        Returns the value of the WorkloadId property for this object.
        Returns:
        The value of the WorkloadId property for this object.
      • lensAlias

        public final String lensAlias()
        Returns the value of the LensAlias property for this object.
        Returns:
        The value of the LensAlias property for this object.
      • questionId

        public final String questionId()
        Returns the value of the QuestionId property for this object.
        Returns:
        The value of the QuestionId property for this object.
      • hasSelectedChoices

        public final boolean hasSelectedChoices()
        For responses, this returns true if the service returned a value for the SelectedChoices property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • selectedChoices

        public final List<String> selectedChoices()
        Returns the value of the SelectedChoices property for this object.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSelectedChoices() method.

        Returns:
        The value of the SelectedChoices property for this object.
      • hasChoiceUpdates

        public final boolean hasChoiceUpdates()
        For responses, this returns true if the service returned a value for the ChoiceUpdates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • choiceUpdates

        public final Map<String,​ChoiceUpdate> choiceUpdates()

        A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChoiceUpdates() method.

        Returns:
        A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
      • notes

        public final String notes()
        Returns the value of the Notes property for this object.
        Returns:
        The value of the Notes property for this object.
      • isApplicable

        public final Boolean isApplicable()
        Returns the value of the IsApplicable property for this object.
        Returns:
        The value of the IsApplicable property for this object.
      • reason

        public final AnswerReason reason()

        The reason why a question is not applicable to your workload.

        If the service returns an enum value that is not available in the current SDK version, reason will return AnswerReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonAsString().

        Returns:
        The reason why a question is not applicable to your workload.
        See Also:
        AnswerReason
      • reasonAsString

        public final String reasonAsString()

        The reason why a question is not applicable to your workload.

        If the service returns an enum value that is not available in the current SDK version, reason will return AnswerReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonAsString().

        Returns:
        The reason why a question is not applicable to your workload.
        See Also:
        AnswerReason
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object