Skip to main content

cli

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.

Selected local CLI presentation values and the existing local configuration owner's durable runtime facts.

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

Types​

AcquisitionObservation​

connectors.cli.AcquisitionObservation is a record of eight fields:

  • instance_id — String
  • acquisition — String
  • state — connectors.cli.AcquisitionState
  • reason — Optional<connectors.auth_bindings.AcquisitionFailure>, which may be absent
  • connection — Optional<String>, which may be absent
  • expires_at_ms — Integer
  • observed_at_ms — Integer
  • next_action — connectors.cli.NextAction

AcquisitionState​

connectors.cli.AcquisitionState is one of pending, completed and failed.

AdapterConfiguration​

connectors.cli.AdapterConfiguration is a record of four fields:

  • summary — connectors.cli.AdapterSummary
  • configuration_revision — String
  • protocol — String
  • executable — connectors.cli.ConfiguredExecutable

AdapterDescribeInput​

connectors.cli.AdapterDescribeInput is a record of three fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent

AdapterDescribeResult​

connectors.cli.AdapterDescribeResult is a record of four fields:

  • configuration — connectors.cli.AdapterConfiguration
  • descriptor — Optional<connectors.cli.ServiceDescriptor>, which may be absent
  • source — connectors.cli.MetadataSource
  • stale — Boolean

AdapterListInput​

connectors.cli.AdapterListInput is a record of two fields:

  • limit — Optional<Integer>, which may be absent
  • cursor — Optional<String>, which may be absent

AdapterListResult​

connectors.cli.AdapterListResult is a record of four fields:

  • adapters — List<connectors.cli.InstanceSummary>
  • unmigrated — Optional<List<String>>, which may be absent
  • next_cursor — Optional<String>, which may be absent
  • source — connectors.cli.MetadataSource

AdapterObservation​

connectors.cli.AdapterObservation is a record of 13 fields:

  • adapter — String
  • connector — String
  • instance — String
  • configuration_revision — String
  • state — connectors.cli.LifecycleState
  • host_incarnation — Optional<String>, which may be absent
  • child_incarnation — Optional<String>, which may be absent
  • observed_at_ms — Integer
  • failure — Optional<connectors.cli.Failure>, which may be absent
  • start_failure — Optional<connectors.cli.StartFailure>, which may be absent
  • start_exit_code — Optional<Integer>, which may be absent
  • start_signal — Optional<Integer>, which may be absent
  • start_log — Optional<String>, which may be absent

AdapterStatusInput​

connectors.cli.AdapterStatusInput is a record of three fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent

AdapterStatusResult​

connectors.cli.AdapterStatusResult is a record of one field:

  • observation — connectors.cli.AdapterObservation

AdapterStopInput​

connectors.cli.AdapterStopInput is a record of six fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • expected_revision — String
  • host_incarnation — String
  • child_incarnation — String

AdapterStopResult​

connectors.cli.AdapterStopResult is a record of one field:

  • observation — connectors.cli.AdapterObservation

AdapterSummary​

connectors.cli.AdapterSummary is a record of seven fields:

  • adapter — String
  • connector — String
  • instance — String
  • instance_id — String
  • adapter_id — String
  • startup — connectors.cli.StartupMode
  • restart — connectors.cli.RestartPolicy

ApprovalClockCheckInput​

connectors.cli.ApprovalClockCheckInput is a record of three fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent

ApprovalClockCheckResult​

connectors.cli.ApprovalClockCheckResult is a record of four fields:

  • adapter — String
  • connector — String
  • instance — String
  • observation — connectors.clock.Observation

ApprovalIssueDisposition​

connectors.cli.ApprovalIssueDisposition is one of published.

ApprovalIssueInput​

connectors.cli.ApprovalIssueInput is a record of 10 fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — String
  • operation — String
  • schema — String
  • revision — String
  • input — String
  • approve_subject — String
  • proof_output — String

ApprovalIssueResult​

connectors.cli.ApprovalIssueResult is a record of six fields:

  • adapter — String
  • connector — String
  • instance — String
  • reference — String
  • subject_sha256 — String
  • disposition — connectors.cli.ApprovalIssueDisposition

ApprovalIssuerView​

connectors.cli.ApprovalIssuerView is a record of four fields:

  • issuer — String
  • audience — String
  • revision — String
  • keys — List<connectors.cli.ApprovalKeyView>

ApprovalKeyInitInput​

connectors.cli.ApprovalKeyInitInput is a record of four fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • expected_revision — Optional<String>, which may be absent

ApprovalKeyRecoverInput​

connectors.cli.ApprovalKeyRecoverInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • expected_revision — String
  • candidate — String

ApprovalKeyRetireInput​

connectors.cli.ApprovalKeyRetireInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • expected_revision — String
  • key — String

ApprovalKeyRevokeInput​

connectors.cli.ApprovalKeyRevokeInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • expected_revision — String
  • expected_key — String

ApprovalKeyRotateInput​

connectors.cli.ApprovalKeyRotateInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • expected_revision — String
  • expected_key — String

ApprovalKeyState​

connectors.cli.ApprovalKeyState is one of candidate, active, retired, retiring and deleted.

ApprovalKeyStatusInput​

connectors.cli.ApprovalKeyStatusInput is a record of three fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent

ApprovalKeyView​

connectors.cli.ApprovalKeyView is a record of three fields:

  • key_id — String
  • public_key — String
  • state — connectors.cli.ApprovalKeyState

ApprovalKeysResult​

connectors.cli.ApprovalKeysResult is a record of four fields:

  • adapter — String
  • connector — String
  • instance — String
  • issuer — Optional<connectors.cli.ApprovalIssuerView>, which may be absent

ApprovalPolicyResult​

connectors.cli.ApprovalPolicyResult is a record of four fields:

  • adapter — String
  • connector — String
  • instance — String
  • policy — Optional<connectors.cli.ApprovalPolicyView>, which may be absent

ApprovalPolicySetInput​

connectors.cli.ApprovalPolicySetInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • expected_revision — Optional<Integer>, which may be absent
  • input_file — String

ApprovalPolicyStatusInput​

connectors.cli.ApprovalPolicyStatusInput is a record of three fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent

ApprovalPolicyView​

connectors.cli.ApprovalPolicyView is a record of seven fields:

  • policy_id — String
  • instance_id — String
  • issuer_id — String
  • revision — Integer
  • owner_uid — Integer
  • selection — connectors.local_approval_policy.Selection
  • operations — List<String>

ApprovalPrepareInput​

connectors.cli.ApprovalPrepareInput is a record of eight fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — String
  • operation — String
  • schema — String
  • revision — String
  • input — String

ApprovalPrepareResult​

connectors.cli.ApprovalPrepareResult is a record of four fields:

  • adapter — String
  • connector — String
  • instance — String
  • preparation — connectors.delegation.ApprovalPreparation

AttemptReference​

