Class: MicrosoftGraph::Models::SynchronizationJobRestartCriteria

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new synchronizationJobRestartCriteria and sets the default values.



37
38
39
 
# File 'lib/models/synchronization_job_restart_criteria.rb', line 37

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_job_restart_criteria

Raises:

  • (StandardError) 


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

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



22
23
24
 
# File 'lib/models/synchronization_job_restart_criteria.rb', line 22

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



30
31
32
 
# File 'lib/models/synchronization_job_restart_criteria.rb', line 30

def additional_data=(value)
    @additional_data = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



53
54
55
56
57
58
 
# File 'lib/models/synchronization_job_restart_criteria.rb', line 53

def get_field_deserializers()
    return {
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "resetScope" => lambda {|n| @reset_scope = n.get_enum_value(MicrosoftGraph::Models::SynchronizationJobRestartScope) },
    }
end

#odata_type ⇒ Object

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

Returns:

  • a string



63
64
65
 
# File 'lib/models/synchronization_job_restart_criteria.rb', line 63

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



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

def odata_type=(value)
    @odata_type = value
end

#reset_scope ⇒ Object

Gets the resetScope property value. Comma-separated combination of the following values: None, ConnectorDataStore, Escrows, Watermark, QuarantineState, Full, ForceDeletes. The property can also be empty. None: Starts a paused or quarantined provisioning job. DO NOT USE. Use the Start synchronizationJob API instead.ConnectorDataStore - Clears the underlying cache for all users. DO NOT USE. Contact Microsoft Support for guidance.Escrows - Provisioning failures are marked as escrows and retried. Clearing escrows will stop the service from retrying failures.Watermark - Removing the watermark causes the service to re-evaluate all the users again, rather than just processing changes.QuarantineState - Temporarily lifts the quarantine.Use Full if you want all of the options.ForceDeletes - Forces the system to delete the pending deleted users when using the accidental deletions prevention feature and the deletion threshold is exceeded. Leaving this property empty emulates the Restart provisioning option in the Azure portal. It is similar to setting the resetScope to include QuarantineState, Watermark, and Escrows. This option meets most customer needs.

Returns:

  • a synchronization_job_restart_scope



78
79
80
 
# File 'lib/models/synchronization_job_restart_criteria.rb', line 78

def reset_scope
    return @reset_scope
end

#reset_scope=(value) ⇒ Object

Sets the resetScope property value. Comma-separated combination of the following values: None, ConnectorDataStore, Escrows, Watermark, QuarantineState, Full, ForceDeletes. The property can also be empty. None: Starts a paused or quarantined provisioning job. DO NOT USE. Use the Start synchronizationJob API instead.ConnectorDataStore - Clears the underlying cache for all users. DO NOT USE. Contact Microsoft Support for guidance.Escrows - Provisioning failures are marked as escrows and retried. Clearing escrows will stop the service from retrying failures.Watermark - Removing the watermark causes the service to re-evaluate all the users again, rather than just processing changes.QuarantineState - Temporarily lifts the quarantine.Use Full if you want all of the options.ForceDeletes - Forces the system to delete the pending deleted users when using the accidental deletions prevention feature and the deletion threshold is exceeded. Leaving this property empty emulates the Restart provisioning option in the Azure portal. It is similar to setting the resetScope to include QuarantineState, Watermark, and Escrows. This option meets most customer needs.

Parameters:

  • value —

    Value to set for the resetScope property.

Returns:

  • a void



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

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


94
95
96
97
98
99
 
# File 'lib/models/synchronization_job_restart_criteria.rb', line 94

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_enum_value("resetScope", @reset_scope)
    writer.write_additional_data(@additional_data)
end