Class EnrollmentProfile

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
    Direct Known Subclasses:
    DepEnrollmentBaseProfile, DepEnrollmentProfile

    public class EnrollmentProfile
    extends Entity
    implements com.github.davidmoten.odata.client.ODataEntityType
    “The enrollmentProfile resource represents a collection of configurations which must be provided pre-enrollment to enable enrolling certain devices whose identities have been pre-staged. Pre-staged device identities are assigned to this type of profile to apply the profile's configurations at enrollment of the corresponding device.”
    • Field Detail

      • configurationEndpointUrl

        protected String configurationEndpointUrl
      • description

        protected String description
      • displayName

        protected String displayName
      • enableAuthenticationViaCompanyPortal

        protected Boolean enableAuthenticationViaCompanyPortal
      • requireCompanyPortalOnSetupAssistantEnrolledDevices

        protected Boolean requireCompanyPortalOnSetupAssistantEnrolledDevices
      • requiresUserAuthentication

        protected Boolean requiresUserAuthentication
    • Constructor Detail

      • EnrollmentProfile

        protected EnrollmentProfile()
    • Method Detail

      • odataTypeName

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

        public static EnrollmentProfile.Builder builderEnrollmentProfile()
        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
      • getConfigurationEndpointUrl

        public Optional<String> getConfigurationEndpointUrl()
        “Configuration endpoint url to use for Enrollment”
        Returns:
        property configurationEndpointUrl
      • withConfigurationEndpointUrl

        public EnrollmentProfile withConfigurationEndpointUrl​(String configurationEndpointUrl)
        Returns an immutable copy of this with just the configurationEndpointUrl 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.

        “Configuration endpoint url to use for Enrollment”

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

        public Optional<String> getDescription()
        “Description of the profile”
        Returns:
        property description
      • withDescription

        public EnrollmentProfile 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.

        “Description of the profile”

        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()
        “Name of the profile”
        Returns:
        property displayName
      • withDisplayName

        public EnrollmentProfile 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.

        “Name of the profile”

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

        public Optional<Boolean> getEnableAuthenticationViaCompanyPortal()
        “Indicates to authenticate with Apple Setup Assistant instead of Company Portal.”
        Returns:
        property enableAuthenticationViaCompanyPortal
      • withEnableAuthenticationViaCompanyPortal

        public EnrollmentProfile withEnableAuthenticationViaCompanyPortal​(Boolean enableAuthenticationViaCompanyPortal)
        Returns an immutable copy of this with just the enableAuthenticationViaCompanyPortal 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.

        “Indicates to authenticate with Apple Setup Assistant instead of Company Portal.”

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

        public Optional<Boolean> getRequireCompanyPortalOnSetupAssistantEnrolledDevices()
        “Indicates that Company Portal is required on setup assistant enrolled devices”
        Returns:
        property requireCompanyPortalOnSetupAssistantEnrolledDevices
      • withRequireCompanyPortalOnSetupAssistantEnrolledDevices

        public EnrollmentProfile withRequireCompanyPortalOnSetupAssistantEnrolledDevices​(Boolean requireCompanyPortalOnSetupAssistantEnrolledDevices)
        Returns an immutable copy of this with just the requireCompanyPortalOnSetupAssistantEnrolledDevices 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.

        “Indicates that Company Portal is required on setup assistant enrolled devices”

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

        public Optional<Boolean> getRequiresUserAuthentication()
        “Indicates if the profile requires user authentication”
        Returns:
        property requiresUserAuthentication
      • withRequiresUserAuthentication

        public EnrollmentProfile withRequiresUserAuthentication​(Boolean requiresUserAuthentication)
        Returns an immutable copy of this with just the requiresUserAuthentication 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.

        “Indicates if the profile requires user authentication”

        Parameters:
        requiresUserAuthentication - new value of requiresUserAuthentication field (as defined in service metadata)
        Returns:
        immutable copy of this with just the requiresUserAuthentication 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 EnrollmentProfile 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 EnrollmentProfile 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
      • setDefaultProfile

        public com.github.davidmoten.odata.client.ActionRequestNoReturn setDefaultProfile()
      • updateDeviceProfileAssignment

        public com.github.davidmoten.odata.client.ActionRequestNoReturn updateDeviceProfileAssignment​(List<String> deviceIds)
      • exportMobileConfig

        public com.github.davidmoten.odata.client.FunctionRequestReturningNonCollection<String> exportMobileConfig()