connectors.cli.AttemptReference is a record of two fields:

  • instance — String
  • id — String

BuildDigest​

connectors.cli.BuildDigest wraps String and is not interchangeable with one: the whole value of naming it separately is the crossings the model then refuses. Its characters are drawn from 0123456789abcdef. Every value satisfies value.count == 64.

CheckpointsChange​

connectors.cli.CheckpointsChange is one of one-way.

CheckpointsDisposition​

connectors.cli.CheckpointsDisposition is one of enabled and already_enabled.

ConfigurationFormat​

connectors.cli.ConfigurationFormat is one of connectors-local/1, connectors-local/2, connectors-local/3, connectors-local/4 and connectors-local/5.

ConfigurationRule​

connectors.cli.ConfigurationRule is one of config_path_unresolved, config_missing, config_not_private, owner_uid_mismatch, approval_clock_format_retired, config_too_large, definition_instance_configured and legacy_entry_unmigrated.

ConfiguredExecutable​

connectors.cli.ConfiguredExecutable is a record of three fields:

  • path — String
  • sha256 — String
  • args — List<String>

ConnectionCandidate​

connectors.cli.ConnectionCandidate is a record of two fields:

  • connection — String
  • state — connectors.connection_admission.ConnectionState

ConnectionConnectInput​

connectors.cli.ConnectionConnectInput is a record of eight fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • profile — String
  • device — Optional<Boolean>, which may be absent
  • credential_document — Optional<String>, which may be absent
  • target — Optional<String>, which may be absent
  • endpoint — Optional<String>, which may be absent

ConnectionConnectResult​

connectors.cli.ConnectionConnectResult is a record of two fields:

  • connection — connectors.cli.ConnectionDescription
  • acquisition — Optional<String>, which may be absent

ConnectionCreateRequest​

connectors.cli.ConnectionCreateRequest is a record of two fields:

  • adapter — String
  • profile — String

ConnectionDescribeInput​

connectors.cli.ConnectionDescribeInput is a record of four fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent

ConnectionDescribeResult​

connectors.cli.ConnectionDescribeResult is a record of one field:

  • connection — connectors.cli.ConnectionDescription

ConnectionDescription​

connectors.cli.ConnectionDescription is a record of nine fields:

  • summary — connectors.cli.ConnectionSummary
  • external_identity — Optional<connectors.credentials.ExternalIdentity>, which may be absent
  • observed_at_ms — Integer
  • valid_until_ms — Integer
  • source — connectors.cli.MetadataSource
  • stale — Boolean
  • binding — Optional<String>, which may be absent
  • granted_scopes — Optional<List<String>>, which may be absent
  • credential_expires_at_ms — Optional<Integer>, which may be absent

ConnectionLaunchInput​

connectors.cli.ConnectionLaunchInput is a record of six fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent
  • consumer — String
  • args — Optional<String>, which may be absent

ConnectionLaunchResult​

connectors.cli.ConnectionLaunchResult is a record of two fields:

  • consumer — String
  • exit_code — Integer

ConnectionListInput​

connectors.cli.ConnectionListInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • limit — Optional<Integer>, which may be absent
  • cursor — Optional<String>, which may be absent

ConnectionListResult​

connectors.cli.ConnectionListResult is a record of six fields:

  • connections — List<connectors.cli.ConnectionSummary>
  • next_cursor — Optional<String>, which may be absent
  • observed_at_ms — Integer
  • valid_until_ms — Optional<Integer>, which may be absent
  • source — connectors.cli.MetadataSource
  • stale — Boolean

ConnectionRebound​

connectors.cli.ConnectionRebound is a record of two fields:

  • from — String
  • to — String

ConnectionReconnectInput​

connectors.cli.ConnectionReconnectInput is a record of seven fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent
  • expected_revision — String
  • device — Optional<Boolean>, which may be absent
  • credential_document — Optional<String>, which may be absent

ConnectionReconnectRequest​

connectors.cli.ConnectionReconnectRequest is a record of three fields:

  • adapter — String
  • connection — String
  • expected_revision — String

ConnectionReconnectResult​

connectors.cli.ConnectionReconnectResult is a record of two fields:

  • connection — connectors.cli.ConnectionDescription
  • acquisition — Optional<String>, which may be absent

ConnectionRevalidateInput​

connectors.cli.ConnectionRevalidateInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent
  • expected_revision — String

ConnectionRevalidateResult​

connectors.cli.ConnectionRevalidateResult is a record of two fields:

  • connection — connectors.cli.ConnectionDescription
  • rebound — Optional<connectors.cli.ConnectionRebound>, which may be absent

ConnectionRevokeInput​

connectors.cli.ConnectionRevokeInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent
  • expected_revision — String

ConnectionRevokeResult​

connectors.cli.ConnectionRevokeResult is a record of seven fields:

  • adapter — String
  • connector — String
  • instance — String
  • connection — String
  • revision — String
  • local_state — connectors.cli.RevocationState
  • provider_outcome — connectors.cli.ProviderRevocationOutcome

ConnectionStatusInput​

connectors.cli.ConnectionStatusInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent
  • acquisition — Optional<String>, which may be absent

ConnectionStatusResult​

connectors.cli.ConnectionStatusResult is a record of two fields:

  • connection — Optional<connectors.cli.ConnectionDescription>, which may be absent
  • acquisition — Optional<connectors.cli.AcquisitionObservation>, which may be absent

ConnectionSummary​

connectors.cli.ConnectionSummary is a record of eight fields:

  • adapter — String
  • connector — String
  • instance — String
  • instance_id — String
  • connection — String
  • profile — String
  • revision — String
  • state — connectors.connection_admission.ConnectionState

ConnectionTokenInput​

connectors.cli.ConnectionTokenInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent
  • reveal — Optional<Boolean>, which may be absent

ConnectionTokenResult​

connectors.cli.ConnectionTokenResult is a record of five fields:

  • connection — String
  • expires_at — String
  • scopes — List<String>
  • refreshed — Boolean
  • issue — String

ConnectorListResult​

connectors.cli.ConnectorListResult is a record of one field:

  • connectors — List<connectors.cli.ConnectorSummary>

ConnectorSummary​

connectors.cli.ConnectorSummary is a record of three fields:

  • id — String
  • profiles — List<String>
  • instances — List<String>

ConsumerCredentialDelivery​

connectors.cli.ConsumerCredentialDelivery is one of descriptor_3 and inherited_handle.

ConsumerCredentialDeliveryStatement​

connectors.cli.ConsumerCredentialDeliveryStatement is a record of three fields:

  • os — connectors.cli.OperatingSystem
  • delivery — connectors.cli.ConsumerCredentialDelivery
  • handle_variable — Optional<String>, which may be absent

Every value satisfies (delivery == inherited_handle or not (defined(handle_variable))), (not (delivery == inherited_handle) or handle_variable == CONNECTORS_CREDENTIAL_HANDLE), (os == windows or delivery == descriptor_3) and (not (os == windows) or delivery == inherited_handle).

