Skip to main content

discovery

Typed specification

Generated by the pinned ess generate --kind docs from ess. Structural validation establishes consistency; behaviour, storage and cross-record predicates remain implementation obligations.

Discovery scope, publication, fixed route and immutable composition values; persistent collection ownership is in discovery_state.

connectors.discovery is one of connectors's bounded contexts. Back to the index.

Types​

CollectionCoverage​

connectors.discovery.CollectionCoverage is a record of two fields:

  • complete — Boolean
  • partitions — List<connectors.discovery.PartitionCoverage>

CollectionScope​

connectors.discovery.CollectionScope is a record of six fields:

  • instance — String
  • source_connection — String
  • declaration — String
  • profile — String
  • scope_ref — String
  • selection_revision — String

CompositionDeclaration​

connectors.discovery.CompositionDeclaration is a record of four fields:

  • declaration_revision — String
  • instances — List<connectors.discovery.CompositionInstance>
  • route_bindings — List<connectors.discovery.InstalledRouteBinding>
  • limits — connectors.discovery.CompositionLimits

CompositionFacts​

connectors.discovery.CompositionFacts is a record of six fields:

  • same_process — Boolean
  • parent_port_registered — Boolean
  • child_implementation_registered — Boolean
  • profiles_compatible — Boolean
  • parent_is_direct — Boolean
  • independently_admitted — Boolean

CompositionInstance​

connectors.discovery.CompositionInstance is a record of four fields:

  • instance_id — String
  • configuration_revision — String
  • implementation_ref — String
  • implementation_revision — String

CompositionLimits​

connectors.discovery.CompositionLimits is a record of four fields:

  • max_scopes — Integer
  • max_rows_per_scope — Integer
  • max_concurrent_provider_requests — Integer
  • max_provider_response_bytes — Integer

Every value satisfies (max_scopes >= 1 and max_scopes <= 256), (max_rows_per_scope >= 1 and max_rows_per_scope <= 500), (max_concurrent_provider_requests >= 1 and max_concurrent_provider_requests <= 4) and max_provider_response_bytes >= 1.

ConfiguredSourceIdentity​

connectors.discovery.ConfiguredSourceIdentity is a record of four fields:

  • instance_id — String
  • connection_ref — String
  • api_origin — String
  • transport_policy_revision — String

DeclaredObservationBinding​

connectors.discovery.DeclaredObservationBinding is a record of four fields:

  • operation_id — String
  • profile — String
  • source — connectors.discovery.ConfiguredSourceIdentity
  • projection_revision — String

HistoricalObservationCoordinate​

connectors.discovery.HistoricalObservationCoordinate is a record of three fields:

  • collection_ref — String
  • scope_epoch — Uuid
  • observation_ref — String

InstalledRouteBinding​

connectors.discovery.InstalledRouteBinding is a record of four fields:

  • parent_instance_id — String
  • child_instance_id — String
  • profile — String
  • binding_revision — String

MediatedRouteBinding​

connectors.discovery.MediatedRouteBinding is a record of seven fields:

  • observation — connectors.discovery.HistoricalObservationCoordinate
  • profile — String
  • target_adapter — String
  • private_fixed_target_ref — String
  • access_mode — connectors.auth_access.AccessMode
  • owner_scope_ref — String
  • evidence — Optional<connectors.discovery.MediatedRouteEvidence>, which may be absent

MediatedRouteEvidence​

connectors.discovery.MediatedRouteEvidence is a record of five fields:

  • route_revision — String
  • observation_generation — Integer
  • parent_generation_id — Optional<connectors.credentials.CredentialGenerationId>, which may be absent
  • observed_at — Timestamp
  • valid_until — Timestamp

ObservationEvidence​

connectors.discovery.ObservationEvidence is a record of four fields:

  • state — connectors.discovery.ObservationState
  • last_seen_generation — Integer
  • observed_at — Timestamp
  • valid_until — Timestamp

ObservationState​

connectors.discovery.ObservationState is one of observed, stale and withdrawn.

PartitionCoverage​

connectors.discovery.PartitionCoverage is a record of three fields:

  • id — String
  • kind — String
  • state — connectors.discovery.PartitionState

PartitionState​

connectors.discovery.PartitionState is one of complete, capped, denied, unavailable and not_scanned.

PublicationDecision​

connectors.discovery.PublicationDecision is one of published, refused and unknown.

PublicationFacts​

connectors.discovery.PublicationFacts is a record of eight fields:

  • attempt_current — Boolean
  • predecessor_current — Boolean
  • scope_unchanged — Boolean
  • source_binding_current — Boolean
  • parent_generation_current — Boolean
  • authority_current — Boolean
  • deadline_current — Boolean
  • private_bindings_available — Boolean

RecognitionConfidence​

connectors.discovery.RecognitionConfidence is one of declared and inferred.

ResourceRecognition​

connectors.discovery.ResourceRecognition is a record of two fields:

  • provider — String
  • confidence — connectors.discovery.RecognitionConfidence

RouteRevalidationDecision​

connectors.discovery.RouteRevalidationDecision is one of same_binding_published, changed_binding, refused, unavailable and unknown.

RouteRevalidationFacts​

connectors.discovery.RouteRevalidationFacts is a record of nine fields:

  • expected_route_revision — String
  • old_observation_generation — Integer
  • new_observation_generation — Integer
  • observation_current — Boolean
  • fixed_binding_equal — Boolean
  • parent_generation_current — Boolean
  • independently_admitted — Boolean
  • exact_permission_current — Boolean
  • child_enabled_and_not_revoked — Boolean

SnapshotSummary​

connectors.discovery.SnapshotSummary is a record of four fields:

  • scope — connectors.discovery.CollectionScope
  • generation — Integer
  • coverage — connectors.discovery.CollectionCoverage
  • retention_truncated — Boolean

Seven of the types above are reached by nothing else in this system: connectors.discovery.CompositionDeclaration, connectors.discovery.CompositionFacts, connectors.discovery.DeclaredObservationBinding, connectors.discovery.ResourceRecognition, connectors.discovery.RouteRevalidationDecision, connectors.discovery.RouteRevalidationFacts and connectors.discovery.SnapshotSummary. No entity, view, command, event, error or crossing names them, so it is either vocabulary something outside this specification uses or a leftover — and only a person can tell which.

Generated from connectors v1 · model digest e1e1672d0af4753cb8f2da6c0b22a7f6ae8ce9f7abc168f86169babdf1325787 · contract digest slice-sha256/2:a168561948c37a37f3909f9c140513c5c8fd15650d8fea1d74095af65beb8ebb. Do not edit this file; change the specification and regenerate it with ess generate.