Contract reference

Contract version: 1.1.0. Durations use seconds unless a field ends in _ms; sizes use bytes.

Operation	Rust	JavaScript	Python	Go	Result
`client.init`	`init`	`init`	`init`	`InitDefault`	`Forge`
`client.init_from`	`init_from`	`initFrom`	`init_from`	`InitFrom`	`Forge`
`client.init_from_string`	`init_from_str`	`initFromString`	`init_from_string`	`InitFromString`	`Forge`
`client.init_memory_for_testing`	`init_memory_for_testing`	`initMemoryForTesting`	`init_memory_for_testing`	`NewMemoryForTesting`	`Forge`
`client.advance_test_clock`	`advance_test_clock`	`advanceTestClock`	`advance_test_clock`	`AdvanceTestClock`	`void`
`client.migrate`	`migrate`	`migrate`	`migrate`	`Migrate`	`MigrationReport[]`
`client.migrate_from`	`migrate_from`	`migrateFrom`	`migrate_from`	`MigrateFrom`	`MigrationReport[]`
`client.migrate_from_string`	`migrate_from_str`	`migrateFromString`	`migrate_from_string`	`MigrateFromString`	`MigrationReport[]`
`client.migration_status`	`migration_status`	`migrationStatus`	`migration_status`	`MigrationStatus`	`MigrationReport[]`
`client.migration_status_from`	`migration_status_from`	`migrationStatusFrom`	`migration_status_from`	`MigrationStatusFrom`	`MigrationReport[]`
`client.migration_status_from_string`	`migration_status_from_str`	`migrationStatusFromString`	`migration_status_from_string`	`MigrationStatusFromString`	`MigrationReport[]`
`client.validate_schema`	`validate_schema`	`validateSchema`	`validate_schema`	`ValidateSchema`	`MigrationReport[]`
`client.validate_schema_from`	`validate_schema_from`	`validateSchemaFrom`	`validate_schema_from`	`ValidateSchemaFrom`	`MigrationReport[]`
`client.validate_schema_from_string`	`validate_schema_from_str`	`validateSchemaFromString`	`validate_schema_from_string`	`ValidateSchemaFromString`	`MigrationReport[]`
`client.close`	`close`	`close`	`close`	`Close`	`void`
`client.backend_capabilities`	`backend_capabilities`	`backendCapabilities`	`backend_capabilities`	`BackendCapabilities`	`BackendInfo[]`
`client.liveness`	`is_live`	`isLive`	`is_live`	`IsLive`	`boolean`
`client.probe`	`probe`	`probe`	`probe`	`Probe`	`HealthReport`
`client.metrics_snapshot`	`metrics_snapshot`	`metricsSnapshot`	`metrics_snapshot`	`MetricsSnapshot`	`MetricSample[]`
`client.diagnostics`	`diagnostics`	`diagnostics`	`diagnostics`	`Diagnostics`	`DiagnosticsReport`
`client.render_prometheus`	`render_prometheus`	`renderPrometheus`	`render_prometheus`	`RenderPrometheus`	`string`
`client.maintain`	`maintain`	`maintain`	`maintain`	`Maintain`	`void`
`client.postgres_url`	`postgres_url`	`postgresUrl`	`postgres_url`	`PostgresURL`	`string`
`kv.get`	`get`	`kvGet`, `kvGetBytes`	`kv_get`, `kv_get_bytes`	`KVGet`	`bytes?`
`kv.mget`	`mget`	`kvMget`	`kv_mget`	`KVMGet`	`bytes?[]`
`kv.set`	`set`	`kvSet`, `kvSetBytes`	`kv_set`, `kv_set_bytes`	`KVSet`	`boolean`
`kv.delete`	`delete`	`kvDelete`	`kv_delete`	`KVDelete`	`boolean`
`kv.exists`	`exists`	`kvExists`	`kv_exists`	`KVExists`	`boolean`
`kv.incr`	`incr`	`kvIncr`	`kv_incr`	`KVIncr`	`int64`
`kv.expire`	`expire`	`kvExpire`	`kv_expire`	`KVExpire`	`boolean`
`kv.compare_and_swap`	`compare_and_swap`	`kvCompareAndSwap`	`kv_compare_and_swap`	`KVCompareAndSwap`	`boolean`
`kv.scan`	`scan`	`kvScan`, `kvScanPage`	`kv_scan`, `kv_scan_page`	`KVScan`	`ScanPage`
`queue.enqueue`	`enqueue`	`queueEnqueue`	`queue_enqueue`	`Enqueue`	`JobId`
`queue.dequeue`	`dequeue`	`queueDequeue`	`queue_dequeue`	`Dequeue`	`Job?`
`queue.enqueue_batch`	`enqueue_batch`	`queueEnqueueBatch`	`queue_enqueue_batch`	`EnqueueBatch`	`BatchEnqueueResult[]`
`queue.dequeue_batch`	`dequeue_batch`	`queueDequeueBatch`	`queue_dequeue_batch`	`DequeueBatch`	`Job[]`
`queue.ack`	`ack`	`queueAck`	`queue_ack`	`Ack`	`void`
`queue.nack`	`nack`	`queueNack`	`queue_nack`	`Nack`	`void`
`queue.heartbeat`	`heartbeat`	`queueHeartbeat`	`queue_heartbeat`	`Heartbeat`	`void`
`queue.cancellation_requested`	`cancellation_requested`	`queueCancellationRequested`	`queue_cancellation_requested`	`CancellationRequested`	`boolean`
`queue.finish_cancellation`	`finish_cancellation`	`queueFinishCancellation`	`queue_finish_cancellation`	`FinishCancellation`	`void`
`queue.cancel`	`cancel`	`queueCancel`	`queue_cancel`	`CancelJob`	`JobStatus?`
`queue.status`	`status`	`queueStatus`	`queue_status`	`JobStatus`	`JobStatus?`
`queue.list_status`	`list_status`	`queueListStatus`	`queue_list_status`	`ListJobStatus`	`JobStatusPage`
`queue.depth`	`depth`	`queueDepth`	`queue_depth`	`Depth`	`QueueDepth`
`queue.dead_letters`	`dead_letters`	`queueDeadLetters`	`queue_dead_letters`	`DeadLetters`	`DeadLetterPage`
`queue.pause`	`pause`	`queuePause`	`queue_pause`	`PauseQueue`	`void`
`queue.resume`	`resume`	`queueResume`	`queue_resume`	`ResumeQueue`	`void`
`queue.is_paused`	`is_paused`	`queueIsPaused`	`queue_is_paused`	`QueuePaused`	`boolean`
`queue.stats`	`stats`	`queueStats`	`queue_stats`	`QueueStats`	`QueueStats`
`queue.redrive`	`redrive`	`queueRedrive`	`queue_redrive`	`Redrive`	`boolean`
`queue.redrive_batch`	`redrive_batch`	`queueRedriveBatch`	`queue_redrive_batch`	`RedriveBatch`	`RedriveBatchResult`
`queue.purge_dead_letters_dry_run`	`purge_dead_letters_dry_run`	`queuePurgeDeadLettersDryRun`	`queue_purge_dead_letters_dry_run`	`PurgeDeadLettersDryRun`	`count`
`queue.purge_dead_letters`	`purge_dead_letters`	`queuePurgeDeadLetters`	`queue_purge_dead_letters`	`PurgeDeadLetters`	`count`
`queue.outbox_once`	`run_outbox_once`	`runOutboxOnce`	`run_outbox_once`	`RunOutboxOnce`	`OutboxRelayReport`
`queue.outbox_relay`	`run_outbox_relay`, `run_outbox_relay_until`	`runOutboxRelay`	`run_outbox_relay`	`RunOutboxRelay`	`unit`
`config.get_raw`	`get_raw`	`configGet`	`config_get`	`ConfigGet`	`bytes?`
`config.set_raw`	`set_raw`	`configSet`	`config_set`	`ConfigSet`	`void`
`config.get_many_raw`	`get_many_raw`	`configGetMany`	`config_get_many`	`ConfigGetMany`	`ConfigEntry[]`
`config.delete_raw`	`delete_raw`	`configDelete`	`config_delete`	`ConfigDelete`	`boolean`
`config.flag`	`flag`	`flag`	`flag`	`Flag`	`boolean`
`config.set_flag`	`set_flag`	`setFlagPercent`, `setFlagOn`, `setFlagOff`, `setFlagAllowList`, `setFlagValue`	`set_flag_percent`, `set_flag_on`, `set_flag_off`, `set_flag_allow_list`, `set_flag_value`	`SetFlag`	`void`
`config.flag_details`	`flag_details`	`flagDetails`	`flag_details`	`FlagDetails`	`FlagEvaluation`
`config.delete_flag`	`delete_flag`	`deleteFlag`	`delete_flag`	`DeleteFlag`	`boolean`
`config.flag_details_many`	`flag_details_many`	`flagDetailsMany`	`flag_details_many`	`FlagDetailsMany`	`FlagEvaluationEntry[]`
`config.snapshot`	`snapshot`	`configSnapshot`	`config_snapshot`	`ConfigSnapshot`	`ConfigSnapshot`
`config.snapshot_encode`	`encode_snapshot`	`encodeConfigSnapshot`	`encode_config_snapshot`	`EncodeConfigSnapshot`	`bytes`
`config.snapshot_decode`	`decode_snapshot`	`decodeConfigSnapshot`	`decode_config_snapshot`	`DecodeConfigSnapshot`	`ConfigSnapshot`
`ratelimit.check`	`check`, `check_with`	`rateLimitCheck`	`rate_limit_check`	`RateLimitCheck`	`Decision`
`ratelimit.check_weighted`	`check_cost`, `check_cost_with`	`rateLimitCheck`	`rate_limit_check`	`RateLimitCheck`	`Decision`
`ratelimit.reserve`	`reserve`	`rateLimitReserve`	`rate_limit_reserve`	`RateLimitReserve`	`Reservation?`
`ratelimit.commit`	`commit`	`rateLimitCommit`	`rate_limit_commit`	`RateLimitCommit`	`Reservation`
`ratelimit.release`	`release`	`rateLimitRelease`	`rate_limit_release`	`RateLimitRelease`	`Reservation`
`blob.put`	`put`	`blobPut`, `blobPutBytes`, `blobPutObject`	`blob_put`, `blob_put_object`	`BlobPut`	`void`
`blob.put_stream`	`put_stream`	`blobPutFile`	`blob_put_file`	`BlobPutStream`	`void`
`blob.get`	`get`, `open`	`blobGet`, `blobGetBytes`	`blob_get`	`BlobGet`, `BlobOpen`	`bytes?`
`blob.get_range`	`get_range`	`blobGetRange`	`blob_get_range`	`BlobGetRange`	`bytes?`
`blob.get_if`	`get_if`	`blobGetIf`	`blob_get_if`	`BlobGetIf`	`ConditionalBlobGet`
`blob.head`	`head`	`blobHead`, `blobContentType`	`blob_head`, `blob_content_type`	`BlobHead`	`BlobInfo?`
`blob.delete`	`delete`	`blobDelete`	`blob_delete`	`BlobDelete`	`void`
`blob.list`	`list`	`blobList`	`blob_list`	`BlobList`	`BlobPage`
`blob.copy`	`copy`	`blobCopy`	`blob_copy`	`BlobCopy`	`BlobInfo`
`blob.create_multipart`	`create_multipart`	`blobCreateMultipart`	`blob_create_multipart`	`BlobCreateMultipart`	`MultipartUpload`
`blob.upload_part`	`upload_part`	`blobUploadPart`	`blob_upload_part`	`BlobUploadPart`	`MultipartPart`
`blob.complete_multipart`	`complete_multipart`	`blobCompleteMultipart`	`blob_complete_multipart`	`BlobCompleteMultipart`	`BlobInfo`
`blob.abort_multipart`	`abort_multipart`	`blobAbortMultipart`	`blob_abort_multipart`	`BlobAbortMultipart`	`void`
`blob.verify_checksum_sha256`	`verify_checksum_sha256`	`blobVerifyChecksumSha256`	`blob_verify_checksum_sha256`	`BlobVerifyChecksumSHA256`	`boolean`
`blob.presign_upload`	`presign_upload`	`blobPresignUpload`	`blob_presign_upload`	`BlobPresignUpload`	`ProxyPresign`
`blob.presign_download`	`presign_download`	`blobPresignDownload`	`blob_presign_download`	`BlobPresignDownload`	`ProxyPresign`
`blob.presign_native_get`	`presign_native_get`	`blobPresignNativeGet`	`blob_presign_native_get`	`BlobPresignNativeGet`	`NativePresign`
`blob.presign_native_put`	`presign_native_put`	`blobPresignNativePut`	`blob_presign_native_put`	`BlobPresignNativePut`	`NativePresign`
`blob.verify_presigned`	`verify_presigned`	`blobVerifyPresign`	`blob_verify_presign`	`BlobVerifyPresigned`	`boolean`
`auth.hash_password`	`hash_password`	`hashPassword`	`hash_password`	`HashPassword`	`string`
`auth.verify_password`	`verify_password`	`verifyPassword`	`verify_password`	`VerifyPassword`	`boolean`
`auth.needs_rehash`	`needs_rehash`	`needsRehash`	`needs_rehash`	`NeedsRehash`	`boolean`
`auth.create_session`	`create_session`	`createSession`	`create_session`	`CreateSession`	`string`
`auth.validate_session`	`validate_session`	`validateSession`, `validateSessionInfo`	`validate_session`, `validate_session_info`	`ValidateSession`	`Session?`
`auth.revoke_session`	`revoke_session`	`revokeSession`	`revoke_session`	`RevokeSession`	`void`
`auth.revoke_all_sessions`	`revoke_all_sessions`	`revokeAllSessions`	`revoke_all_sessions`	`RevokeAllSessions`	`uint64`
`auth.create_api_key`	`create_api_key`, `create_api_key_with`	`createApiKey`, `createApiKeyWith`	`create_api_key`, `create_api_key_with`	`CreateAPIKey`	`ApiKey`
`auth.verify_api_key`	`verify_api_key`	`verifyApiKey`	`verify_api_key`	`VerifyAPIKey`	`ApiKeyInfo?`
`auth.revoke_api_key`	`revoke_api_key`	`revokeApiKey`	`revoke_api_key`	`RevokeAPIKey`	`void`
`auth.create_token`	`create_token`, `create_token_with_payload`	`createToken`, `createTokenWithPayload`	`create_token`, `create_token_with_payload`	`CreateToken`	`string`
`auth.consume_token`	`consume_token`, `consume_token_with_payload`	`consumeToken`, `consumeTokenWithPayload`	`consume_token`, `consume_token_with_payload`	`ConsumeToken`	`TokenConsumption?`
`scope.kv_key`	`scope_kv_key`	`scopeKvKey`	`scope_kv_key`	`ScopeKVKey`	`string`
`scope.blob_key`	`scope_blob_key`	`scopeBlobKey`	`scope_blob_key`	`ScopeBlobKey`	`string`
`scope.rate_limit_subject`	`scope_rate_limit_subject`	`scopeRateLimitSubject`	`scope_rate_limit_subject`	`ScopeRateLimitSubject`	`string`
`scope.topic`	`scope_topic`	`scopeTopic`	`scope_topic`	`ScopeTopic`	`string`
`schedule.cron`	`cron`	`scheduleCron`	`schedule_cron`	`ScheduleCron`	`void`
`schedule.at`	`at`	`scheduleAt`	`schedule_at`	`ScheduleAt`	`JobId`
`schedule.cancel`	`cancel`	`scheduleCancel`	`schedule_cancel`	`ScheduleCancel`	`boolean`
`schedule.cancel_at`	`cancel_at`	`scheduleCancelAt`	`schedule_cancel_at`	`ScheduleCancelAt`	`boolean`
`schedule.inspect`	`inspect`	`scheduleInspect`	`schedule_inspect`	`ScheduleInspect`	`ScheduleInfo?`
`schedule.pause`	`pause`	`schedulePause`	`schedule_pause`	`SchedulePause`	`boolean`
`schedule.resume`	`resume`	`scheduleResume`	`schedule_resume`	`ScheduleResume`	`boolean`
`schedule.diagnostics`	`diagnostics`	`schedulerDiagnostics`	`scheduler_diagnostics`	`SchedulerDiagnostics`	`SchedulerDiagnostics`
`schedule.list`	`list`	`scheduleList`	`schedule_list`	`ScheduleList`	`SchedulePage`
`schedule.process_due`	`process_due`	`runSchedulerOnce`	`run_scheduler_once`	`RunSchedulerOnce`	`uint64`
`pubsub.channel_for`	`channel_for`	`pubsubChannel`	`pubsub_channel`	`PubsubChannel`	`string`
`pubsub.publish`	`publish`	`pubsubPublish`	`pubsub_publish`	`Publish`	`void`
`pubsub.subscribe`	`subscribe`	`pubsubSubscribe`	`pubsub_subscribe`	`Subscribe`	`Subscription`