CustodyBackend​

connectors.cli.CustodyBackend is one of secret_service, macos_keychain, windows_credential_manager and mounted_secret.

DefinitionsCacheEntry​

connectors.cli.DefinitionsCacheEntry is one of created and existing.

DefinitionsInstallInput​

connectors.cli.DefinitionsInstallInput is a record of two fields:

  • source — String
  • tag — String

DefinitionsInstallResult​

connectors.cli.DefinitionsInstallResult is a record of nine fields:

  • source — String
  • tag — String
  • commit — String
  • index_sha256 — String
  • features — List<String>
  • files — Integer
  • lock_path — String
  • cache_path — String
  • cache_entry — connectors.cli.DefinitionsCacheEntry

Failure​

connectors.cli.Failure is a record of 36 fields:

  • kind — connectors.cli.FailureKind
  • code — connectors.cli.FailureCode
  • stage — connectors.cli.FailureStage
  • next_action — connectors.cli.NextAction
  • service_code — Optional<connectors.service_wire.ErrorCode>, which may be absent
  • service_reason — Optional<String>, which may be absent
  • retry_after_seconds — Optional<Integer>, which may be absent
  • connection — Optional<String>, which may be absent
  • acquisition — Optional<String>, which may be absent
  • request_id — Optional<String>, which may be absent
  • mutation — Optional<connectors.cli.MutationObservation>, which may be absent
  • source_audit — Optional<connectors.service_wire.SourceAudit>, which may be absent
  • configuration_format — Optional<connectors.cli.ConfigurationFormat>, which may be absent
  • instance_id — Optional<String>, which may be absent
  • configuration_rule — Optional<connectors.cli.ConfigurationRule>, which may be absent
  • configuration_bytes — Optional<Integer>, which may be absent
  • configuration_limit — Optional<Integer>, which may be absent
  • store_version — Optional<String>, which may be absent
  • binary_version — Optional<String>, which may be absent
  • custody — Optional<connectors.mutations.CustodyOutcome>, which may be absent
  • created — Optional<Map<String, String>>, which may be absent
  • clock_refusal — Optional<connectors.clock.Refusal>, which may be absent
  • clock_sources — Optional<List<connectors.clock.SourceReport>>, which may be absent
  • field — Optional<String>, which may be absent
  • instances — Optional<List<String>>, which may be absent
  • connections — Optional<List<connectors.cli.ConnectionCandidate>>, which may be absent
  • approval_steps — Optional<List<String>>, which may be absent
  • cause — Optional<connectors.cli.FailureCause>, which may be absent
  • attempts — Optional<Integer>, which may be absent
  • feature — Optional<String>, which may be absent
  • file — Optional<String>, which may be absent
  • revision_expected — Optional<connectors.cli.RevisionKind>, which may be absent
  • revision_given — Optional<connectors.cli.RevisionKind>, which may be absent
  • read_with — Optional<String>, which may be absent
  • installed_provider_path — Optional<String>, which may be absent
  • installed_provider_failure — Optional<connectors.cli.InstalledProviderFailure>, which may be absent

FailureCause​

connectors.cli.FailureCause is one of provider_unavailable, provider_timeout, provider_rate_limited, provider_internal, provider_capacity, adapter_exited and owner_stopping.

FailureCode​

connectors.cli.FailureCode is one of invalid_input, invalid_configuration, configuration_exists, protected_entry_unavailable, custody_unavailable, custody_read_only, metadata_unavailable, revision_conflict, outcome_unknown, identity_mismatch, lifecycle_conflict, incarnation_mismatch, readiness_mismatch, description_unavailable, stale_description, not_found, revoked, forbidden, not_granted, unavailable, timeout, capacity, stale_cursor, unsupported, interrupted, service_failure, approval_required, approval_refused, approval_replayed, idempotency_conflict, owner_build_mismatch, confirmation_required, metadata_schema_newer, instance_ambiguous, connection_unresolved, digest_mismatch, unknown_format_version, unmet_feature and release_invalid.

FailureKind​

connectors.cli.FailureKind is one of usage, operational and interrupted.

FailureStage​

connectors.cli.FailureStage is one of arguments, configuration, protected_entry, admission, launch, readiness, custody, publication, dispatch, observation, stop and installed_provider.

GuaranteeSupport​

connectors.cli.GuaranteeSupport is one of holds, weaker and absent.

InitDisposition​

connectors.cli.InitDisposition is one of created and state_initialized.

InstalledProviderFailure​

connectors.cli.InstalledProviderFailure is one of missing, not_executable, killed, exited, deadline and unreadable_output.

InstanceSummary​

connectors.cli.InstanceSummary is a record of five fields:

  • connector — String
  • instance — String
  • instance_id — String
  • startup — connectors.cli.StartupMode
  • restart — connectors.cli.RestartPolicy

InvokeDescription​

connectors.cli.InvokeDescription is a record of eight fields:

  • connector — String
  • instance — String
  • operation — String
  • description — String
  • effect — connectors.cli.InvokeEffect
  • schema — String
  • revision — String
  • input_schema — Json

InvokeEffect​

connectors.cli.InvokeEffect is one of read and write.

InvokeInput​

connectors.cli.InvokeInput is a record of 17 fields:

  • target — String
  • operation — String
  • connection — Optional<String>, which may be absent
  • schema — String
  • revision — String
  • input — String
  • approval_file — Optional<String>, which may be absent
  • idempotency_key — Optional<String>, which may be absent
  • definition — Optional<String>, which may be absent
  • definitions_root — Optional<String>, which may be absent
  • credential_file — Optional<String>, which may be absent
  • describe — Optional<Boolean>, which may be absent
  • fields — Optional<String>, which may be absent
  • each — Optional<String>, which may be absent
  • walk — Optional<Boolean>, which may be absent
  • max_pages — Optional<Integer>, which may be absent
  • out — Optional<String>, which may be absent

InvokeResult​

connectors.cli.InvokeResult is a record of eight fields:

  • connector — String
  • instance — String
  • operation — String
  • revision — String
  • result — Json
  • request_id — Optional<String>, which may be absent
  • mutation — Optional<connectors.cli.MutationObservation>, which may be absent
  • source_audit — Optional<connectors.service_wire.SourceAudit>, which may be absent

InvokeShaped​

connectors.cli.InvokeShaped is a record of five fields:

  • records — Optional<Integer>, which may be absent
  • missing — Optional<List<String>>, which may be absent
  • request_id — Optional<String>, which may be absent
  • mutation — Optional<connectors.cli.MutationObservation>, which may be absent
  • source_audit — Optional<connectors.service_wire.SourceAudit>, which may be absent

InvokeWalked​

