Class: MicrosoftGraph::Models::SynchronizationStatus

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new synchronizationStatus and sets the default values.



86
87
88
 
# File 'lib/models/synchronization_status.rb', line 86

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 synchronization_status

Raises:

  • (StandardError) 


109
110
111
112
 
# File 'lib/models/synchronization_status.rb', line 109

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return SynchronizationStatus.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



56
57
58
 
# File 'lib/models/synchronization_status.rb', line 56

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



64
65
66
 
# File 'lib/models/synchronization_status.rb', line 64

def additional_data=(value)
    @additional_data = value
end

#code ⇒ Object

Gets the code property value. The code property

Returns:

  • a synchronization_status_code



71
72
73
 
# File 'lib/models/synchronization_status.rb', line 71

def code
    return @code
end

#code=(value) ⇒ Object

Sets the code property value. The code property

Parameters:

  • value —

    Value to set for the code property.

Returns:

  • a void



79
80
81
 
# File 'lib/models/synchronization_status.rb', line 79

def code=(value)
    @code = value
end

#count_successive_complete_failures ⇒ Object

Gets the countSuccessiveCompleteFailures property value. Number of consecutive times this job failed.

Returns:

  • a int64



93
94
95
 
# File 'lib/models/synchronization_status.rb', line 93

def count_successive_complete_failures
    return @count_successive_complete_failures
end

#count_successive_complete_failures=(value) ⇒ Object

Sets the countSuccessiveCompleteFailures property value. Number of consecutive times this job failed.

Parameters:

  • value —

    Value to set for the countSuccessiveCompleteFailures property.

Returns:

  • a void



101
102
103
 
# File 'lib/models/synchronization_status.rb', line 101

def count_successive_complete_failures=(value)
    @count_successive_complete_failures = value
end

#escrows_pruned ⇒ Object

Gets the escrowsPruned property value. true if the job's escrows (object-level errors) were pruned during initial synchronization. Escrows can be pruned if during the initial synchronization, you reach the threshold of errors that would normally put the job in quarantine. Instead of going into quarantine, the synchronization process clears the job's errors and continues until the initial synchronization is completed. When the initial synchronization is completed, the job will pause and wait for the customer to clean up the errors.

Returns:

  • a boolean



117
118
119
 
# File 'lib/models/synchronization_status.rb', line 117

def escrows_pruned
    return @escrows_pruned
end

#escrows_pruned=(value) ⇒ Object

Sets the escrowsPruned property value. true if the job's escrows (object-level errors) were pruned during initial synchronization. Escrows can be pruned if during the initial synchronization, you reach the threshold of errors that would normally put the job in quarantine. Instead of going into quarantine, the synchronization process clears the job's errors and continues until the initial synchronization is completed. When the initial synchronization is completed, the job will pause and wait for the customer to clean up the errors.

Parameters:

  • value —

    Value to set for the escrowsPruned property.

Returns:

  • a void



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

def escrows_pruned=(value)
    @escrows_pruned = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/models/synchronization_status.rb', line 132

def get_field_deserializers()
    return {
        "code" => lambda {|n| @code = n.get_enum_value(MicrosoftGraph::Models::SynchronizationStatusCode) },
        "countSuccessiveCompleteFailures" => lambda {|n| @count_successive_complete_failures = n.get_object_value(lambda {|pn| Int64.create_from_discriminator_value(pn) }) },
        "escrowsPruned" => lambda {|n| @escrows_pruned = n.get_boolean_value() },
        "lastExecution" => lambda {|n| @last_execution = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SynchronizationTaskExecution.create_from_discriminator_value(pn) }) },
        "lastSuccessfulExecution" => lambda {|n| @last_successful_execution = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SynchronizationTaskExecution.create_from_discriminator_value(pn) }) },
        "lastSuccessfulExecutionWithExports" => lambda {|n| @last_successful_execution_with_exports = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SynchronizationTaskExecution.create_from_discriminator_value(pn) }) },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "progress" => lambda {|n| @progress = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::SynchronizationProgress.create_from_discriminator_value(pn) }) },
        "quarantine" => lambda {|n| @quarantine = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::SynchronizationQuarantine.create_from_discriminator_value(pn) }) },
        "steadyStateFirstAchievedTime" => lambda {|n| @steady_state_first_achieved_time = n.get_date_time_value() },
        "steadyStateLastAchievedTime" => lambda {|n| @steady_state_last_achieved_time = n.get_date_time_value() },
        "synchronizedEntryCountByType" => lambda {|n| @synchronized_entry_count_by_type = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::StringKeyLongValuePair.create_from_discriminator_value(pn) }) },
        "troubleshootingUrl" => lambda {|n| @troubleshooting_url = n.get_string_value() },
    }
