Package odata.msgraph.client.entity

Class DeviceManagementExportJob

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
    public class DeviceManagementExportJob
extends Entity
implements com.github.davidmoten.odata.client.ODataEntityType
    “Entity representing a job to export a report.”

    • Constructor Detail

      • DeviceManagementExportJob

        protected DeviceManagementExportJob()

    • Method Detail

      • odataTypeName

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

      • builderDeviceManagementExportJob

        public static DeviceManagementExportJob.Builder builderDeviceManagementExportJob()
        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

      • getExpirationDateTime

        public Optional<OffsetDateTime> getExpirationDateTime()
        “Time that the exported report expires.”
        Returns:
        property expirationDateTime

      • withExpirationDateTime

        public DeviceManagementExportJob withExpirationDateTime​(OffsetDateTime expirationDateTime)
        Returns an immutable copy of this with just the expirationDateTime 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.

        “Time that the exported report expires.”

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

      • getFilter

        public Optional<String> getFilter()
        “Filters applied on the report. The maximum length allowed for this property is 2000 characters.”
        Returns:
        property filter

      • withFilter

        public DeviceManagementExportJob withFilter​(String filter)
        Returns an immutable copy of this with just the filter 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.

        “Filters applied on the report. The maximum length allowed for this property is 2000 characters.”

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

      • withFormat

        public DeviceManagementExportJob withFormat​(DeviceManagementReportFileFormat format)
        Returns an immutable copy of this with just the format 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.

        “Format of the exported report. Possible values are `csv` and `json`.”

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

      • getLocalizationType

        public Optional<DeviceManagementExportJobLocalizationType> getLocalizationType()
        “Configures how the requested export job is localized. Possible values are ` replaceLocalizableValues` and `localizedValuesAsAdditionalColumn`.”
        Returns:
        property localizationType

      • withLocalizationType

        public DeviceManagementExportJob withLocalizationType​(DeviceManagementExportJobLocalizationType localizationType)
        Returns an immutable copy of this with just the localizationType 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.

        “Configures how the requested export job is localized. Possible values are ` replaceLocalizableValues` and `localizedValuesAsAdditionalColumn`.”

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

      • getReportName

        public Optional<String> getReportName()
        “Name of the report. The maximum length allowed for this property is 2000 characters.”
        Returns:
        property reportName

      • withReportName

        public DeviceManagementExportJob withReportName​(String reportName)
        Returns an immutable copy of this with just the reportName 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 report. The maximum length allowed for this property is 2000 characters.”

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

      • getRequestDateTime

        public Optional<OffsetDateTime> getRequestDateTime()
        “Time that the exported report was requested.”
        Returns:
        property requestDateTime

      • withRequestDateTime

        public DeviceManagementExportJob withRequestDateTime​(OffsetDateTime requestDateTime)
        Returns an immutable copy of this with just the requestDateTime 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.

        “Time that the exported report was requested.”

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

      • getSelect

        public com.github.davidmoten.odata.client.CollectionPage<String> getSelect()
        “Columns selected from the report. The maximum number of allowed columns names is 256. The maximum length allowed for each column name in this property is 1000 characters.”
        Returns:
        property select

      • withSelect

        public DeviceManagementExportJob withSelect​(List<String> select)
        Returns an immutable copy of this with just the select 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.

        “Columns selected from the report. The maximum number of allowed columns names is 256. The maximum length allowed for each column name in this property is 1000 characters.”

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

      • getSelect

        public com.github.davidmoten.odata.client.CollectionPage<String> getSelect​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Columns selected from the report. The maximum number of allowed columns names is 256. The maximum length allowed for each column name in this property is 1000 characters.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property select

      • getSnapshotId

        public Optional<String> getSnapshotId()
        “A snapshot is an identifiable subset of the dataset represented by the ReportName. A sessionId or CachedReportConfiguration id can be used here. If a sessionId is specified, Filter, Select, and OrderBy are applied to the data represented by the sessionId. Filter, Select, and OrderBy cannot be specified together with a CachedReportConfiguration id. The maximum length allowed for this property is 128 characters.”
        Returns:
        property snapshotId

      • withSnapshotId

        public DeviceManagementExportJob withSnapshotId​(String snapshotId)
        Returns an immutable copy of this with just the snapshotId 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.

        “A snapshot is an identifiable subset of the dataset represented by the ReportName. A sessionId or CachedReportConfiguration id can be used here. If a sessionId is specified, Filter, Select, and OrderBy are applied to the data represented by the sessionId. Filter, Select, and OrderBy cannot be specified together with a CachedReportConfiguration id. The maximum length allowed for this property is 128 characters.”

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

      • getStatus

        public Optional<DeviceManagementReportStatus> getStatus()
        “Status of the export job. Possible values are `unknown`, `notStarted`, ` inProgress`, `completed` and `failed`.”
        Returns:
        property status

      • withStatus

        public DeviceManagementExportJob withStatus​(DeviceManagementReportStatus status)
        Returns an immutable copy of this with just the status 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.

        “Status of the export job. Possible values are `unknown`, `notStarted`, ` inProgress`, `completed` and `failed`.”

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

      • getUrl

        public Optional<String> getUrl()
        “Temporary location of the exported report.”
        Returns:
        property url

      • withUrl

        public DeviceManagementExportJob withUrl​(String url)
        Returns an immutable copy of this with just the url 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.

        “Temporary location of the exported report.”

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