connectors.cli.InvokeWalked is a record of 10 fields:

  • pages — Integer
  • records — Integer
  • complete — Boolean
  • end — Optional<String>, which may be absent
  • stopped — Optional<String>, which may be absent
  • error — Optional<Json>, which may be absent
  • status — Optional<Integer>, which may be absent
  • resume — Optional<Json>, which may be absent
  • out — String
  • missing — Optional<List<String>>, which may be absent

KeyringState​

connectors.cli.KeyringState is one of available, locked and unavailable.

LifecycleState​

connectors.cli.LifecycleState is one of not_running, starting, ready, stopping, stopped, failed, owner_unavailable and suppressed.

LocalCaptureAdmission​

connectors.cli.LocalCaptureAdmission is a record of three fields:

  • acquisition — String
  • expires_at_ms — Timestamp
  • profile — connectors.cli.PrivateStaticProfile

LocalCustodyBinding​

connectors.cli.LocalCustodyBinding is a record of three fields:

  • secret_service_socket — Optional<String>, which may be absent
  • binding — Optional<connectors.cli.CustodyBackend>, which may be absent
  • directory — Optional<String>, which may be absent

Every value satisfies (binding == mounted_secret or not (defined(directory))), (not (binding == mounted_secret) or defined(directory)) and (not (binding == mounted_secret) or not (defined(secret_service_socket))).

LocalOperationPolicy​

connectors.cli.LocalOperationPolicy is a record of two fields:

  • profiles — List<String>
  • operations — List<String>

LocalOwnerBuild​

connectors.cli.LocalOwnerBuild is a record of one field:

  • build — connectors.cli.BuildDigest

LocalOwnerBuildKind​

connectors.cli.LocalOwnerBuildKind is one of build.

LocalOwnerBuildRequest​

connectors.cli.LocalOwnerBuildRequest is a record of one field:

  • kind — connectors.cli.LocalOwnerBuildKind

LocalOwnerCached​

connectors.cli.LocalOwnerCached is a record of one field:

  • bootstrap — connectors.cli.PrivateAdapterBootstrap

LocalOwnerCachedKind​

connectors.cli.LocalOwnerCachedKind is one of cached.

LocalOwnerCachedRequest​

connectors.cli.LocalOwnerCachedRequest is a record of four fields:

  • kind — connectors.cli.LocalOwnerCachedKind
  • adapter — String
  • launch — Optional<Boolean>, which may be absent
  • connection — Optional<String>, which may be absent

LocalOwnerConnections​

connectors.cli.LocalOwnerConnections is a record of one field:

  • connections — List<connectors.cli.LocalOwnerListedConnection>

LocalOwnerConnectionsKind​

connectors.cli.LocalOwnerConnectionsKind is one of connections.

LocalOwnerConnectionsRequest​

connectors.cli.LocalOwnerConnectionsRequest is a record of two fields:

  • kind — connectors.cli.LocalOwnerConnectionsKind
  • adapter — String

LocalOwnerGreeting​

connectors.cli.LocalOwnerGreeting is a record of six fields:

  • kind — connectors.cli.LocalOwnerHelloKind
  • version — String
  • challenge — Uuid
  • host_incarnation — Uuid
  • authority — Uuid
  • build — Optional<connectors.cli.BuildDigest>, which may be absent

LocalOwnerHello​

connectors.cli.LocalOwnerHello is a record of six fields:

  • kind — connectors.cli.LocalOwnerHelloKind
  • version — String
  • challenge — Uuid
  • configuration — String
  • authority — Uuid
  • build — Optional<connectors.cli.BuildDigest>, which may be absent

LocalOwnerHelloKind​

connectors.cli.LocalOwnerHelloKind is one of hello.

LocalOwnerListedConnection​

connectors.cli.LocalOwnerListedConnection is a record of four fields:

  • connection — String
  • state — connectors.connection_admission.ConnectionState
  • current — Boolean
  • binding — Optional<String>, which may be absent

LocalOwnerReuseKind​

connectors.cli.LocalOwnerReuseKind is one of reuse.

LocalOwnerReuseRequest​

connectors.cli.LocalOwnerReuseRequest is a record of six fields:

  • kind — connectors.cli.LocalOwnerReuseKind
  • adapter — String
  • source — String
  • connection — String
  • expected_revision — String
  • profile — String

LocalRevalidationAdmission​

connectors.cli.LocalRevalidationAdmission is a record of seven fields:

  • connection — String
  • generation — String
  • custody_version — String
  • publication_fence — String
  • captured_at_ms — Timestamp
  • expires_at_ms — Timestamp
  • cause — connectors.cli.LocalRevalidationCause

LocalRevalidationCause​

connectors.cli.LocalRevalidationCause is one of explicit and read_recollection.

MetadataSource​

connectors.cli.MetadataSource is one of configuration, cached and authority.

MigrateDisposition​

connectors.cli.MigrateDisposition is one of planned, applied and unchanged.

MigrateEntry​

connectors.cli.MigrateEntry is a record of 10 fields:

  • adapter — String
  • connector — String
  • instance — String
  • disposition — connectors.cli.MigrateEntryDisposition
  • reason — Optional<connectors.cli.MigrateKeptReason>, which may be absent
  • differing_field — Optional<connectors.cli.MigrateField>, which may be absent
  • form — Optional<connectors.cli.MigrateForm>, which may be absent
  • pinned_field — Optional<connectors.cli.MigrateField>, which may be absent
  • before — connectors.cli.MigrateSelection
  • after — connectors.cli.MigrateSelection

MigrateEntryDisposition​

connectors.cli.MigrateEntryDisposition is one of migrated and kept.

MigrateField​

connectors.cli.MigrateField is one of instance_id, configuration_revision, adapter_id, protocol, private_protocol, startup, restart, executable, permissions, instance, enabled, description, endpoint, profile, format, credential_revision, provider, bundle_sha256, source_sha256, api_base, ca_digest, auth, operations, token_ca_digest, feed, request_prefix, hosts and bindings.

MigrateForm​

connectors.cli.MigrateForm is one of short and pinned.

MigrateKeptReason​

connectors.cli.MigrateKeptReason is one of implementation_unmapped, connector_undeclared, gateway_prefix, native_configuration_unreadable, instance_conflict and selection_changes.

MigrateMode​

connectors.cli.MigrateMode is one of dry-run and apply.

MigrateSelection​

connectors.cli.MigrateSelection is a record of four fields:

  • instance_id — String
  • configuration_revision — String
  • executable_selection — String
  • custody_items — List<String>

MutationObservation​

connectors.cli.MutationObservation is a record of five fields:

  • classification — connectors.mutations.EffectKnowledge
  • attempt — Optional<connectors.cli.AttemptReference>, which may be absent
  • original_request_id — Optional<String>, which may be absent
  • replayed — Boolean
  • cause — Optional<connectors.service_wire.DiagnosticCause>, which may be absent

NextAction​

connectors.cli.NextAction is one of check_configuration, select_protected_source, unlock_keyring, retry_status, repair_connection, revalidate_connection, create_connection, revoke_connection, refresh_description, request_permission, retry_explicitly, stop_owner, upgrade, choose_clock_source and none.

