Class: MicrosoftGraph::Models::DeviceManagementExportJob

Inherits:
Entity
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/device_management_export_job.rb

Overview

Entity representing a job to export a report

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Entity

#additional_data, #additional_data=, #id, #id=, #odata_type, #odata_type=

Constructor Details

#initialize ⇒ Object

Instantiates a new deviceManagementExportJob and sets the default values.



46
47
48
 
# File 'lib/models/device_management_export_job.rb', line 46

def initialize()
    super
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a device_management_export_job

Raises:

  • (StandardError) 


54
55
56
57
 
# File 'lib/models/device_management_export_job.rb', line 54

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return DeviceManagementExportJob.new
end

Instance Method Details

#expiration_date_time ⇒ Object

Gets the expirationDateTime property value. Time that the exported report expires

Returns:

  • a date_time



62
63
64
 
# File 'lib/models/device_management_export_job.rb', line 62

def expiration_date_time
    return @expiration_date_time
end

#expiration_date_time=(value) ⇒ Object

Sets the expirationDateTime property value. Time that the exported report expires

Parameters:

  • value —

    Value to set for the expirationDateTime property.

Returns:

  • a void



70
71
72
 
# File 'lib/models/device_management_export_job.rb', line 70

def expiration_date_time=(value)
    @expiration_date_time = value
end

#filter ⇒ Object

Gets the filter property value. Filters applied on the report

Returns:

  • a string



77
78
79
 
# File 'lib/models/device_management_export_job.rb', line 77

def filter
    return @filter
end

#filter=(value) ⇒ Object

Sets the filter property value. Filters applied on the report

Parameters:

  • value —

    Value to set for the filter property.

Returns:

  • a void



85
86
87
 
# File 'lib/models/device_management_export_job.rb', line 85

def filter=(value)
    @filter = value
end

#format ⇒ Object

Gets the format property value. Possible values for the file format of a report

Returns:

  • a device_management_report_file_format



92
93
94
 
# File 'lib/models/device_management_export_job.rb', line 92

def format
    return @format
end

#format=(value) ⇒ Object

Sets the format property value. Possible values for the file format of a report

Parameters:

  • value —

    Value to set for the format property.

Returns:

  • a void



100
101
102
 
# File 'lib/models/device_management_export_job.rb', line 100

def format=(value)
    @format = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/models/device_management_export_job.rb', line 107

def get_field_deserializers()
    return super.merge({
        "expirationDateTime" => lambda {|n| @expiration_date_time = n.get_date_time_value() },
        "filter" => lambda {|n| @filter = n.get_string_value() },
        "format" => lambda {|n| @format = n.get_enum_value(MicrosoftGraph::Models::DeviceManagementReportFileFormat) },
        "localizationType" => lambda {|n| @localization_type = n.get_enum_value(MicrosoftGraph::Models::DeviceManagementExportJobLocalizationType) },
        "reportName" => lambda {|n| @report_name = n.get_string_value() },
        "requestDateTime" => lambda {|n| @request_date_time = n.get_date_time_value() },
        "select" => lambda {|n| @select = n.get_collection_of_primitive_values(String) },
        "snapshotId" => lambda {|n| @snapshot_id = n.get_string_value() },
        "status" => lambda {|n| @status = n.get_enum_value(MicrosoftGraph::Models::DeviceManagementReportStatus) },
        "url" => lambda {|n| @url = n.get_string_value() },
    })
end

#localization_type ⇒ Object

Gets the localizationType property value. Configures how the requested export job is localized

Returns:

  • a device_management_export_job_localization_type



125
126
127
 
# File 'lib/models/device_management_export_job.rb', line 125

def localization_type
    return @localization_type
end

#localization_type=(value) ⇒ Object

Sets the localizationType property value. Configures how the requested export job is localized

Parameters:

  • value —

    Value to set for the localizationType property.

Returns:

  • a void



133
134
135
 
# File 'lib/models/device_management_export_job.rb', line 133

def localization_type=(value)
    @localization_type = value
end

#report_name ⇒ Object

Gets the reportName property value. Name of the report

Returns:

  • a string



140
141
142
 
# File 'lib/models/device_management_export_job.rb', line 140

def report_name
    return @report_name
end

#report_name=(value) ⇒ Object

Sets the reportName property value. Name of the report

Parameters:

  • value —

    Value to set for the reportName property.

Returns:

  • a void



148
149
150
 
# File 'lib/models/device_management_export_job.rb', line 148

def report_name=(value)
    @report_name = value
end

#request_date_time ⇒ Object

Gets the requestDateTime property value. Time that the exported report was requested

Returns:

  • a date_time



155
156
157
 
# File 'lib/models/device_management_export_job.rb', line 155

def request_date_time
    return @request_date_time
end

#request_date_time=(value) ⇒ Object

Sets the requestDateTime property value. Time that the exported report was requested

Parameters:

  • value —

    Value to set for the requestDateTime property.

Returns:

  • a void



163
164
165
 
# File 'lib/models/device_management_export_job.rb', line 163

def request_date_time=(value)
    @request_date_time = value
end

#select ⇒ Object

Gets the select property value. Columns selected from the report

Returns:

  • a string



170
171
172
 
# File 'lib/models/device_management_export_job.rb', line 170

def select
    return @select
end

#select=(value) ⇒ Object

Sets the select property value. Columns selected from the report

Parameters:

  • value —

    Value to set for the select property.

Returns:

  • a void



178
179
180
 
# File 'lib/models/device_management_export_job.rb', line 178

def select=(value)
    @select = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/models/device_management_export_job.rb', line 186

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_date_time_value("expirationDateTime", @expiration_date_time)
    writer.write_string_value("filter", @filter)
    writer.write_enum_value("format", @format)
    writer.write_enum_value("localizationType", @localization_type)
    writer.write_string_value("reportName", @report_name)
    writer.write_date_time_value("requestDateTime", @request_date_time)
    writer.write_collection_of_primitive_values("select", @select)
    writer.write_string_value("snapshotId", @snapshot_id)
    writer.write_enum_value("status", @status)
    writer.write_string_value("url", @url)
end

#snapshot_id ⇒ Object

Gets the snapshotId property value. 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.

Returns:

  • a string



204
205
206
 
# File 'lib/models/device_management_export_job.rb', line 204

def snapshot_id
    return @snapshot_id
end

#snapshot_id=(value) ⇒ Object

Sets the snapshotId property value. 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.

Parameters:

  • value —

    Value to set for the snapshotId property.

Returns:

  • a void



212
213
214
 
# File 'lib/models/device_management_export_job.rb', line 212

def snapshot_id=(value)
    @snapshot_id = value
end

#status ⇒ Object

Gets the status property value. Possible statuses associated with a generated report

Returns:

  • a device_management_report_status



219
220
221
 
# File 'lib/models/device_management_export_job.rb', line 219

def status
    return @status
end

#status=(value) ⇒ Object

Sets the status property value. Possible statuses associated with a generated report

Parameters:

  • value —

    Value to set for the status property.

Returns:

  • a void



227
228
229
 
# File 'lib/models/device_management_export_job.rb', line 227

def status=(value)
    @status = value
end

#url ⇒ Object

Gets the url property value. Temporary location of the exported report

Returns:

  • a string



234
235
236
 
# File 'lib/models/device_management_export_job.rb', line 234

def url
    return @url
end

#url=(value) ⇒ Object

Sets the url property value. Temporary location of the exported report

Parameters:

  • value —

    Value to set for the url property.

Returns:

  • a void



242
243
244
 
# File 'lib/models/device_management_export_job.rb', line 242

def url=(value)
    @url = value
end