Class Step

    • Method Detail

      • stepName

        public final String stepName()

        The name of the execution step.

        Returns:
        The name of the execution step.
      • startTime

        public final Instant startTime()

        The start date and time of the execution step.

        Returns:
        The start date and time of the execution step.
      • statusAsString

        public final String statusAsString()

        The status of the execution step.

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

        Returns:
        The status of the execution step.
        See Also:
        JobStatus
      • endTime

        public final Instant endTime()

        The end date and time of the execution step.

        Returns:
        The end date and time of the execution step.
      • logUrl

        public final String logUrl()

        The URL to the logs for the execution step.

        Returns:
        The URL to the logs for the execution step.
      • artifactsUrl

        public final String artifactsUrl()

        The URL to the artifact for the execution step.

        Returns:
        The URL to the artifact for the execution step.
      • testArtifactsUrl

        public final String testArtifactsUrl()

        The URL to the test artifact for the execution step.

        Returns:
        The URL to the test artifact for the execution step.
      • testConfigUrl

        public final String testConfigUrl()

        The URL to the test configuration for the execution step.

        Returns:
        The URL to the test configuration for the execution step.
      • hasScreenshots

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

        public final Map<String,​String> screenshots()

        The list of screenshot URLs for the execution step, if relevant.

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

        Returns:
        The list of screenshot URLs for the execution step, if relevant.
      • statusReason

        public final String statusReason()

        The reason for the current step status.

        Returns:
        The reason for the current step status.
      • context

        public final String context()

        The context for the current step. Includes a build image if the step is build.

        Returns:
        The context for the current step. Includes a build image if the step is build.
      • serializableBuilderClass

        public static Class<? extends Step.Builder> serializableBuilderClass()
      • 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)