OperatingSystem​

connectors.cli.OperatingSystem is one of linux, macos and windows.

OperationDescribeInput​

connectors.cli.OperationDescribeInput is a record of five fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent
  • operation — String

OperationDescribeResult​

connectors.cli.OperationDescribeResult is a record of eight fields:

  • adapter — String
  • connector — String
  • instance — String
  • revision — String
  • schema — String
  • operation — connectors.cli.OperationDescription
  • source — connectors.cli.MetadataSource
  • stale — Boolean

OperationDescription​

connectors.cli.OperationDescription is a record of six fields:

  • id — String
  • description — String
  • contract — String
  • profile — String
  • input_schema — Json
  • output_schema — Json

OperationListInput​

connectors.cli.OperationListInput is a record of seven fields:

  • adapter — Optional<String>, which may be absent
  • connector — Optional<String>, which may be absent
  • instance — Optional<String>, which may be absent
  • connection — Optional<String>, which may be absent
  • family — Optional<String>, which may be absent
  • limit — Optional<Integer>, which may be absent
  • cursor — Optional<String>, which may be absent

OperationListResult​

connectors.cli.OperationListResult is a record of eight fields:

  • adapter — String
  • connector — String
  • instance — String
  • revision — String
  • operations — List<connectors.cli.OperationSummary>
  • next_cursor — Optional<String>, which may be absent
  • source — connectors.cli.MetadataSource
  • stale — Boolean

OperationSummary​

connectors.cli.OperationSummary is a record of four fields:

  • id — String
  • description — String
  • contract — String
  • profile — String

OwnerStopDisposition​

connectors.cli.OwnerStopDisposition is one of stopped and no_owner.

PlatformGuarantee​

connectors.cli.PlatformGuarantee is one of sealed_executable, parent_death_kill, exact_process_signal, own_image_build_measure, atomic_no_replace_rename, atomic_close_on_exec and peer_credential_snapshot.

PlatformGuaranteeStatement​

connectors.cli.PlatformGuaranteeStatement is a record of four fields:

  • os — connectors.cli.OperatingSystem
  • guarantee — connectors.cli.PlatformGuarantee
  • support — connectors.cli.GuaranteeSupport
  • weaker_form — Optional<connectors.cli.PlatformGuaranteeWeakerForm>, which may be absent

Every value satisfies (support == weaker or not (defined(weaker_form))), (not (support == weaker) or defined(weaker_form)), (not (os == linux) or support == holds), (not (os == macos) or not (guarantee == sealed_executable) or (support == weaker and weaker_form == owner_private_copy)), (not (os == macos) or not (guarantee == parent_death_kill) or (support == weaker and weaker_form == adapter_channel_close)), (not (os == macos) or not (guarantee == exact_process_signal) or (support == weaker and weaker_form == child_reap_lock)), (not (os == macos) or not (guarantee == own_image_build_measure) or (support == weaker and weaker_form == launch_path_read)), (not (os == macos) or not (guarantee == atomic_no_replace_rename) or support == holds), (not (os == macos) or not (guarantee == atomic_close_on_exec) or (support == weaker and weaker_form == set_after_receive)), (not (os == macos) or not (guarantee == peer_credential_snapshot) or (support == weaker and weaker_form == separate_pid_query)), (not (os == windows) or not (guarantee == sealed_executable) or (support == weaker and weaker_form == deny_write_copy)), (not (os == windows) or not (guarantee == parent_death_kill) or support == holds), (not (os == windows) or not (guarantee == exact_process_signal) or support == holds), (not (os == windows) or not (guarantee == own_image_build_measure) or (support == weaker and weaker_form == launch_path_read)), (not (os == windows) or not (guarantee == atomic_no_replace_rename) or support == holds), (not (os == windows) or not (guarantee == atomic_close_on_exec) or support == holds) and (not (os == windows) or not (guarantee == peer_credential_snapshot) or (support == weaker and weaker_form == client_token_query)).

PlatformGuaranteeWeakerForm​

connectors.cli.PlatformGuaranteeWeakerForm is one of owner_private_copy, adapter_channel_close, child_reap_lock, launch_path_read, set_after_receive, separate_pid_query, deny_write_copy and client_token_query.

Prerequisite​

connectors.cli.Prerequisite is a record of four fields:

  • name — String
  • state — connectors.cli.PrerequisiteState
  • next_action — connectors.cli.NextAction
  • installed_provider_failure — Optional<connectors.cli.InstalledProviderFailure>, which may be absent

PrerequisiteState​

connectors.cli.PrerequisiteState is one of ready, failed and unknown.

PrivateAdapterBootstrap​

connectors.cli.PrivateAdapterBootstrap is a record of 10 fields:

  • instance — String
  • adapter — String
  • protocol — String
  • configuration_revision — String
  • credential_revision — Optional<String>, which may be absent
  • provider_authority — String
  • descriptor — String
  • profiles — List<connectors.cli.PrivateStaticProfile>
  • requirements — List<connectors.cli.PrivateOperationRequirement>
  • bindings — Optional<connectors.cli.PrivateBindings>, which may be absent

PrivateAlternativeBinding​

connectors.cli.PrivateAlternativeBinding is a record of three fields:

  • id — String
  • descriptor — String
  • requirements — List<connectors.cli.PrivateOperationRequirement>

PrivateBaseline​

connectors.cli.PrivateBaseline is a record of six fields:

  • identity — connectors.credentials.ExternalIdentity
  • granted_scopes — Optional<List<String>>, which may be absent
  • credential_expires_at_ms — Optional<Timestamp>, which may be absent
  • collected_at_ms — Timestamp
  • valid_until_ms — Timestamp
  • binding — Optional<String>, which may be absent

PrivateBindings​

connectors.cli.PrivateBindings is a record of two fields:

  • id — String
  • alternatives — List<connectors.cli.PrivateAlternativeBinding>

PrivateEntryField​

connectors.cli.PrivateEntryField is a record of three fields:

  • name — String
  • label — String
  • max_bytes — Integer

PrivateOperationEffect​

connectors.cli.PrivateOperationEffect is one of read, write and unknown.

PrivateOperationRequirement​

connectors.cli.PrivateOperationRequirement is a record of five fields:

  • operation — String
  • profile — String
  • scopes — List<String>
  • effect — connectors.cli.PrivateOperationEffect
  • custody — Optional<Boolean>, which may be absent

PrivateProfileAcquisition​

connectors.cli.PrivateProfileAcquisition is a record of four fields:

  • authorize_url — Optional<String>, which may be absent
  • token_url — Optional<String>, which may be absent
  • scopes — Optional<List<String>>, which may be absent
  • oauth2 — Optional<connectors.oauth2.ServerDeclaration>, which may be absent

PrivateStaticProfile​

