Class: MicrosoftGraph::Models::PrintJobStatus

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/print_job_status.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new printJobStatus and sets the default values.



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

def initialize()
    @additional_data = Hash.new
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 print_job_status

Raises:

  • (StandardError) 


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

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

Instance Method Details

#additional_data ⇒ Object

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



31
32
33
 
# File 'lib/models/print_job_status.rb', line 31

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value —

    Value to set for the additionalData property.

Returns:

  • a void



39
40
41
 
# File 'lib/models/print_job_status.rb', line 39

def additional_data=(value)
    @additional_data = value
end

#description ⇒ Object

Gets the description property value. A human-readable description of the print job’s current processing state. Read-only.

Returns:

  • a string



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

def description
    return @description
end

#description=(value) ⇒ Object

Sets the description property value. A human-readable description of the print job’s current processing state. Read-only.

Parameters:

  • value —

    Value to set for the description property.

Returns:

  • a void



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

def description=(value)
    @description = value
end

#details ⇒ Object

Gets the details property value. Additional details for print job state. Valid values are described in the following table. Read-only.

Returns:

  • a print_job_state_detail



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

def details
    return @details
end

#details=(value) ⇒ Object

Sets the details property value. Additional details for print job state. Valid values are described in the following table. Read-only.

Parameters:

  • value —

    Value to set for the details property.

Returns:

  • a void



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

def details=(value)
    @details = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



92
93
94
95
96
97
98
99
100
 
# File 'lib/models/print_job_status.rb', line 92

def get_field_deserializers()
    return {
        "description" => lambda {|n| @description = n.get_string_value() },
        "details" => lambda {|n| @details = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::PrintJobStateDetail.create_from_discriminator_value(pn) }) },
        "isAcquiredByPrinter" => lambda {|n| @is_acquired_by_printer = n.get_boolean_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "state" => lambda {|n| @state = n.get_enum_value(MicrosoftGraph::Models::PrintJobProcessingState) },
    }
end

#is_acquired_by_printer ⇒ Object

Gets the isAcquiredByPrinter property value. True if the job was acknowledged by a printer; false otherwise. Read-only.

Returns:

  • a boolean



105
106
107
 
# File 'lib/models/print_job_status.rb', line 105

def is_acquired_by_printer
    return @is_acquired_by_printer
end

#is_acquired_by_printer=(value) ⇒ Object

Sets the isAcquiredByPrinter property value. True if the job was acknowledged by a printer; false otherwise. Read-only.

Parameters:

  • value —

    Value to set for the isAcquiredByPrinter property.

Returns:

  • a void



113
114
115
 
# File 'lib/models/print_job_status.rb', line 113

def is_acquired_by_printer=(value)
    @is_acquired_by_printer = value
end

#odata_type ⇒ Object

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



120
121
122
 
# File 'lib/models/print_job_status.rb', line 120

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value —

    Value to set for the @odata.type property.

Returns:

  • a void



128
129
130
 
# File 'lib/models/print_job_status.rb', line 128

def odata_type=(value)
    @odata_type = 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) 


136
137
138
139
140
141
142
143
144
 
# File 'lib/models/print_job_status.rb', line 136

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("description", @description)
    writer.write_collection_of_object_values("details", @details)
    writer.write_boolean_value("isAcquiredByPrinter", @is_acquired_by_printer)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_enum_value("state", @state)
    writer.write_additional_data(@additional_data)
end

#state ⇒ Object

Gets the state property value. The state property

Returns:

  • a print_job_processing_state



149
150
151
 
# File 'lib/models/print_job_status.rb', line 149

def state
    return @state
end

#state=(value) ⇒ Object

Sets the state property value. The state property

Parameters:

  • value —

    Value to set for the state property.

Returns:

  • a void



157
158
159
 
# File 'lib/models/print_job_status.rb', line 157

def state=(value)
    @state = value
end