end

#last_execution ⇒ Object

Gets the lastExecution property value. Details of the last execution of the job.

Returns:

  • a synchronization_task_execution



153
154
155
 
# File 'lib/models/synchronization_status.rb', line 153

def last_execution
    return @last_execution
end

#last_execution=(value) ⇒ Object

Sets the lastExecution property value. Details of the last execution of the job.

Parameters:

  • value —

    Value to set for the lastExecution property.

Returns:

  • a void



161
162
163
 
# File 'lib/models/synchronization_status.rb', line 161

def last_execution=(value)
    @last_execution = value
end

#last_successful_execution ⇒ Object

Gets the lastSuccessfulExecution property value. Details of the last execution of this job, which didn't have any errors.

Returns:

  • a synchronization_task_execution



168
169
170
 
# File 'lib/models/synchronization_status.rb', line 168

def last_successful_execution
    return @last_successful_execution
end

#last_successful_execution=(value) ⇒ Object

Sets the lastSuccessfulExecution property value. Details of the last execution of this job, which didn't have any errors.

Parameters:

  • value —

    Value to set for the lastSuccessfulExecution property.

Returns:

  • a void



176
177
178
 
# File 'lib/models/synchronization_status.rb', line 176

def last_successful_execution=(value)
    @last_successful_execution = value
end

#last_successful_execution_with_exports ⇒ Object

Gets the lastSuccessfulExecutionWithExports property value. Details of the last execution of the job, which exported objects into the target directory.

Returns:

  • a synchronization_task_execution



183
184
185
 
# File 'lib/models/synchronization_status.rb', line 183

def last_successful_execution_with_exports
    return @last_successful_execution_with_exports
end

#last_successful_execution_with_exports=(value) ⇒ Object

Sets the lastSuccessfulExecutionWithExports property value. Details of the last execution of the job, which exported objects into the target directory.

Parameters:

  • value —

    Value to set for the lastSuccessfulExecutionWithExports property.

Returns:

  • a void



191
192
193
 
# File 'lib/models/synchronization_status.rb', line 191

def last_successful_execution_with_exports=(value)
    @last_successful_execution_with_exports = value
end

#odata_type ⇒ Object

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

Returns:

  • a string



198
199
200
 
# File 'lib/models/synchronization_status.rb', line 198

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



206
207
208
 
# File 'lib/models/synchronization_status.rb', line 206

def odata_type=(value)
    @odata_type = value
end

#progress ⇒ Object

Gets the progress property value. Details of the progress of a job toward completion.

Returns:

  • a synchronization_progress



213
214
215
 
# File 'lib/models/synchronization_status.rb', line 213

def progress
    return @progress
end

#progress=(value) ⇒ Object

Sets the progress property value. Details of the progress of a job toward completion.

Parameters:

  • value —

    Value to set for the progress property.

Returns:

  • a void



221
222
223
 
# File 'lib/models/synchronization_status.rb', line 221

def progress=(value)
    @progress = value
end

#quarantine ⇒ Object

Gets the quarantine property value. If job is in quarantine, quarantine details.

Returns:

  • a synchronization_quarantine



228
229
230
 
# File 'lib/models/synchronization_status.rb', line 228

def quarantine
    return @quarantine
end

#quarantine=(value) ⇒ Object

Sets the quarantine property value. If job is in quarantine, quarantine details.

Parameters:

  • value —

    Value to set for the quarantine property.

Returns:

  • a void



236
237
238
 