connectors.cli.PrivateStaticProfile is a record of 10 fields:

  • id — String
  • revision — String
  • purpose — connectors.auth_access.Purpose
  • subject — connectors.auth_access.Subject
  • scheme — connectors.auth_access.Scheme
  • capability — connectors.auth_access.CapabilityName
  • minimum_scopes — List<String>
  • evidence_lifetime_ms — Integer
  • fields — List<connectors.cli.PrivateEntryField>
  • acquisition — Optional<connectors.cli.PrivateProfileAcquisition>, which may be absent

ProviderRevocationOutcome​

connectors.cli.ProviderRevocationOutcome is one of not_requested.

RestartPolicy​

connectors.cli.RestartPolicy is one of never.

RevisionKind​

connectors.cli.RevisionKind is one of connection and configuration.

RevocationState​

connectors.cli.RevocationState is one of revoked.

ServiceDescriptor​

connectors.cli.ServiceDescriptor is a record of six fields:

  • version — String
  • instance — String
  • adapter — String
  • revision — String
  • operations — List<connectors.cli.OperationDescription>
  • configuration_schema — String

SetupCheckResult​

connectors.cli.SetupCheckResult is a record of six fields:

  • config_path — String
  • state_path — String
  • os — connectors.cli.OperatingSystem
  • keyring — connectors.cli.KeyringState
  • custody_backend — connectors.cli.CustodyBackend
  • prerequisites — List<connectors.cli.Prerequisite>

SetupCheckpointsEnableInput​

connectors.cli.SetupCheckpointsEnableInput is a record of one field:

  • confirm — Optional<connectors.cli.CheckpointsChange>, which may be absent

SetupCheckpointsEnableResult​

connectors.cli.SetupCheckpointsEnableResult is a record of four fields:

  • disposition — connectors.cli.CheckpointsDisposition
  • state_path — String
  • change — connectors.cli.CheckpointsChange
  • newest_incompatible_release — String

SetupInitResult​

connectors.cli.SetupInitResult is a record of four fields:

  • disposition — connectors.cli.InitDisposition
  • config_path — String
  • state_path — String
  • os — connectors.cli.OperatingSystem

SetupMigrateInput​

connectors.cli.SetupMigrateInput is a record of one field:

  • mode — connectors.cli.MigrateMode

SetupMigrateResult​

connectors.cli.SetupMigrateResult is a record of eight fields:

  • mode — connectors.cli.MigrateMode
  • disposition — connectors.cli.MigrateDisposition
  • config_path — String
  • format_before — String
  • format_after — String
  • backup_path — Optional<String>, which may be absent
  • configuration — String
  • entries — List<connectors.cli.MigrateEntry>

SetupOwnerStopResult​

connectors.cli.SetupOwnerStopResult is a record of three fields:

  • disposition — connectors.cli.OwnerStopDisposition
  • state_path — String
  • host_incarnation — Optional<String>, which may be absent

StartFailure​

connectors.cli.StartFailure is one of admission, digest, copy, spawn, exited_before_handshake, handshake_deadline and handshake_mismatch.

StartupMode​

connectors.cli.StartupMode is one of on-demand and automatic.

79 of the types above are reached by nothing else in this system: connectors.cli.AdapterDescribeInput, connectors.cli.AdapterDescribeResult, connectors.cli.AdapterListInput, connectors.cli.AdapterListResult, connectors.cli.AdapterStatusInput, connectors.cli.AdapterStatusResult, connectors.cli.AdapterStopInput, connectors.cli.AdapterStopResult, connectors.cli.ApprovalClockCheckInput, connectors.cli.ApprovalClockCheckResult, connectors.cli.ApprovalIssueInput, connectors.cli.ApprovalIssueResult, connectors.cli.ApprovalKeyInitInput, connectors.cli.ApprovalKeyRecoverInput, connectors.cli.ApprovalKeyRetireInput, connectors.cli.ApprovalKeyRevokeInput, connectors.cli.ApprovalKeyRotateInput, connectors.cli.ApprovalKeyStatusInput, connectors.cli.ApprovalKeysResult, connectors.cli.ApprovalPolicyResult, connectors.cli.ApprovalPolicySetInput, connectors.cli.ApprovalPolicyStatusInput, connectors.cli.ApprovalPrepareInput, connectors.cli.ApprovalPrepareResult, connectors.cli.ConnectionConnectInput, connectors.cli.ConnectionConnectResult, connectors.cli.ConnectionCreateRequest, connectors.cli.ConnectionDescribeInput, connectors.cli.ConnectionDescribeResult, connectors.cli.ConnectionLaunchInput, connectors.cli.ConnectionLaunchResult, connectors.cli.ConnectionListInput, connectors.cli.ConnectionListResult, connectors.cli.ConnectionReconnectInput, connectors.cli.ConnectionReconnectRequest, connectors.cli.ConnectionReconnectResult, connectors.cli.ConnectionRevalidateInput, connectors.cli.ConnectionRevalidateResult, connectors.cli.ConnectionRevokeInput, connectors.cli.ConnectionRevokeResult, connectors.cli.ConnectionStatusInput, connectors.cli.ConnectionStatusResult, connectors.cli.ConnectionTokenInput, connectors.cli.ConnectionTokenResult, connectors.cli.ConnectorListResult, connectors.cli.ConsumerCredentialDeliveryStatement, connectors.cli.DefinitionsInstallInput, connectors.cli.DefinitionsInstallResult, connectors.cli.InvokeDescription, connectors.cli.InvokeInput, connectors.cli.InvokeResult, connectors.cli.InvokeShaped, connectors.cli.InvokeWalked, connectors.cli.LocalCaptureAdmission, connectors.cli.LocalCustodyBinding, connectors.cli.LocalOperationPolicy, connectors.cli.LocalOwnerBuild, connectors.cli.LocalOwnerBuildRequest, connectors.cli.LocalOwnerCached, connectors.cli.LocalOwnerCachedRequest, connectors.cli.LocalOwnerConnections, connectors.cli.LocalOwnerConnectionsRequest, connectors.cli.LocalOwnerGreeting, connectors.cli.LocalOwnerHello, connectors.cli.LocalOwnerReuseRequest, connectors.cli.LocalRevalidationAdmission, connectors.cli.OperationDescribeInput, connectors.cli.OperationDescribeResult, connectors.cli.OperationListInput, connectors.cli.OperationListResult, connectors.cli.PlatformGuaranteeStatement, connectors.cli.PrivateBaseline, connectors.cli.SetupCheckResult, connectors.cli.SetupCheckpointsEnableInput, connectors.cli.SetupCheckpointsEnableResult, connectors.cli.SetupInitResult, connectors.cli.SetupMigrateInput, connectors.cli.SetupMigrateResult and connectors.cli.SetupOwnerStopResult. 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.

Entities​

An entity is what this context is about: something with an identity that outlives any one request, a shape, and a lifecycle. The lifecycle is exhaustive — a move that is not drawn below is a move this specification does not permit, and that is the only way it says so. Every move is labelled with the command that takes it, because a move nothing can trigger is refused rather than drawn.

