@adcp/sdk API Reference - v14.3.0
    Preparing search index...

    Interface ReportingInspectionContext

    interface ReportingInspectionContext {
        obligation: ManagedReportingObligation;
        revision: ManagedReportingRevision;
        materialization: {
            reporting_materialization_id: string;
            reporting_revision_id: string;
            reporting_obligation_id: string;
            delivery_config_id: string;
            delivery_config_version: number;
            destination_ref: string;
            feed_purpose: ReportingFeedPurpose;
            method: "file_transfer" | "dataset_share" | "warehouse_materialization";
            transport?: string;
            attempt: number;
            status: "available" | "failed" | "pending" | "delivered";
            ready_at?: string;
            failed_at?: string;
            failure_code?: string;
            resource?: {
                resource_ref: string;
                kind: "manifest" | "dataset" | "warehouse_relation";
                location: string;
                native_version_ref?: string;
                manifest_version?: "1.0";
                manifest_sha256?: string;
                immutability: "immutable_location" | "native_version";
                expires_at: string;
                reader_compatibility?: string[];
            };
            verification?: {
                verified_at: string;
                verification_path: "destination"
                | "producer"
                | "representative_consumer";
                verification_profile: ReportingVerificationProfile;
                row_count: number;
                control_totals: ReportingControlTotal[];
                canonical_content_digest?: ReportingCanonicalContentDigest;
                physical_checksums?: [
                    SHA256PhysicalChecksum
                    | SHA512PhysicalChecksum,
                    ...(SHA256PhysicalChecksum | SHA512PhysicalChecksum)[],
                ];
                native_commit_evidence?: {
                    native_version_ref: string;
                    observed_through: "destination" | "representative_consumer";
                };
            };
            created_at: string;
        };
        expected: ExpectedReportingPeriod;
    }
    Index
    obligation: ManagedReportingObligation
    revision: ManagedReportingRevision
    materialization: {
        reporting_materialization_id: string;
        reporting_revision_id: string;
        reporting_obligation_id: string;
        delivery_config_id: string;
        delivery_config_version: number;
        destination_ref: string;
        feed_purpose: ReportingFeedPurpose;
        method: "file_transfer" | "dataset_share" | "warehouse_materialization";
        transport?: string;
        attempt: number;
        status: "available" | "failed" | "pending" | "delivered";
        ready_at?: string;
        failed_at?: string;
        failure_code?: string;
        resource?: {
            resource_ref: string;
            kind: "manifest" | "dataset" | "warehouse_relation";
            location: string;
            native_version_ref?: string;
            manifest_version?: "1.0";
            manifest_sha256?: string;
            immutability: "immutable_location" | "native_version";
            expires_at: string;
            reader_compatibility?: string[];
        };
        verification?: {
            verified_at: string;
            verification_path: "destination"
            | "producer"
            | "representative_consumer";
            verification_profile: ReportingVerificationProfile;
            row_count: number;
            control_totals: ReportingControlTotal[];
            canonical_content_digest?: ReportingCanonicalContentDigest;
            physical_checksums?: [
                SHA256PhysicalChecksum
                | SHA512PhysicalChecksum,
                ...(SHA256PhysicalChecksum | SHA512PhysicalChecksum)[],
            ];
            native_commit_evidence?: {
                native_version_ref: string;
                observed_through: "destination" | "representative_consumer";
            };
        };
        created_at: string;
    }

    Type Declaration

    • reporting_materialization_id: string
    • reporting_revision_id: string
    • reporting_obligation_id: string

      Destination-specific obligation this materialization attempts to satisfy.

    • delivery_config_id: string

      Durable configuration that requested this materialization.

    • delivery_config_version: number
    • destination_ref: string

      Immutable caller-owned destination generation selected by the account-authorized obligation. It may be reused by the same caller across other independently authorized accounts.

    • feed_purpose: ReportingFeedPurpose
    • method: "file_transfer" | "dataset_share" | "warehouse_materialization"
    • Optionaltransport?: string
    • attempt: number
    • status: "available" | "failed" | "pending" | "delivered"

      Lifecycle of this attempt. pending may transition once to available, delivered, or failed; terminal evidence is immutable. Staleness is evaluated in get_reporting_status health, not stored as a materialization state.

    • Optionalready_at?: string

      When consumer-path or destination verification completed.

    • Optionalfailed_at?: string
    • Optionalfailure_code?: string

      Stable safe failure classification. MUST NOT include credentials or provider response bodies.

    • Optionalresource?: {
          resource_ref: string;
          kind: "manifest" | "dataset" | "warehouse_relation";
          location: string;
          native_version_ref?: string;
          manifest_version?: "1.0";
          manifest_sha256?: string;
          immutability: "immutable_location" | "native_version";
          expires_at: string;
          reader_compatibility?: string[];
      }
      • resource_ref: string

        Seller-issued opaque reference to this exact authenticated resource descriptor.

      • kind: "manifest" | "dataset" | "warehouse_relation"

        Shape through which the durable revision is consumed.

      • location: string

        Non-secret provider-native object, relation, or share identifier. MUST NOT contain an activation URL, signed URL, bearer token, password, private key, or embedded credential.

      • Optionalnative_version_ref?: string
      • Optionalmanifest_version?: "1.0"

        Version of reporting-file-manifest.json used by a manifest resource.

      • Optionalmanifest_sha256?: string

        SHA-256 over the exact manifest bytes. Consumers verify this before parsing the manifest.

      • immutability: "immutable_location" | "native_version"

        How this descriptor selects the exact immutable materialization.

      • expires_at: string

        Mandatory finite lower-bound endpoint through which this exact resource remains resolvable; it cannot be earlier than the advertised retention contract.

      • Optionalreader_compatibility?: string[]

        Reader features or format constraints required to consume this resource. Readiness verification MUST use a representative supported reader.

    • Optionalverification?: {
          verified_at: string;
          verification_path: "destination" | "producer" | "representative_consumer";
          verification_profile: ReportingVerificationProfile;
          row_count: number;
          control_totals: ReportingControlTotal[];
          canonical_content_digest?: ReportingCanonicalContentDigest;
          physical_checksums?: [
              SHA256PhysicalChecksum
              | SHA512PhysicalChecksum,
              ...(SHA256PhysicalChecksum | SHA512PhysicalChecksum)[],
          ];
          native_commit_evidence?: {
              native_version_ref: string;
              observed_through: "destination" | "representative_consumer";
          };
      }
      • verified_at: string

        When the producer completed verification through the claimed consumer/destination path.

      • verification_path: "destination" | "producer" | "representative_consumer"

        Path on which verification succeeded. dataset_share readiness requires representative_consumer; delivered warehouse state requires destination.

      • verification_profile: ReportingVerificationProfile
      • row_count: number

        Verified row count. Zero explicitly distinguishes an empty committed revision from a missing revision.

      • control_totals: ReportingControlTotal[]

        Profile-defined totals recomputed through verification_path. Names MUST be unique.

      • Optionalcanonical_content_digest?: ReportingCanonicalContentDigest
      • Optionalphysical_checksums?: [
            SHA256PhysicalChecksum
            | SHA512PhysicalChecksum,
            ...(SHA256PhysicalChecksum | SHA512PhysicalChecksum)[],
        ]

        Method-specific byte/object checksums. Different encodings of the same logical revision normally have different values.

        1

      • Optionalnative_commit_evidence?: {
            native_version_ref: string;
            observed_through: "destination" | "representative_consumer";
        }

        Provider-native immutable version evidence observed through the named consumer or destination path.

    • created_at: string

    Independently selected consumer contract and coverage expectations.