# File 'lib/models/synchronization_status.rb', line 236

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


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/models/synchronization_status.rb', line 244

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_enum_value("code", @code)
    writer.write_object_value("countSuccessiveCompleteFailures", @count_successive_complete_failures)
    writer.write_boolean_value("escrowsPruned", @escrows_pruned)
    writer.write_object_value("lastExecution", @last_execution)
    writer.write_object_value("lastSuccessfulExecution", @last_successful_execution)
    writer.write_object_value("lastSuccessfulExecutionWithExports", @last_successful_execution_with_exports)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_collection_of_object_values("progress", @progress)
    writer.write_object_value("quarantine", @quarantine)
    writer.write_date_time_value("steadyStateFirstAchievedTime", @steady_state_first_achieved_time)
    writer.write_date_time_value("steadyStateLastAchievedTime", @steady_state_last_achieved_time)
    writer.write_collection_of_object_values("synchronizedEntryCountByType", @synchronized_entry_count_by_type)
    writer.write_string_value("troubleshootingUrl", @troubleshooting_url)
    writer.write_additional_data(@additional_data)
end

#steady_state_first_achieved_time ⇒ Object

Gets the steadyStateFirstAchievedTime property value. The time when steady state (no more changes to the process) was first achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returns:

  • a date_time



265
266
267
 
# File 'lib/models/synchronization_status.rb', line 265

def steady_state_first_achieved_time
    return @steady_state_first_achieved_time
end

#steady_state_first_achieved_time=(value) ⇒ Object

Sets the steadyStateFirstAchievedTime property value. The time when steady state (no more changes to the process) was first achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Parameters:

  • value —

    Value to set for the steadyStateFirstAchievedTime property.

Returns:

  • a void



273
274
275
 
# File 'lib/models/synchronization_status.rb', line 273

def steady_state_first_achieved_time=(value)
    @steady_state_first_achieved_time = value
end

#steady_state_last_achieved_time ⇒ Object

Gets the steadyStateLastAchievedTime property value. The time when steady state (no more changes to the process) was last achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Returns:

  • a date_time



280
281
282
 
# File 'lib/models/synchronization_status.rb', line 280

def steady_state_last_achieved_time
    return @steady_state_last_achieved_time
end

#steady_state_last_achieved_time=(value) ⇒ Object

Sets the steadyStateLastAchievedTime property value. The time when steady state (no more changes to the process) was last achieved. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.

Parameters:

  • value —

    Value to set for the steadyStateLastAchievedTime property.

Returns:

  • a void



288
289
290
 
# File 'lib/models/synchronization_status.rb', line 288

def steady_state_last_achieved_time=(value)
    @steady_state_last_achieved_time = value
end

#synchronized_entry_count_by_type ⇒ Object

Gets the synchronizedEntryCountByType property value. Count of synchronized objects, listed by object type.

Returns:

  • a string_key_long_value_pair



295
296
297
 
# File 'lib/models/synchronization_status.rb', line 295

def synchronized_entry_count_by_type
    return @synchronized_entry_count_by_type
end

#synchronized_entry_count_by_type=(value) ⇒ Object

Sets the synchronizedEntryCountByType property value. Count of synchronized objects, listed by object type.

Parameters:

  • value —

    Value to set for the synchronizedEntryCountByType property.

Returns:

  • a void



303
304
305
 
# File 'lib/models/synchronization_status.rb', line 303

def synchronized_entry_count_by_type=(value)
    @synchronized_entry_count_by_type = value
end

#troubleshooting_url ⇒ Object

Gets the troubleshootingUrl property value. In the event of an error, the URL with the troubleshooting steps for the issue.

Returns:

  • a string



310
311
312
 
# File 'lib/models/synchronization_status.rb', line 310

def troubleshooting_url
    return @troubleshooting_url
end

#troubleshooting_url=(value) ⇒ Object

Sets the troubleshootingUrl property value. In the event of an error, the URL with the troubleshooting steps for the issue.

Parameters:

  • value —

    Value to set for the troubleshootingUrl property.

Returns:

  • a void



318
319
320
 
# File 'lib/models/synchronization_status.rb', line 318

def troubleshooting_url=(value)
    @troubleshooting_url = value
end