ConnectionListCursor​

connectors.cli.ConnectionListCursor.

An instance is identified by cursor_id, a Uuid. The name is part of the model and not a convention: a view projects the identity under that name, so a projection inventing its own would disagree with the view.

It holds:

  • instance_id — String
  • adapter_id — String
  • configuration_revision — String
  • registry_epoch — Integer
  • last_connection_ref — String
  • page_limit — Integer
  • expires_at — Timestamp

It references at most one connectors.declarations.ServiceConfiguration, as instance, carried by ConnectionListCursor.instance_id.

Every instance satisfies page_limit >= 1 and page_limit <= 500 — a predicate over this entity's own fields, checked against them rather than stored as a sentence, so an invariant reading something the entity does not have is refused instead of documented.

Its state is a connectors.cli.ConnectionListCursor.State, one of Active and Expired. That enum is synthesised from the lifecycle rather than declared beside it, so the states a view's filter compares and the states drawn below cannot disagree.

An instance is created in Active. Expired is terminal, so an instance may rest there forever. That is declared rather than inferred from having no way out: an entity that cannot leave a state is either finished or stuck, and only its author knows which.

Each move is taken by a declared command outcome, and a move nothing takes is refused as missing_causation rather than left as a state change nobody can trigger:

  • expire — taken by connectors.cli.ExpireConnectionListCursor on its expired outcome

An instance is brought into existence by connectors.cli.RecordConnectionListCursor on its recorded outcome.

Illegal transitions are illegal by absence: no rule forbids them, there is simply no arrow, because a rule would be a second place for the same truth to live. A diagram cannot show an absence, so the pairs it does not connect are listed here, derived from the same transitions — anything named below is a move this specification does not permit.

  • Expired may not become Active

One view projects it: ConnectionListCursors.

LocalRuntimeRecord​

connectors.cli.LocalRuntimeRecord.

An instance is identified by instance_id, a String. The name is part of the model and not a convention: a view projects the identity under that name, so a projection inventing its own would disagree with the view.

It holds:

  • suppressed — Boolean
  • selection — Optional<String>, which may be absent
  • bootstrap — Optional<connectors.cli.PrivateAdapterBootstrap>, which may be absent
  • observed_at — Optional<Timestamp>, which may be absent
  • build_version — Optional<String>, which may be absent

It declares no relation to another entity, and no other entity names it.

No invariant is declared, so nothing here constrains an instance at rest.

Its state is a connectors.cli.LocalRuntimeRecord.State, one of Retained. That enum is synthesised from the lifecycle rather than declared beside it, so the states a view's filter compares and the states drawn below cannot disagree.

An instance is created in Retained. Retained is terminal, so an instance may rest there forever. That is declared rather than inferred from having no way out: an entity that cannot leave a state is either finished or stuck, and only its author knows which.

Each move is taken by a declared command outcome, and a move nothing takes is refused as missing_causation rather than left as a state change nobody can trigger:

  • set_suppression — taken by connectors.cli.SetLocalRuntimeSuppression on its updated outcome
  • remember_bootstrap — taken by connectors.cli.RememberLocalRuntimeBootstrap on its remembered outcome

An instance is brought into existence by connectors.cli.RecordLocalRuntime on its recorded outcome.

It has one state, so there is no move to permit or to forbid.

One view projects it: LocalRuntimeRecords.

StoreWriter​

connectors.cli.StoreWriter.

An instance is identified by store, a String. The name is part of the model and not a convention: a view projects the identity under that name, so a projection inventing its own would disagree with the view.

It holds:

  • binary_version — String
  • model_digest — String

It declares no relation to another entity, and no other entity names it.

No invariant is declared, so nothing here constrains an instance at rest.

Its state is a connectors.cli.StoreWriter.State, one of Recorded. That enum is synthesised from the lifecycle rather than declared beside it, so the states a view's filter compares and the states drawn below cannot disagree.

An instance is created in Recorded. Recorded is terminal, so an instance may rest there forever. That is declared rather than inferred from having no way out: an entity that cannot leave a state is either finished or stuck, and only its author knows which.

Each move is taken by a declared command outcome, and a move nothing takes is refused as missing_causation rather than left as a state change nobody can trigger:

  • raise — taken by connectors.cli.RaiseStoreWriter on its raised outcome

An instance is brought into existence by connectors.cli.RecordStoreWriter on its recorded outcome.

It has one state, so there is no move to permit or to forbid.

No view projects it, so nothing outside this context is promised a way to observe one.

Views​

A view is what the outside world is promised it can observe. Each one says which instances it contains and how soon it reflects a command that has already returned, because "you can read this" without "how soon" is the promise every flaky suite is built on.

ConnectionListCursors​

connectors.cli.ConnectionListCursors.

It reads ConnectionListCursor.

It contains every instance of that entity: no filter narrows it, which is a decision somebody made and not a line somebody omitted.

It exposes:

  • cursor_id — Uuid
  • instance_id — String
  • adapter_id — String
  • configuration_revision — String
  • registry_epoch — Integer
  • last_connection_ref — String
  • page_limit — Integer
  • state — connectors.cli.ConnectionListCursor.State

It declares no order, so the rows come back in whatever order the implementation has, and two reads may disagree.

Read-your-writes: it is current the moment the command that changed it returns. A caller that has just created an invoice and cannot see it in here has been told a lie about what it did.

A generated scenario asserts it once, immediately after the command: a view promising this and not keeping the promise has to fail the suite rather than be retried until it passes.

LocalRuntimeRecords​

connectors.cli.LocalRuntimeRecords.

It reads LocalRuntimeRecord.

It contains every instance of that entity: no filter narrows it, which is a decision somebody made and not a line somebody omitted.

It exposes:

  • instance_id — String
  • selection — Optional<String>, which may be absent
  • state — connectors.cli.LocalRuntimeRecord.State

It declares no order, so the rows come back in whatever order the implementation has, and two reads may disagree.

Read-your-writes: it is current the moment the command that changed it returns. A caller that has just created an invoice and cannot see it in here has been told a lie about what it did.

A generated scenario asserts it once, immediately after the command: a view promising this and not keeping the promise has to fail the suite rather than be retried until it passes.

Commands​

ExpireConnectionListCursor​

connectors.cli.ExpireConnectionListCursor.

It takes:

  • cursor_id — Uuid

It has two outcomes.

expired — The default branch, taken when no other outcome's condition matched. It moves a connectors.cli.ConnectionListCursor from Active to Expired, along the declared move expire. The instance is the one named by the input field cursor_id. It emits connectors.cli.ConnectionListCursorExpired. A test reaches it by constructing an input that satisfies no other outcome's condition.

wrong-state — Taken when the subject is resting in a state none of this command's moves start from — a connectors.cli.ConnectionListCursor in Expired, which is what is left of the lifecycle once this command's own moves are taken away. The document lists none of it. No entity in this specification changes. It reports connectors.cli.CursorStateConflict, carrying state. It emits nothing. A test reaches it by driving an instance into one of those states and then issuing the command, because no input selects this branch.

