Class HttpInstanceSummary

    • Method Detail

      • instanceId

        public final String instanceId()

        The ID of an instance that matches the values that you specified in the request.

        Returns:
        The ID of an instance that matches the values that you specified in the request.
      • namespaceName

        public final String namespaceName()

        The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

        Returns:

        The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

      • serviceName

        public final String serviceName()

        The name of the service that you specified when you registered the instance.

        Returns:
        The name of the service that you specified when you registered the instance.
      • healthStatus

        public final HealthStatus healthStatus()

        If you configured health checking in the service, the current health status of the service instance.

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

        Returns:
        If you configured health checking in the service, the current health status of the service instance.
        See Also:
        HealthStatus
      • healthStatusAsString

        public final String healthStatusAsString()

        If you configured health checking in the service, the current health status of the service instance.

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

        Returns:
        If you configured health checking in the service, the current health status of the service instance.
        See Also:
        HealthStatus
      • hasAttributes

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

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

        If you included any attributes when you registered the instance, the values of those attributes.

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

        Returns:
        If you included any attributes when you registered the instance, the values of those attributes.
      • 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)