Class DocumentReviewerResponseSource

    • Method Detail

      • createTime

        public final Instant createTime()

        The date and time that a reviewer entered a response to a document review request.

        Returns:
        The date and time that a reviewer entered a response to a document review request.
      • updatedTime

        public final Instant updatedTime()

        The date and time that a reviewer last updated a response to a document review request.

        Returns:
        The date and time that a reviewer last updated a response to a document review request.
      • reviewStatus

        public final ReviewStatus reviewStatus()

        The current review status of a new custom SSM document created by a member of your organization, or of the latest version of an existing SSM document.

        Only one version of a document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

        Only one version of a document can be in review, or PENDING, at a time.

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

        Returns:
        The current review status of a new custom SSM document created by a member of your organization, or of the latest version of an existing SSM document.

        Only one version of a document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

        Only one version of a document can be in review, or PENDING, at a time.

        See Also:
        ReviewStatus
      • reviewStatusAsString

        public final String reviewStatusAsString()

        The current review status of a new custom SSM document created by a member of your organization, or of the latest version of an existing SSM document.

        Only one version of a document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

        Only one version of a document can be in review, or PENDING, at a time.

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

        Returns:
        The current review status of a new custom SSM document created by a member of your organization, or of the latest version of an existing SSM document.

        Only one version of a document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

        Only one version of a document can be in review, or PENDING, at a time.

        See Also:
        ReviewStatus
      • hasComment

        public final boolean hasComment()
        For responses, this returns true if the service returned a value for the Comment 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.
      • comment

        public final List<DocumentReviewCommentSource> comment()

        The comment entered by a reviewer as part of their document review response.

        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 hasComment() method.

        Returns:
        The comment entered by a reviewer as part of their document review response.
      • reviewer

        public final String reviewer()

        The user in your organization assigned to review a document request.

        Returns:
        The user in your organization assigned to review a document request.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)