Class ConnectorRuntimeSetting

    • Method Detail

      • key

        public final String key()

        Contains value information about the connector runtime setting.

        Returns:
        Contains value information about the connector runtime setting.
      • dataType

        public final String dataType()

        Data type of the connector runtime setting.

        Returns:
        Data type of the connector runtime setting.
      • isRequired

        public final Boolean isRequired()

        Indicates whether this connector runtime setting is required.

        Returns:
        Indicates whether this connector runtime setting is required.
      • label

        public final String label()

        A label used for connector runtime setting.

        Returns:
        A label used for connector runtime setting.
      • description

        public final String description()

        A description about the connector runtime setting.

        Returns:
        A description about the connector runtime setting.
      • scope

        public final String scope()

        Indicates the scope of the connector runtime setting.

        Returns:
        Indicates the scope of the connector runtime setting.
      • hasConnectorSuppliedValueOptions

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

        public final List<String> connectorSuppliedValueOptions()

        Contains default values for the connector runtime setting that are supplied by the connector.

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

        Returns:
        Contains default values for the connector runtime setting that are supplied by the connector.
      • 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)