Class EndpointSetting

    • Method Detail

      • name

        public final String name()

        The name that you want to give the endpoint settings.

        Returns:
        The name that you want to give the endpoint settings.
      • hasEnumValues

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

        public final List<String> enumValues()

        Enumerated values to use for this endpoint.

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

        Returns:
        Enumerated values to use for this endpoint.
      • sensitive

        public final Boolean sensitive()

        A value that marks this endpoint setting as sensitive.

        Returns:
        A value that marks this endpoint setting as sensitive.
      • units

        public final String units()

        The unit of measure for this endpoint setting.

        Returns:
        The unit of measure for this endpoint setting.
      • applicability

        public final String applicability()

        The relevance or validity of an endpoint setting for an engine name and its endpoint type.

        Returns:
        The relevance or validity of an endpoint setting for an engine name and its endpoint type.
      • intValueMin

        public final Integer intValueMin()

        The minimum value of an endpoint setting that is of type int.

        Returns:
        The minimum value of an endpoint setting that is of type int.
      • intValueMax

        public final Integer intValueMax()

        The maximum value of an endpoint setting that is of type int.

        Returns:
        The maximum value of an endpoint setting that is of type int.
      • defaultValue

        public final String defaultValue()

        The default value of the endpoint setting if no value is specified using CreateEndpoint or ModifyEndpoint.

        Returns:
        The default value of the endpoint setting if no value is specified using CreateEndpoint or ModifyEndpoint.
      • 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)