Class ConnectorProperty

    • Method Detail

      • name

        public final String name()

        The name of the property.

        Returns:
        The name of the property.
      • keyOverride

        public final String keyOverride()

        A key name to use when sending this property in API requests, if different from the display name.

        Returns:
        A key name to use when sending this property in API requests, if different from the display name.
      • required

        public final Boolean required()

        Indicates whether the property is required.

        Returns:
        Indicates whether the property is required.
      • defaultValue

        public final String defaultValue()

        The default value for the property.

        Returns:
        The default value for the property.
      • hasAllowedValues

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

        public final List<String> allowedValues()

        A list of AllowedValue objects representing the values allowed for the property.

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

        Returns:
        A list of AllowedValue objects representing the values allowed for the property.
      • propertyLocation

        public final PropertyLocation propertyLocation()

        Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

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

        Returns:
        Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
        See Also:
        PropertyLocation
      • propertyLocationAsString

        public final String propertyLocationAsString()

        Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

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

        Returns:
        Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
        See Also:
        PropertyLocation
      • propertyTypeAsString

        public final String propertyTypeAsString()

        The data type of this property

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

        Returns:
        The data type of this property
        See Also:
        PropertyType
      • 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)