🔍 Code Extractor

class SynchronizationProgress

Maturity: 33

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

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/synchronization/progress.py
Lines:
4 - 5
Complexity:
simple

Purpose

This class serves as a data model to track and represent the progress state of synchronization operations in Office 365. It inherits from ClientValue, which is a base class for client-side value objects in the Office 365 SDK. The class is designed to encapsulate progress-related information for synchronization jobs, allowing applications to monitor and report on the status of data synchronization operations between Office 365 services.

Source Code

class SynchronizationProgress(ClientValue):
    """Represents the progress of a synchronizationJob toward completion."""

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Inherits from ClientValue, which provides base functionality for client-side value objects in the Office 365 SDK, including serialization and deserialization capabilities

Return Value

Instantiation returns a SynchronizationProgress object that represents the current state of a synchronization job. The object can be used to access progress-related properties and methods inherited from ClientValue.

Class Interface

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.directory.synchronization.progress import SynchronizationProgress

Usage Example

from office365.directory.synchronization.progress import SynchronizationProgress
from office365.runtime.client_value import ClientValue

# Typically instantiated by the Office 365 SDK when retrieving synchronization job status
progress = SynchronizationProgress()

# The object is usually populated by the SDK with data from API responses
# Example of how it might be used in context:
# sync_job = client.directory.synchronization_jobs.get_by_id('job_id')
# progress = sync_job.progress
# This would contain progress information about the synchronization job

Best Practices

  • This class is typically instantiated and populated by the Office 365 SDK rather than manually created by developers
  • Use this class as a read-only data container to access synchronization progress information
  • The class inherits serialization capabilities from ClientValue, making it suitable for JSON serialization/deserialization
  • When working with synchronization jobs, retrieve this object through the appropriate Office 365 API endpoints rather than creating instances directly
  • Ensure proper authentication and authorization are configured before accessing synchronization job data

Tags

office365 synchronization progress-tracking microsoft-graph directory-services data-model client-value azure-ad

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class SynchronizationStatus 84.1% 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 65.6% 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 SynchronizationQuarantine 64.6% 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 DomainState 63.5% similar

    A class representing the status of asynchronous operations scheduled on a domain, inheriting from ClientValue.

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

  • class SynchronizationError 62.2% similar

    SynchronizationError is an exception class that represents errors occurring during synchronization operations in Office 365 client operations.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/synchronization/error.py
← Back to Browse