Class DeviceManagementSettingDefinition

    • Constructor Detail

      • DeviceManagementSettingDefinition

        protected DeviceManagementSettingDefinition()
    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class Entity
      • builderDeviceManagementSettingDefinition

        public static DeviceManagementSettingDefinition.Builder builderDeviceManagementSettingDefinition()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class
      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class Entity
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class Entity
      • getConstraints

        public com.github.davidmoten.odata.client.CollectionPage<DeviceManagementConstraint> getConstraints()
        “Collection of constraints for the setting value”
        Returns:
        property constraints
      • withConstraints

        public DeviceManagementSettingDefinition withConstraints​(List<DeviceManagementConstraint> constraints)
        Returns an immutable copy of this with just the constraints field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Collection of constraints for the setting value”

        Parameters:
        constraints - new value of constraints field (as defined in service metadata)
        Returns:
        immutable copy of this with just the constraints field changed
      • getConstraints

        public com.github.davidmoten.odata.client.CollectionPage<DeviceManagementConstraint> getConstraints​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Collection of constraints for the setting value”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property constraints
      • getDependencies

        public com.github.davidmoten.odata.client.CollectionPage<DeviceManagementSettingDependency> getDependencies()
        “Collection of dependencies on other settings”
        Returns:
        property dependencies
      • withDependencies

        public DeviceManagementSettingDefinition withDependencies​(List<DeviceManagementSettingDependency> dependencies)
        Returns an immutable copy of this with just the dependencies field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Collection of dependencies on other settings”

        Parameters:
        dependencies - new value of dependencies field (as defined in service metadata)
        Returns:
        immutable copy of this with just the dependencies field changed
      • getDependencies

        public com.github.davidmoten.odata.client.CollectionPage<DeviceManagementSettingDependency> getDependencies​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Collection of dependencies on other settings”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property dependencies
      • getDescription

        public Optional<String> getDescription()
        “The setting's description”
        Returns:
        property description
      • withDescription

        public DeviceManagementSettingDefinition withDescription​(String description)
        Returns an immutable copy of this with just the description field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The setting's description”

        Parameters:
        description - new value of description field (as defined in service metadata)
        Returns:
        immutable copy of this with just the description field changed
      • getDisplayName

        public Optional<String> getDisplayName()
        “The setting's display name”
        Returns:
        property displayName
      • withDisplayName

        public DeviceManagementSettingDefinition withDisplayName​(String displayName)
        Returns an immutable copy of this with just the displayName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The setting's display name”

        Parameters:
        displayName - new value of displayName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the displayName field changed
      • getDocumentationUrl

        public Optional<String> getDocumentationUrl()
        “Url to setting documentation”
        Returns:
        property documentationUrl
      • withDocumentationUrl

        public DeviceManagementSettingDefinition withDocumentationUrl​(String documentationUrl)
        Returns an immutable copy of this with just the documentationUrl field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Url to setting documentation”

        Parameters:
        documentationUrl - new value of documentationUrl field (as defined in service metadata)
        Returns:
        immutable copy of this with just the documentationUrl field changed
      • getHeaderSubtitle

        public Optional<String> getHeaderSubtitle()
        “subtitle of the setting header for more details about the category/section”
        Returns:
        property headerSubtitle
      • withHeaderSubtitle

        public DeviceManagementSettingDefinition withHeaderSubtitle​(String headerSubtitle)
        Returns an immutable copy of this with just the headerSubtitle field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “subtitle of the setting header for more details about the category/section”

        Parameters:
        headerSubtitle - new value of headerSubtitle field (as defined in service metadata)
        Returns:
        immutable copy of this with just the headerSubtitle field changed
      • getHeaderTitle

        public Optional<String> getHeaderTitle()
        “title of the setting header represents a category/section of a setting/settings”
        Returns:
        property headerTitle
      • withHeaderTitle

        public DeviceManagementSettingDefinition withHeaderTitle​(String headerTitle)
        Returns an immutable copy of this with just the headerTitle field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “title of the setting header represents a category/section of a setting/settings”

        Parameters:
        headerTitle - new value of headerTitle field (as defined in service metadata)
        Returns:
        immutable copy of this with just the headerTitle field changed
      • getIsTopLevel

        public Optional<Boolean> getIsTopLevel()
        “If the setting is top level, it can be configured without the need to be wrapped in a collection or complex setting”
        Returns:
        property isTopLevel
      • withIsTopLevel

        public DeviceManagementSettingDefinition withIsTopLevel​(Boolean isTopLevel)
        Returns an immutable copy of this with just the isTopLevel field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If the setting is top level, it can be configured without the need to be wrapped in a collection or complex setting”

        Parameters:
        isTopLevel - new value of isTopLevel field (as defined in service metadata)
        Returns:
        immutable copy of this with just the isTopLevel field changed
      • getKeywords

        public com.github.davidmoten.odata.client.CollectionPage<String> getKeywords()
        “Keywords associated with the setting”
        Returns:
        property keywords
      • withKeywords

        public DeviceManagementSettingDefinition withKeywords​(List<String> keywords)
        Returns an immutable copy of this with just the keywords field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Keywords associated with the setting”

        Parameters:
        keywords - new value of keywords field (as defined in service metadata)
        Returns:
        immutable copy of this with just the keywords field changed
      • getKeywords

        public com.github.davidmoten.odata.client.CollectionPage<String> getKeywords​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Keywords associated with the setting”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property keywords
      • getPlaceholderText

        public Optional<String> getPlaceholderText()
        “Placeholder text as an example of valid input”
        Returns:
        property placeholderText
      • withPlaceholderText

        public DeviceManagementSettingDefinition withPlaceholderText​(String placeholderText)
        Returns an immutable copy of this with just the placeholderText field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Placeholder text as an example of valid input”

        Parameters:
        placeholderText - new value of placeholderText field (as defined in service metadata)
        Returns:
        immutable copy of this with just the placeholderText field changed
      • withValueType

        public DeviceManagementSettingDefinition withValueType​(DeviceManangementIntentValueType valueType)
        Returns an immutable copy of this with just the valueType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The data type of the value”

        Parameters:
        valueType - new value of valueType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the valueType field changed
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class Entity
      • patch

        public DeviceManagementSettingDefinition patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • put

        public DeviceManagementSettingDefinition put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class Entity
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected