Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 609 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

GoogleWorkspaceFailureDiagnostics

Edit on GitHub
Namespace OfficeIMO.GoogleWorkspace
Assembly OfficeIMO.GoogleWorkspace
Source revision c8404474f9f2 with working tree changes
Source GoogleWorkspaceExportException.cs:82
Modifiers static

Creates consistent structured exceptions and diagnostics for Workspace export failures.

Inheritance

  • Object
  • GoogleWorkspaceFailureDiagnostics

Methods

public static GoogleWorkspaceExportException CreateAmbiguousMutationFailure(String operationName, GoogleWorkspaceSessionOptions? sessionOptions, TranslationReport report, GoogleWorkspaceAmbiguousMutationException exception) #
GoogleWorkspaceExportException.cs:205
Returns: GoogleWorkspaceExportException

Creates an actionable export failure for a mutation that must be reconciled before retry.

Parameters

operationName System.String requiredposition: 0
sessionOptions OfficeIMO.GoogleWorkspace.GoogleWorkspaceSessionOptions? requiredposition: 1
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 2
exception OfficeIMO.GoogleWorkspace.GoogleWorkspaceAmbiguousMutationException requiredposition: 3
public static GoogleWorkspaceExportException CreateApiFailure(String operationName, GoogleWorkspaceSessionOptions? sessionOptions, TranslationReport report, Exception exception) #
GoogleWorkspaceExportException.cs:142
Returns: GoogleWorkspaceExportException

Records a general Google API failure and returns its structured export exception.

Parameters

operationName System.String requiredposition: 0
User-facing name of the export operation.
sessionOptions OfficeIMO.GoogleWorkspace.GoogleWorkspaceSessionOptions? requiredposition: 1
Session diagnostic settings, when available.
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 2
Report to receive the failure diagnostic.
exception System.Exception requiredposition: 3
Underlying API or transport exception.

Returns

An API-request export exception.

public static GoogleWorkspaceExportCanceledException CreateCanceledFailure(String operationName, GoogleWorkspaceSessionOptions? sessionOptions, TranslationReport report, OperationCanceledException exception) #
GoogleWorkspaceExportException.cs:241
Returns: GoogleWorkspaceExportCanceledException

Records caller cancellation and returns an exception that preserves the original cancellation token.

Parameters

operationName System.String requiredposition: 0
User-facing name of the export operation.
sessionOptions OfficeIMO.GoogleWorkspace.GoogleWorkspaceSessionOptions? requiredposition: 1
Session diagnostic settings, when available.
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 2
Report to receive the cancellation diagnostic.
exception System.OperationCanceledException requiredposition: 3
Original cancellation exception.

Returns

A structured cancellation exception.

public static GoogleWorkspaceExportException CreateRequestTimeoutFailure(String operationName, GoogleWorkspaceSessionOptions? sessionOptions, TranslationReport report, TaskCanceledException exception) #
GoogleWorkspaceExportException.cs:175
Returns: GoogleWorkspaceExportException

Records a request timeout and returns its structured export exception.

Parameters

operationName System.String requiredposition: 0
User-facing name of the export operation.
sessionOptions OfficeIMO.GoogleWorkspace.GoogleWorkspaceSessionOptions? requiredposition: 1
Session diagnostic settings, when available.
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 2
Report to receive the timeout diagnostic.
exception System.Threading.Tasks.TaskCanceledException requiredposition: 3
Timeout exception raised by the request.

Returns

A request-timeout export exception.

public static GoogleWorkspaceExportException CreateTokenAcquisitionFailure(String operationName, IReadOnlyList<String> scopes, GoogleWorkspaceSession session, TranslationReport report, Exception exception) #
GoogleWorkspaceExportException.cs:82
Returns: GoogleWorkspaceExportException

Classifies a credential failure, records it in the report, and returns an export exception.

Parameters

operationName System.String requiredposition: 0
User-facing name of the export operation.
scopes System.Collections.Generic.IReadOnlyList<System.String> requiredposition: 1
OAuth scopes requested from the credential source.
session OfficeIMO.GoogleWorkspace.GoogleWorkspaceSession requiredposition: 2
Session whose credential policy was applied.
report OfficeIMO.GoogleWorkspace.TranslationReport requiredposition: 3
Report to receive the failure diagnostic.
exception System.Exception requiredposition: 4
Underlying credential exception.

Returns

A domain-delegation or token-acquisition export exception.