Class WorldFailure

    • Method Detail

      • failureCode

        public final WorldGenerationJobErrorCode failureCode()

        The failure code of the world export job if it failed:

        InternalServiceError

        Internal service error.

        LimitExceeded

        The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

        ResourceNotFound

        The specified resource could not be found.

        RequestThrottled

        The request was throttled.

        InvalidInput

        An input parameter in the request is not valid.

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

        Returns:
        The failure code of the world export job if it failed:

        InternalServiceError

        Internal service error.

        LimitExceeded

        The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

        ResourceNotFound

        The specified resource could not be found.

        RequestThrottled

        The request was throttled.

        InvalidInput

        An input parameter in the request is not valid.

        See Also:
        WorldGenerationJobErrorCode
      • failureCodeAsString

        public final String failureCodeAsString()

        The failure code of the world export job if it failed:

        InternalServiceError

        Internal service error.

        LimitExceeded

        The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

        ResourceNotFound

        The specified resource could not be found.

        RequestThrottled

        The request was throttled.

        InvalidInput

        An input parameter in the request is not valid.

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

        Returns:
        The failure code of the world export job if it failed:

        InternalServiceError

        Internal service error.

        LimitExceeded

        The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

        ResourceNotFound

        The specified resource could not be found.

        RequestThrottled

        The request was throttled.

        InvalidInput

        An input parameter in the request is not valid.

        See Also:
        WorldGenerationJobErrorCode
      • sampleFailureReason

        public final String sampleFailureReason()

        The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason.

        Returns:
        The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason.
      • failureCount

        public final Integer failureCount()

        The number of failed worlds.

        Returns:
        The number of failed worlds.
      • 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)