Class: MicrosoftGraph::Models::RichLongRunningOperation

Inherits:
LongRunningOperation show all
Includes:
MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/rich_long_running_operation.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from LongRunningOperation

#created_date_time, #created_date_time=, #last_action_date_time, #last_action_date_time=, #resource_location, #resource_location=, #status, #status=, #status_detail, #status_detail=

Methods inherited from Entity

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

Constructor Details

#initializeObject

Instantiates a new richLongRunningOperation and sets the default values.



25
26
27
# File 'lib/models/rich_long_running_operation.rb', line 25

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 rich_long_running_operation

Raises:

  • (StandardError)


33
34
35
36
# File 'lib/models/rich_long_running_operation.rb', line 33

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

Instance Method Details

#errorObject

Gets the error property value. Error that caused the operation to fail.

Returns:

  • a public_error



41
42
43
# File 'lib/models/rich_long_running_operation.rb', line 41

def error
    return @error
end

#error=(value) ⇒ Object

Sets the error property value. Error that caused the operation to fail.

Parameters:

  • value

    Value to set for the error property.

Returns:

  • a void



49
50
51
# File 'lib/models/rich_long_running_operation.rb', line 49

def error=(value)
    @error = value
end

#get_field_deserializersObject

The deserialization information for the current model

Returns:

  • a i_dictionary



56
57
58
59
60
61
62
63
# File 'lib/models/rich_long_running_operation.rb', line 56

def get_field_deserializers()
    return super.merge({
        "error" => lambda {|n| @error = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::PublicError.create_from_discriminator_value(pn) }) },
        "percentageComplete" => lambda {|n| @percentage_complete = n.get_number_value() },
        "resourceId" => lambda {|n| @resource_id = n.get_string_value() },
        "type" => lambda {|n| @type = n.get_string_value() },
    })
end

#percentage_completeObject

Gets the percentageComplete property value. A value between 0 and 100 that indicates the progress of the operation.

Returns:

  • a integer



68
69
70
# File 'lib/models/rich_long_running_operation.rb', line 68

def percentage_complete
    return @percentage_complete
end

#percentage_complete=(value) ⇒ Object

Sets the percentageComplete property value. A value between 0 and 100 that indicates the progress of the operation.

Parameters:

  • value

    Value to set for the percentageComplete property.

Returns:

  • a void



76
77
78
# File 'lib/models/rich_long_running_operation.rb', line 76

def percentage_complete=(value)
    @percentage_complete = value
end

#resource_idObject

Gets the resourceId property value. The unique identifier for the result.

Returns:

  • a string



83
84
85
# File 'lib/models/rich_long_running_operation.rb', line 83

def resource_id
    return @resource_id
end

#resource_id=(value) ⇒ Object

Sets the resourceId property value. The unique identifier for the result.

Parameters:

  • value

    Value to set for the resourceId property.

Returns:

  • a void



91
92
93
# File 'lib/models/rich_long_running_operation.rb', line 91

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


99
100
101
102
103
104
105
106
# File 'lib/models/rich_long_running_operation.rb', line 99

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    super
    writer.write_object_value("error", @error)
    writer.write_number_value("percentageComplete", @percentage_complete)
    writer.write_string_value("resourceId", @resource_id)
    writer.write_string_value("type", @type)
end

#typeObject

Gets the type property value. The type of the operation.

Returns:

  • a string



111
112
113
# File 'lib/models/rich_long_running_operation.rb', line 111

def type
    return @type
end

#type=(value) ⇒ Object

Sets the type property value. The type of the operation.

Parameters:

  • value

    Value to set for the type property.

Returns:

  • a void



119
120
121
# File 'lib/models/rich_long_running_operation.rb', line 119

def type=(value)
    @type = value
end