🔍 Code Extractor

A class representing the criteria for restarting a synchronization job in Microsoft 365/Office 365 services.

Purpose

This class serves as a data transfer object (DTO) that defines the scope and criteria for restarting a synchronization job. It inherits from ClientValue, which is part of the Office 365 REST API client framework, and is used to encapsulate parameters when making REST API calls to restart synchronization jobs in Microsoft 365 services such as Azure AD synchronization.

Source Code

class SynchronizationJobRestartCriteria(ClientValue):
    """Defines the scope of the synchronizationJob: restart action."""

Parameters

Parameter Details

bases: Inherits from ClientValue, which provides base functionality for client-side value objects used in Office 365 REST API operations. This base class typically handles serialization/deserialization to/from JSON for API communication.

Return Value

Instantiation returns a SynchronizationJobRestartCriteria object that can be used to specify restart criteria for synchronization jobs. The object itself serves as a container for criteria properties that will be serialized when making API calls.

Class Interface

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.directory.synchronization.job_restart_criteria import SynchronizationJobRestartCriteria

Usage Example

from office365.directory.synchronization.job_restart_criteria import SynchronizationJobRestartCriteria
from office365.runtime.client_value import ClientValue

# Instantiate the criteria object
criteria = SynchronizationJobRestartCriteria()

# The object would typically be used with a synchronization job client
# to specify restart parameters when calling a restart method
# Example (conceptual):
# sync_job.restart(criteria=criteria)

Best Practices

• This class is typically instantiated and populated with criteria properties before being passed to a synchronization job restart method
• As a ClientValue subclass, this object is designed to be serialized to JSON for REST API calls, so ensure any added properties are JSON-serializable
• The class appears to be a skeleton/placeholder that may be extended with specific properties for restart criteria in actual usage
• Should be used in conjunction with Office 365 synchronization job management APIs
• Ensure proper authentication and authorization are in place before attempting to restart synchronization jobs

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class SynchronizationStatus 61.6% similar

  A data class representing the current status of a synchronization job, including progress details and quarantine information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/synchronization/status.py

• class SynchronizationJob 61.2% similar

  Manages Microsoft 365 directory synchronization jobs that periodically poll for changes in one directory and push them to another directory, specific to an application instance in a tenant.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/synchronization/job.py

• class SynchronizationProgress 60.8% similar

  A class representing the progress of a synchronization job toward completion in Microsoft Office 365 services.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/synchronization/progress.py

• class SynchronizationQuarantine 60.0% similar

  A data class that represents the quarantine state of a synchronization job, encapsulating error information when a synchronization job is quarantined.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/synchronization/quarantine.py

• class SynchronizationSchema 55.8% similar

  A class representing a synchronization schema that defines what objects will be synchronized and how they will be synchronized between systems.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/synchronization/schema.py