Index

A B C D E F G H I J K M N O P Q R S T V W Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

add(BindingType...) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares several bindings at once, each taking its default name.
ai() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares the Workers AI binding, named AI.
AI - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
The Workers AI binding.
AI_SEARCH - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
An AI Search instance.
ALARM - Enum constant in enum class dev.gmitch215.bytebox.gradle.Triggers
A Durable Object alarm.
alarms() - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Returns the value of the alarms record component.
analytics(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares an Analytics Engine dataset named ANALYTICS.
ANALYTICS - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
An Analytics Engine dataset.
any(BindingType, String, Map<String, String>) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a binding of any type, for one this block has no method for yet.
apply(Project) - Method in class dev.gmitch215.bytebox.gradle.ByteboxPlugin
 
assets() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a static assets binding named ASSETS, serving ./public.
assets(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
ASSETS - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A static assets binding.
AUTO - Enum constant in enum class dev.gmitch215.bytebox.gradle.SizeSpec.ModuleType
Raw bytes, unless the module is too large for the platform to accept them.

B

BINDGEN - Static variable in class dev.gmitch215.bytebox.gradle.Runner
The binding generator, which ships with the bytebox npm package.
Binding - Record Class in dev.gmitch215.bytebox.gradle
One declared binding, with the name it resolved to.
Binding(BindingType, String) - Constructor for record class dev.gmitch215.bytebox.gradle.Binding
 
Binding(BindingType, String, Map<String, String>) - Constructor for record class dev.gmitch215.bytebox.gradle.Binding
Creates an instance of a Binding record class.
bindingName() - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Returns the binding name, which is DO_ and the class name upper-snaked.
bindings(BindingType...) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Declares bindings by type, each taking its default name.
bindings(Action<Bindings>) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Declares bindings.
Bindings - Class in dev.gmitch215.bytebox.gradle
The bindings { } block.
Bindings() - Constructor for class dev.gmitch215.bytebox.gradle.Bindings
 
Bindings.D1Spec - Class in dev.gmitch215.bytebox.gradle
Identifiers a D1 database can carry.
Bindings.KvSpec - Class in dev.gmitch215.bytebox.gradle
Identifiers a KV namespace can carry.
Bindings.R2Spec - Class in dev.gmitch215.bytebox.gradle
Identifiers an R2 bucket can carry.
BindingsReportTask - Class in dev.gmitch215.bytebox.gradle
Prints every declared binding, its resolved name, and the remote resource it points at.
BindingsReportTask() - Constructor for class dev.gmitch215.bytebox.gradle.BindingsReportTask
 
BindingType - Enum Class in dev.gmitch215.bytebox.gradle
A binding type, for the short form of the bindings block.
browser() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares the Browser Rendering binding, named BROWSER.
BROWSER - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
The Browser Rendering binding.
budgetBytes() - Method in class dev.gmitch215.bytebox.gradle.SizeSpec
The budget in bytes, or -1 when none is set.
BUFFER_HEAP_MEGABYTES - Static variable in class dev.gmitch215.bytebox.gradle.ByteboxPlugin
Megabytes of linear memory the interop stages arrays through, which cannot be zero.
ByteboxExtension - Class in dev.gmitch215.bytebox.gradle
The bytebox { } block.
ByteboxExtension(ObjectFactory) - Constructor for class dev.gmitch215.bytebox.gradle.ByteboxExtension
 
ByteboxPlugin - Class in dev.gmitch215.bytebox.gradle
Compiles a Java workspace into a Cloudflare Worker.
ByteboxPlugin() - Constructor for class dev.gmitch215.bytebox.gradle.ByteboxPlugin
 

C

CLASS_NAME - Static variable in class dev.gmitch215.bytebox.gradle.GenerateEntryPointTask
The generated class's simple name.
className() - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Returns the value of the className record component.
command(List<String>) - Method in class dev.gmitch215.bytebox.gradle.Runner
The full command line for a Wrangler invocation.
CompatibilityDate - Class in dev.gmitch215.bytebox.gradle
Checks a compatibility date before Wrangler has to.
compatibilityFlags(String...) - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Adds compatibility flags.
compressionArgs(String...) - Method in class dev.gmitch215.bytebox.gradle.SizeSpec
Deprecated, for removal: This API element is subject to removal in a future version.
configKey() - Method in enum class dev.gmitch215.bytebox.gradle.BindingType
Returns the Wrangler configuration key this type is written under.
CONTAINER - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A container.
crons(String...) - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Adds Cron Triggers.

D

d1() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a D1 database named DB.
d1(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
d1(String, Action<Bindings.D1Spec>) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
D1 - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A D1 database.
D1Spec() - Constructor for class dev.gmitch215.bytebox.gradle.Bindings.D1Spec
 
DATA - Enum constant in enum class dev.gmitch215.bytebox.gradle.SizeSpec.ModuleType
Raw bytes in a Data module.
DATA_COMPRESSED - Enum constant in enum class dev.gmitch215.bytebox.gradle.SizeSpec.ModuleType
Deprecated, for removal: This API element is subject to removal in a future version.
buys bundle bytes Cloudflare stopped metering on 2026-09-04, and spends startup time it still meters
decoder() - Method in enum class dev.gmitch215.bytebox.gradle.SizeSpec.Compressor
Deprecated.
Returns the npm package holding the synchronous decoder, or null when none is needed.
defaultName() - Method in enum class dev.gmitch215.bytebox.gradle.BindingType
Returns the name the first binding of this type takes.
describe() - Method in class dev.gmitch215.bytebox.gradle.Runner
Returns a description for the build log.
dev.gmitch215.bytebox.gradle - package dev.gmitch215.bytebox.gradle
The Gradle plugin that turns a Java workspace into a Cloudflare Worker.
DISPATCH - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Workers for Platforms dispatch namespace.
DURABLE_OBJECT - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Durable Object namespace.
durableObject(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a Durable Object namespace, named DO_ and the class name upper-snaked.
durableObject(String, String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a Durable Object living in another Worker.
durableObjects(String...) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Exposes Java classes as Durable Objects.
DurableObjects - Record Class in dev.gmitch215.bytebox.gradle
A Durable Object class written in Java, and which of its handlers exist.
DurableObjects(String, boolean, boolean) - Constructor for record class dev.gmitch215.bytebox.gradle.DurableObjects
Creates an instance of a DurableObjects record class.

E

email(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares an email sending binding named EMAIL.
EMAIL - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
An email sending binding.
EMAIL - Enum constant in enum class dev.gmitch215.bytebox.gradle.Triggers
Incoming email.
equals(Object) - Method in record class dev.gmitch215.bytebox.gradle.Binding
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Indicates whether some other object is "equal to" this one.
executable() - Method in class dev.gmitch215.bytebox.gradle.Runner
Returns the resolved executable, so a build can log which one it found.
exportName() - Method in enum class dev.gmitch215.bytebox.gradle.Triggers
Returns the name the generated Worker exports for this trigger.
exportPrefix() - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
The prefix every export for this object shares.

F

FETCH - Enum constant in enum class dev.gmitch215.bytebox.gradle.Triggers
HTTP requests.

G

generate() - Method in class dev.gmitch215.bytebox.gradle.GenerateCodecsTask
Writes the codecs.
generate() - Method in class dev.gmitch215.bytebox.gradle.GenerateEntryPointTask
Writes the entry point.
generate() - Method in class dev.gmitch215.bytebox.gradle.GenerateNPMBindingsTask
Runs the generator.
generate() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Writes the project.
generate() - Method in class dev.gmitch215.bytebox.gradle.GenerateSerialCodecsTask
Writes the codecs.
GenerateCodecsTask - Class in dev.gmitch215.bytebox.gradle
Writes a JSON codec for every type asked for, and one class that registers them all.
GenerateCodecsTask() - Constructor for class dev.gmitch215.bytebox.gradle.GenerateCodecsTask
 
GENERATED_SOURCE_SET - Static variable in class dev.gmitch215.bytebox.gradle.ByteboxPlugin
The source set the generated entry point and codecs are compiled in.
GenerateEntryPointTask - Class in dev.gmitch215.bytebox.gradle
Writes the Java class the compiled module exports its handlers from.
GenerateEntryPointTask() - Constructor for class dev.gmitch215.bytebox.gradle.GenerateEntryPointTask
 
GenerateNPMBindingsTask - Class in dev.gmitch215.bytebox.gradle
Writes Java bindings for the npm packages a project asks for, from their TypeScript types.
GenerateNPMBindingsTask(ExecOperations) - Constructor for class dev.gmitch215.bytebox.gradle.GenerateNPMBindingsTask
 
GenerateScaffoldTask - Class in dev.gmitch215.bytebox.gradle
Writes the Worker project around the compiled module: the Wrangler configuration, the JavaScript entry point, and the package manifest.
GenerateScaffoldTask() - Constructor for class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
 
GenerateSerialCodecsTask - Class in dev.gmitch215.bytebox.gradle
Writes a codec for every type annotated @SerialType, in Java's own serialization format.
GenerateSerialCodecsTask() - Constructor for class dev.gmitch215.bytebox.gradle.GenerateSerialCodecsTask
 
getAll() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Returns every binding declared so far, in declaration order.
getArgs() - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Returns extra arguments from the command line.
getBindings() - Method in class dev.gmitch215.bytebox.gradle.BindingsReportTask
Returns the declared bindings.
getBindings() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns the declared bindings.
getBindings() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the declared bindings.
getBucketName() - Method in class dev.gmitch215.bytebox.gradle.Bindings.R2Spec
Returns the bucket's own name.
getBudget() - Method in class dev.gmitch215.bytebox.gradle.PackWasmTask
Returns the ceiling to fail past, in uncompressed bytes, or -1 for none.
getBudget() - Method in class dev.gmitch215.bytebox.gradle.SizeReportTask
Returns the ceiling to compare against, or -1 for none.
getBudget() - Method in class dev.gmitch215.bytebox.gradle.SizeSpec
Returns a ceiling the build fails past, measured on the uncompressed module.
getByteboxVersion() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the version of bytebox to depend on.
getClasspath() - Method in class dev.gmitch215.bytebox.gradle.GenerateCodecsTask
Returns everything needed to resolve those classes, including bytebox itself.
getClasspath() - Method in class dev.gmitch215.bytebox.gradle.GenerateSerialCodecsTask
Returns everything needed to resolve those classes, including bytebox itself.
getCommand() - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Returns the Wrangler subcommand and its fixed arguments.
getCompatibilityDate() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the compatibility date.
getCompatibilityDate() - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Returns the compatibility date.
getCompatibilityFlags() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the compatibility flags, before the Node ones are dealt with.
getCompatibilityFlags() - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Returns the compatibility flags.
getCompression() - Method in class dev.gmitch215.bytebox.gradle.PackWasmTask
Deprecated, for removal: This API element is subject to removal in a future version.
getCompression() - Method in class dev.gmitch215.bytebox.gradle.SizeSpec
Deprecated, for removal: This API element is subject to removal in a future version.
nothing reads this. Cloudflare removed the compressed size limit on 2026-09-04, so pre-compression trades startup time for bundle bytes that are no longer metered.
getCompressionArgs() - Method in class dev.gmitch215.bytebox.gradle.SizeSpec
Deprecated, for removal: This API element is subject to removal in a future version.
getCompressionLevel() - Method in class dev.gmitch215.bytebox.gradle.SizeSpec
Deprecated, for removal: This API element is subject to removal in a future version.
getConfirmed() - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Returns whether a write was confirmed.
getCoreDependency() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns whether applying the plugin puts bytebox on the classpath, which it does by default.
getCoreVersion() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns the version of bytebox-core to add, defaulting to the plugin's own.
getCrons() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the Cron Triggers that fire it.
getCrons() - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Returns the Cron Triggers that fire it.
getDatabaseId() - Method in class dev.gmitch215.bytebox.gradle.Bindings.D1Spec
Returns the database id.
getDatabaseName() - Method in class dev.gmitch215.bytebox.gradle.Bindings.D1Spec
Returns the database's own name.
getDecoder() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the npm package supplying the synchronous decompressor, when one is needed.
getDecoderVersion() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the version range for that package.
getDestructive() - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Returns whether this command changes or destroys something.
getDurableObjectClasses() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns the Java classes to expose as Durable Objects, fully qualified.
getDurableObjectClasses() - Method in class dev.gmitch215.bytebox.gradle.GenerateEntryPointTask
Returns the Java classes exposed as Durable Objects.
getDurableObjects() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the Durable Objects written in Java, each needing a JavaScript class to be one.
getHandlerClass() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns the class implementing one or more of the trigger interfaces.
getHandlerClass() - Method in class dev.gmitch215.bytebox.gradle.GenerateEntryPointTask
Returns the handler class to route to.
getHandlerClasspath() - Method in class dev.gmitch215.bytebox.gradle.GenerateEntryPointTask
Returns where to find the handler, so its interfaces can be read.
getId() - Method in class dev.gmitch215.bytebox.gradle.Bindings.KvSpec
Returns the namespace id, or null to let Wrangler provision one.
getIntrospect() - Method in class dev.gmitch215.bytebox.gradle.GenerateNPMBindingsTask
Returns whether the generator may import a package to read exports it cannot see.
getJavaPackage() - Method in class dev.gmitch215.bytebox.gradle.GenerateNPMBindingsTask
Returns the Java package the generated classes live in.
getJSONTypes() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns the types to generate JSON codecs for, fully qualified.
getJurisdiction() - Method in class dev.gmitch215.bytebox.gradle.Bindings.R2Spec
Returns the jurisdiction the bucket is pinned to, such as eu.
getMigrationsDir() - Method in class dev.gmitch215.bytebox.gradle.Bindings.D1Spec
Returns where the migrations live.
getModule() - Method in class dev.gmitch215.bytebox.gradle.SizeSpec
Returns how the compiled module is carried in the bundle.
getModuleType() - Method in class dev.gmitch215.bytebox.gradle.PackWasmTask
Returns how the module is carried.
getName() - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Returns the Worker's name.
getNodeDirectory() - Method in class dev.gmitch215.bytebox.gradle.GenerateNPMBindingsTask
Returns the directory holding node_modules.
getNPMBindingPackages() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns the npm packages to generate Java bindings for.
getNPMIntrospection() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns whether the generator may import a package to read exports no static analysis can see.
getNPMPackages() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns the npm packages the compiled program imports, as name@range.
getNPMPackages() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the npm packages the program imports, as name@range.
getObservability() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns whether to send logs to Cloudflare's observability.
getObservability() - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Returns whether to send logs to Cloudflare's observability.
getOutputDirectory() - Method in class dev.gmitch215.bytebox.gradle.GenerateCodecsTask
Returns where the generated source goes.
getOutputDirectory() - Method in class dev.gmitch215.bytebox.gradle.GenerateEntryPointTask
Returns where the generated source goes.
getOutputDirectory() - Method in class dev.gmitch215.bytebox.gradle.GenerateNPMBindingsTask
Returns where the generated source goes.
getOutputDirectory() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns where the project is written.
getOutputDirectory() - Method in class dev.gmitch215.bytebox.gradle.GenerateSerialCodecsTask
Returns where the generated source goes.
getOutputDirectory() - Method in class dev.gmitch215.bytebox.gradle.PackWasmTask
Returns where the Worker's sources live.
getPackages() - Method in class dev.gmitch215.bytebox.gradle.GenerateNPMBindingsTask
Returns the package specifiers to bind, each optionally naming a subpath export.
getPreviewId() - Method in class dev.gmitch215.bytebox.gradle.Bindings.KvSpec
Returns the namespace used by wrangler dev.
getProjectDirectory() - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Returns the generated Worker project, which is the working directory.
getRequiresAccount() - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Returns whether this command needs a logged-in Wrangler.
getRoutes() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the routes the Worker answers on.
getRoutes() - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Returns the routes this Worker answers on.
getRunner() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns which runtime runs the Wrangler CLI.
getRunner() - Method in class dev.gmitch215.bytebox.gradle.GenerateNPMBindingsTask
Returns the pinned runner, or empty to search.
getRunner() - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Returns the pinned runner, or empty to search.
getRuntime() - Method in class dev.gmitch215.bytebox.gradle.PackWasmTask
Returns the generated runtime beside it.
getScanned() - Method in class dev.gmitch215.bytebox.gradle.GenerateCodecsTask
Returns the project's own compiled classes, which are the ones scanned.
getScanned() - Method in class dev.gmitch215.bytebox.gradle.GenerateSerialCodecsTask
Returns the project's own compiled classes, which are the ones scanned.
getSerialTypes() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns the types to generate java.io serialization codecs for, fully qualified.
getSize() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns how the compiled module is packed and how big it is allowed to get.
getTailConsumers() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the Workers this one sends logs to.
getTailConsumers() - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Returns the Workers this one sends its logs to.
getTriggers() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the triggers the handler handles, by export name.
getTypes() - Method in class dev.gmitch215.bytebox.gradle.GenerateCodecsTask
Returns types to generate codecs for that the scan would not find.
getTypes() - Method in class dev.gmitch215.bytebox.gradle.GenerateSerialCodecsTask
Returns types to generate codecs for that the scan would not find.
getWasm() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the compiled module, read for the platform modules it imports.
getWasm() - Method in class dev.gmitch215.bytebox.gradle.PackWasmTask
Returns the compiled module.
getWasm() - Method in class dev.gmitch215.bytebox.gradle.SizeReportTask
Returns the compiled module to measure.
getWorkerName() - Method in class dev.gmitch215.bytebox.gradle.GenerateScaffoldTask
Returns the Worker's name.
getWrangler() - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Returns what goes into the generated Wrangler configuration.
GROUP - Static variable in class dev.gmitch215.bytebox.gradle.ByteboxPlugin
The task group every task this plugin registers belongs to.
GZIP - Enum constant in enum class dev.gmitch215.bytebox.gradle.SizeSpec.Compressor
Deprecated.
gzip, inflated by fflate.

H

hashCode() - Method in record class dev.gmitch215.bytebox.gradle.Binding
Returns a hash code value for this object.
hashCode() - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Returns a hash code value for this object.
hyperdrive(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a Hyperdrive configuration named HYPERDRIVE.
HYPERDRIVE - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Hyperdrive configuration.

I

identifiers() - Method in record class dev.gmitch215.bytebox.gradle.Binding
Returns the value of the identifiers record component.
images() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares the Images binding, named IMAGES.
IMAGES - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
The Images binding.
interfaceName() - Method in enum class dev.gmitch215.bytebox.gradle.Triggers
Returns the interface a handler implements to handle this trigger.

J

jsonTypes(String...) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Adds types to generate JSON codecs for.

K

kv() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a KV namespace named KV.
kv(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
kv(String, Action<Bindings.KvSpec>) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
KV - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Workers KV namespace.
KvSpec() - Constructor for class dev.gmitch215.bytebox.gradle.Bindings.KvSpec
 

M

MTLS - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
An mTLS certificate.

N

name() - Method in record class dev.gmitch215.bytebox.gradle.Binding
Returns the value of the name record component.
nodeCompatByDefault(LocalDate) - Static method in class dev.gmitch215.bytebox.gradle.CompatibilityDate
Whether a date has Node compatibility on by default.
NONE - Enum constant in enum class dev.gmitch215.bytebox.gradle.SizeSpec.Compressor
Deprecated.
No pre-compression, and nothing to inflate at startup.
npm(String, String) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Declares an npm package the compiled program imports.
NPM_PACKAGE - Static variable in class dev.gmitch215.bytebox.gradle.ByteboxPlugin
The Java package generated npm bindings live in.
npmBindings(String...) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Asks for generated Java bindings for packages already declared with ByteboxExtension.npm(java.lang.String, java.lang.String).

O

of(String, Iterable<File>) - Static method in enum class dev.gmitch215.bytebox.gradle.Triggers
Reads the triggers a class handles.
of(List<String>, Iterable<File>) - Static method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Reads each named class.

P

pack() - Method in class dev.gmitch215.bytebox.gradle.PackWasmTask
Packs the module.
PACKAGE - Static variable in class dev.gmitch215.bytebox.gradle.GenerateCodecsTask
The package the generated codecs live in.
PACKAGE - Static variable in class dev.gmitch215.bytebox.gradle.GenerateEntryPointTask
The package the generated entry point lives in.
PACKAGE - Static variable in class dev.gmitch215.bytebox.gradle.GenerateSerialCodecsTask
The package the generated codecs live in.
PackWasmTask - Class in dev.gmitch215.bytebox.gradle
Puts the compiled module where the Worker imports it from, and enforces the size budget.
PackWasmTask() - Constructor for class dev.gmitch215.bytebox.gradle.PackWasmTask
 
parse(String) - Static method in class dev.gmitch215.bytebox.gradle.CompatibilityDate
Reads a date, refusing anything Wrangler would refuse for a reason decidable here.
PIPELINE - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Pipeline.

Q

queue() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a Queue producer named QUEUE.
queue(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
queue(String, String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
QUEUE - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Queue producer.
QUEUE - Enum constant in enum class dev.gmitch215.bytebox.gradle.Triggers
Queue batches.

R

r2() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares an R2 bucket named BLOB.
r2(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
r2(String, Action<Bindings.R2Spec>) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
R2 - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
An R2 bucket.
R2Spec() - Constructor for class dev.gmitch215.bytebox.gradle.Bindings.R2Spec
 
rateLimit(int, int, int) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a rate limiter named RATELIMIT.
RATELIMIT - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A rate limiter.
redundant(LocalDate, List<String>) - Static method in class dev.gmitch215.bytebox.gradle.CompatibilityDate
Flags that are already the default for a date, and so do nothing.
REGISTRY - Static variable in class dev.gmitch215.bytebox.gradle.GenerateCodecsTask
The class that registers every generated codec.
REGISTRY - Static variable in class dev.gmitch215.bytebox.gradle.GenerateSerialCodecsTask
The class that registers every generated codec.
repeatable() - Method in enum class dev.gmitch215.bytebox.gradle.BindingType
Whether a Worker can declare more than one of these.
report() - Method in class dev.gmitch215.bytebox.gradle.BindingsReportTask
Prints the report.
report() - Method in class dev.gmitch215.bytebox.gradle.SizeReportTask
Measures the module and writes the result to the build log.
resolve(String) - Static method in class dev.gmitch215.bytebox.gradle.Runner
Resolves a runner for the Wrangler CLI.
resolve(String, String) - Static method in class dev.gmitch215.bytebox.gradle.Runner
Resolves a runner for a named tool, or explains what to install.
routes(String...) - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Adds routes.
run() - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Runs the command.
Runner - Class in dev.gmitch215.bytebox.gradle
Finds something that can run a Node command-line tool.

S

SCHEDULED - Enum constant in enum class dev.gmitch215.bytebox.gradle.Triggers
Cron Triggers.
SECRETS - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Secrets Store secret.
serialTypes(String...) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Adds types to generate serialization codecs for.
service(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a service binding to another Worker.
service(String, String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
SERVICE - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
Another Worker, reached with no network hop.
setArgsOption(String) - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Extra arguments, split on spaces.
setBucketName(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings.R2Spec
 
setConfirmedOption(boolean) - Method in class dev.gmitch215.bytebox.gradle.WranglerTask
Confirms a command that writes.
setDatabaseId(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings.D1Spec
 
setDatabaseName(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings.D1Spec
 
setId(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings.KvSpec
 
setJurisdiction(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings.R2Spec
 
setMigrationsDir(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings.D1Spec
 
setPreviewId(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings.KvSpec
 
simpleName() - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Returns the class's simple name, which is what the binding and the JavaScript class are called.
size(Action<SizeSpec>) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Configures packing and the size budget.
SizeReportTask - Class in dev.gmitch215.bytebox.gradle
Measures the compiled module and prints what the platform meters beside what it does not.
SizeReportTask() - Constructor for class dev.gmitch215.bytebox.gradle.SizeReportTask
 
SizeSpec - Class in dev.gmitch215.bytebox.gradle
The size { } block: how the compiled module is packed, and how big it may get.
SizeSpec() - Constructor for class dev.gmitch215.bytebox.gradle.SizeSpec
 
SizeSpec.Compressor - Enum Class in dev.gmitch215.bytebox.gradle
Deprecated, for removal: This API element is subject to removal in a future version.
SizeSpec.ModuleType - Enum Class in dev.gmitch215.bytebox.gradle
How the compiled module is carried in the bundle.
sockets() - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Returns the value of the sockets record component.

T

TAIL - Enum constant in enum class dev.gmitch215.bytebox.gradle.Triggers
Trace events from another Worker.
tailConsumers(String...) - Method in class dev.gmitch215.bytebox.gradle.WranglerSpec
Adds tail consumers.
toConfig() - Method in record class dev.gmitch215.bytebox.gradle.Binding
This binding as the object Wrangler expects under BindingType.configKey().
toString() - Method in record class dev.gmitch215.bytebox.gradle.Binding
Returns a string representation of this record class.
toString() - Method in record class dev.gmitch215.bytebox.gradle.DurableObjects
Returns a string representation of this record class.
Triggers - Enum Class in dev.gmitch215.bytebox.gradle
Which triggers a handler class handles.
type() - Method in record class dev.gmitch215.bytebox.gradle.Binding
Returns the value of the type record component.

V

valueOf(String) - Static method in enum class dev.gmitch215.bytebox.gradle.BindingType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.gmitch215.bytebox.gradle.SizeSpec.Compressor
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.gmitch215.bytebox.gradle.SizeSpec.ModuleType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class dev.gmitch215.bytebox.gradle.Triggers
Returns the enum constant of this class with the specified name.
values() - Static method in enum class dev.gmitch215.bytebox.gradle.BindingType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.gmitch215.bytebox.gradle.SizeSpec.Compressor
Deprecated.
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.gmitch215.bytebox.gradle.SizeSpec.ModuleType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class dev.gmitch215.bytebox.gradle.Triggers
Returns an array containing the constants of this enum class, in the order they are declared.
vectorize(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a Vectorize index named VECTORIZE.
vectorize(String, String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
 
VECTORIZE - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Vectorize index.
version() - Method in enum class dev.gmitch215.bytebox.gradle.SizeSpec.Compressor
Deprecated.
Returns the version range for that package.
VERSION_METADATA - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
The running version's metadata.
versionMetadata() - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares the version metadata binding, named CF_VERSION_METADATA.

W

WORKER_DIRECTORY - Static variable in class dev.gmitch215.bytebox.gradle.ByteboxPlugin
Where the generated Worker project is written, under the build directory.
workflow(String) - Method in class dev.gmitch215.bytebox.gradle.Bindings
Declares a Workflow named WORKFLOW.
WORKFLOW - Enum constant in enum class dev.gmitch215.bytebox.gradle.BindingType
A Workflow.
wrangler(Action<WranglerSpec>) - Method in class dev.gmitch215.bytebox.gradle.ByteboxExtension
Configures the generated Wrangler configuration.
WRANGLER - Static variable in class dev.gmitch215.bytebox.gradle.Runner
The Wrangler CLI, which is what most of these tasks run.
WranglerSpec - Class in dev.gmitch215.bytebox.gradle
The wrangler { } block: what goes into the generated configuration.
WranglerSpec() - Constructor for class dev.gmitch215.bytebox.gradle.WranglerSpec
 
WranglerTask - Class in dev.gmitch215.bytebox.gradle
Runs the Wrangler CLI in the generated Worker project.
WranglerTask(ExecOperations) - Constructor for class dev.gmitch215.bytebox.gradle.WranglerTask
 

Z

ZSTD - Enum constant in enum class dev.gmitch215.bytebox.gradle.SizeSpec.Compressor
Deprecated.
zstd, inflated by fzstd.
A B C D E F G H I J K M N O P Q R S T V W Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form