RaiseStoreWriter​

connectors.cli.RaiseStoreWriter.

It takes:

  • store — String
  • binary_version — String
  • model_digest — String

It has one outcome.

raised — The default branch, taken when no other outcome's condition matched. It moves a connectors.cli.StoreWriter from Recorded to Recorded, along the declared move raise. The instance is the one named by the input field store. It emits connectors.cli.StoreWriterRaised. It sets binary_version from input.binary_version and model_digest from input.model_digest. A test reaches it by constructing an input that satisfies no other outcome's condition.

RecordConnectionListCursor​

connectors.cli.RecordConnectionListCursor.

It takes:

  • cursor_id — Uuid
  • instance_id — String
  • adapter_id — String
  • configuration_revision — String
  • registry_epoch — Integer
  • last_connection_ref — String
  • page_limit — Integer
  • expires_at — Timestamp

It has one outcome.

recorded — The default branch, taken when no other outcome's condition matched. It creates a connectors.cli.ConnectionListCursor, which starts in Active. The new instance's identity is published as cursor_id on connectors.cli.ConnectionListCursorRecorded. It emits connectors.cli.ConnectionListCursorRecorded. It sets instance_id from input.instance_id, adapter_id from input.adapter_id, configuration_revision from input.configuration_revision, registry_epoch from input.registry_epoch, last_connection_ref from input.last_connection_ref, page_limit from input.page_limit and expires_at from input.expires_at. A test reaches it by constructing an input that satisfies no other outcome's condition.

RecordLocalRuntime​

connectors.cli.RecordLocalRuntime.

It takes:

  • instance_id — String
  • suppressed — Boolean
  • selection — Optional<String>, which may be absent
  • bootstrap — Optional<connectors.cli.PrivateAdapterBootstrap>, which may be absent
  • observed_at — Optional<Timestamp>, which may be absent
  • build_version — Optional<String>, which may be absent

It has one outcome.

recorded — The default branch, taken when no other outcome's condition matched. It creates a connectors.cli.LocalRuntimeRecord, which starts in Retained. The new instance's identity is published as instance_id on connectors.cli.LocalRuntimeRecorded. It emits connectors.cli.LocalRuntimeRecorded. It sets suppressed from input.suppressed, selection from input.selection, bootstrap from input.bootstrap, observed_at from input.observed_at and build_version from input.build_version. A test reaches it by constructing an input that satisfies no other outcome's condition.

RecordStoreWriter​

connectors.cli.RecordStoreWriter.

It takes:

  • store — String
  • binary_version — String
  • model_digest — String

It has one outcome.

recorded — The default branch, taken when no other outcome's condition matched. It creates a connectors.cli.StoreWriter, which starts in Recorded. The new instance's identity is published as store on connectors.cli.StoreWriterRecorded. It emits connectors.cli.StoreWriterRecorded. It sets binary_version from input.binary_version and model_digest from input.model_digest. A test reaches it by constructing an input that satisfies no other outcome's condition.

RememberLocalRuntimeBootstrap​

connectors.cli.RememberLocalRuntimeBootstrap.

It takes:

  • instance_id — String
  • selection — String
  • bootstrap — connectors.cli.PrivateAdapterBootstrap
  • observed_at — Timestamp
  • build_version — String

It has one outcome.

remembered — The default branch, taken when no other outcome's condition matched. It moves a connectors.cli.LocalRuntimeRecord from Retained to Retained, along the declared move remember_bootstrap. The instance is the one named by the input field instance_id. It emits connectors.cli.LocalRuntimeBootstrapRemembered. It sets selection from input.selection, bootstrap from input.bootstrap, observed_at from input.observed_at and build_version from input.build_version. A test reaches it by constructing an input that satisfies no other outcome's condition.

SetLocalRuntimeSuppression​

connectors.cli.SetLocalRuntimeSuppression.

It takes:

  • instance_id — String
  • suppressed — Boolean

It has one outcome.

updated — The default branch, taken when no other outcome's condition matched. It moves a connectors.cli.LocalRuntimeRecord from Retained to Retained, along the declared move set_suppression. The instance is the one named by the input field instance_id. It emits connectors.cli.LocalRuntimeSuppressionSet. It sets suppressed from input.suppressed. A test reaches it by constructing an input that satisfies no other outcome's condition.

Events​

ConnectionListCursorExpired​

connectors.cli.ConnectionListCursorExpired.

It carries:

  • cursor_id — Uuid

Emitted by connectors.cli.ExpireConnectionListCursor on its expired outcome.

Nothing in this system reacts to it.

ConnectionListCursorRecorded​

connectors.cli.ConnectionListCursorRecorded.

It carries:

  • cursor_id — Uuid

Emitted by connectors.cli.RecordConnectionListCursor on its recorded outcome.

Nothing in this system reacts to it.

LocalRuntimeBootstrapRemembered​

connectors.cli.LocalRuntimeBootstrapRemembered.

It carries:

  • instance_id — String

Emitted by connectors.cli.RememberLocalRuntimeBootstrap on its remembered outcome.

Nothing in this system reacts to it.

LocalRuntimeRecorded​

connectors.cli.LocalRuntimeRecorded.

It carries:

  • instance_id — String

Emitted by connectors.cli.RecordLocalRuntime on its recorded outcome.

Nothing in this system reacts to it.

LocalRuntimeSuppressionSet​

connectors.cli.LocalRuntimeSuppressionSet.

It carries:

  • instance_id — String
  • suppressed — Boolean

Emitted by connectors.cli.SetLocalRuntimeSuppression on its updated outcome.

Nothing in this system reacts to it.

StoreWriterRaised​

connectors.cli.StoreWriterRaised.

It carries:

  • store — String
  • binary_version — String

Emitted by connectors.cli.RaiseStoreWriter on its raised outcome.

Nothing in this system reacts to it.

StoreWriterRecorded​

connectors.cli.StoreWriterRecorded.

It carries:

  • store — String
  • binary_version — String

Emitted by connectors.cli.RecordStoreWriter on its recorded outcome.

Nothing in this system reacts to it.

Errors​

CursorStateConflict​

It carries:

  • state — connectors.cli.ConnectionListCursor.State

Reported by connectors.cli.ExpireConnectionListCursor on its wrong-state outcome.

Actors​

An actor is who may ask this context for something. Every grant below points at a command this specification declares — a grant is a resolved reference, so "may invoke" something nobody wrote is not a permission this model can express, and an authorisation that authorises nothing cannot ship quietly.

LocalHost​

connectors.cli.LocalHost.

It may invoke ExpireConnectionListCursor, RaiseStoreWriter, RecordConnectionListCursor, RecordLocalRuntime, RecordStoreWriter, RememberLocalRuntimeBootstrap and SetLocalRuntimeSuppression.

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