diff --git a/.fern/metadata.json b/.fern/metadata.json
index 7c8be26..10776d2 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -1,5 +1,5 @@
{
- "cliVersion": "3.5.0",
+ "cliVersion": "3.14.0",
"generatorName": "fernapi/fern-java-sdk",
"generatorVersion": "3.18.5",
"generatorConfig": {
diff --git a/README.md b/README.md
index 482f453..89c7e89 100644
--- a/README.md
+++ b/README.md
@@ -52,7 +52,7 @@ Add the dependency in your `pom.xml` file:
com.anduril
lattice-sdk
- 5.0.0
+ 5.1.0
```
diff --git a/build.gradle b/build.gradle
index f7d7e49..1081a6d 100644
--- a/build.gradle
+++ b/build.gradle
@@ -47,7 +47,7 @@ java {
group = 'com.anduril'
-version = '5.0.0'
+version = '5.1.0'
jar {
dependsOn(":generatePomFileForMavenPublication")
@@ -78,21 +78,21 @@ publishing {
maven(MavenPublication) {
groupId = 'com.anduril'
artifactId = 'lattice-sdk'
- version = '5.0.0'
+ version = '5.1.0'
from components.java
pom {
- name = 'Anduril Industries, Inc.'
- description = 'Anduril Lattice SDK for Java'
- url = 'https://developer.anduril.com'
+ name = 'anduril'
+ description = 'The official SDK of anduril'
+ url = 'https://buildwithfern.com'
licenses {
license {
- name = 'Anduril Lattice Software Development Kit License Agreement'
+ name = 'Custom License (LICENSE)'
}
}
developers {
developer {
- name = 'Anduril Industries, Inc.'
- email = 'lattice-developers@anduril.com'
+ name = 'anduril'
+ email = 'developers@anduril.com'
}
}
scm {
diff --git a/reference.md b/reference.md
new file mode 100644
index 0000000..a3ade0f
--- /dev/null
+++ b/reference.md
@@ -0,0 +1,1244 @@
+# Reference
+## Entities
+client.entities.publishEntity(request) -> Entity
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Publish an entity for ingest into the Entities API. Entities created with this method are "owned" by the originator: other sources,
+such as the UI, may not edit or delete these entities. The server validates entities at API call time and
+returns an error if the entity is invalid.
+
+An entity ID must be provided when calling this endpoint. If the entity referenced by the entity ID does not exist
+then it will be created. Otherwise the entity will be updated. An entity will only be updated if its
+provenance.sourceUpdateTime is greater than the provenance.sourceUpdateTime of the existing entity.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.entities().publishEntity(
+ Entity
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**request:** `Entity`
+
+
+
+
+
+
+
+
+
+client.entities.getEntity(entityId) -> Entity
+
+-
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.entities().getEntity(
+ "entityId",
+ GetEntityRequest
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `String` — ID of the entity to return
+
+
+
+
+
+
+
+
+
+client.entities.overrideEntity(entityId, fieldPath, request) -> Entity
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Only fields marked with overridable can be overridden. Please refer to our documentation to see the comprehensive
+list of fields that can be overridden. The entity in the request body should only have a value set on the field
+specified in the field path parameter. Field paths are rooted in the base entity object and must be represented
+using lower_snake_case. Do not include "entity" in the field path.
+
+Note that overrides are applied in an eventually consistent manner. If multiple overrides are created
+concurrently for the same field path, the last writer wins.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.entities().overrideEntity(
+ "entityId",
+ "mil_view.disposition",
+ EntityOverride
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `String` — The unique ID of the entity to override
+
+
+
+
+
+-
+
+**fieldPath:** `String` — fieldPath to override
+
+
+
+
+
+-
+
+**entity:** `Optional`
+
+The entity containing the overridden fields. The service will extract the overridable fields from
+the object and ignore all other fields.
+
+
+
+
+
+-
+
+**provenance:** `Optional` — Additional information about the source of the override.
+
+
+
+
+
+
+
+
+
+client.entities.removeEntityOverride(entityId, fieldPath) -> Entity
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+This operation clears the override value from the specified field path on the entity.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.entities().removeEntityOverride(
+ "entityId",
+ "mil_view.disposition",
+ RemoveEntityOverrideRequest
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**entityId:** `String` — The unique ID of the entity to undo an override from.
+
+
+
+
+
+-
+
+**fieldPath:** `String` — The fieldPath to clear overrides from.
+
+
+
+
+
+
+
+
+
+client.entities.longPollEntityEvents(request) -> EntityEventResponse
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+This is a long polling API that will first return all pre-existing data and then return all new data as
+it becomes available. If you want to start a new polling session then open a request with an empty
+'sessionToken' in the request body. The server will return a new session token in the response.
+If you want to retrieve the next batch of results from an existing polling session then send the session
+token you received from the server in the request body. If no new data is available then the server will
+hold the connection open for up to 5 minutes. After the 5 minute timeout period, the server will close the
+connection with no results and you may resume polling with the same session token. If your session falls behind
+more than 3x the total number of entities in the environment, the server will terminate your session.
+In this case you must start a new session by sending a request with an empty session token.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.entities().longPollEntityEvents(
+ EntityEventRequest
+ .builder()
+ .sessionToken("sessionToken")
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**sessionToken:** `String` — Long-poll session identifier. Leave empty to start a new polling session.
+
+
+
+
+
+-
+
+**batchSize:** `Optional` — Maximum size of response batch. Defaults to 100. Must be between 1 and 2000 (inclusive).
+
+
+
+
+
+
+
+
+
+client.entities.streamEntities(request) -> Optional<StreamEntitiesResponse>
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Establishes a server-sent events (SSE) connection that streams entity data in real-time.
+This is a one-way connection from server to client that follows the SSE protocol with text/event-stream content type.
+
+This endpoint enables clients to maintain a real-time view of the common operational picture (COP)
+by first streaming all pre-existing entities that match filter criteria, then continuously delivering
+updates as entities are created, modified, or deleted.
+
+The server first sends events with type PREEXISTING for all live entities matching the filter that existed before the stream was open,
+then streams CREATE events for newly created entities, UPDATE events when existing entities change, and DELETED events when entities are removed. The stream remains open
+indefinitely unless preExistingOnly is set to true.
+
+Heartbeat messages can be configured to maintain connection health and detect disconnects by setting the heartbeatIntervalMS
+parameter. These heartbeats help keep the connection alive and allow clients to verify the server is still responsive.
+
+Clients can optimize bandwidth usage by specifying which entity components they need populated using the componentsToInclude parameter.
+This allows receiving only relevant data instead of complete entities.
+
+The connection automatically recovers from temporary disconnections, resuming the stream where it left off. Unlike polling approaches,
+this provides real-time updates with minimal latency and reduced server load.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.entities().streamEntities(
+ EntityStreamRequest
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**heartbeatIntervalMs:** `Optional` — at what interval to send heartbeat events, defaults to 30s.
+
+
+
+
+
+-
+
+**preExistingOnly:** `Optional` — only stream pre-existing entities in the environment and then close the connection, defaults to false.
+
+
+
+
+
+-
+
+**componentsToInclude:** `Optional>` — list of components to include, leave empty to include all components.
+
+
+
+
+
+
+
+
+
+client.tasks.createTask(request) -> Task
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a new Task in the system with the specified parameters.
+
+This method initiates a new task with a unique ID (either provided or auto-generated),
+sets the initial task state to STATUS_CREATED, and establishes task ownership. The task
+can be assigned to a specific agent through the Relations field.
+
+Once created, a task enters the lifecycle workflow and can be tracked, updated, and managed
+through other Tasks API endpoints.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.tasks().createTask(
+ TaskCreation
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**taskId:** `Optional`
+
+If non-empty, will set the requested Task ID, otherwise will generate a new random
+GUID. Will reject if supplied Task ID does not match [A-Za-z0-9_-.]{5,36}.
+
+
+
+
+
+-
+
+**displayName:** `Optional` — Human readable display name for this Task, should be short (<100 chars).
+
+
+
+
+
+-
+
+**description:** `Optional` — Longer, free form human readable description of this Task.
+
+
+
+
+
+-
+
+**specification:** `Optional` — The path for the Protobuf task definition, and the complete task data.
+
+
+
+
+
+-
+
+**author:** `Optional`
+
+
+
+
+
+-
+
+**relations:** `Optional`
+
+Any relationships associated with this Task, such as a parent Task or an assignee
+this Task is designated to for execution.
+
+
+
+
+
+-
+
+**isExecutedElsewhere:** `Optional`
+
+If set, then the service will not trigger execution of this task on an agent. Useful
+for when ingesting tasks from an external system that is triggering execution of tasks
+on agents.
+
+
+
+
+
+-
+
+**initialEntities:** `Optional>`
+
+Indicates an initial set of entities that can be used to execute an entity aware
+task. For example, an entity Objective, an entity Keep In Zone, etc.
+
+
+
+
+
+
+
+
+
+client.tasks.getTask(taskId) -> Task
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Retrieves a specific Task by its ID, with options to select a particular task version or view.
+
+This method returns detailed information about a task including its current status,
+specification, relations, and other metadata. The response includes the complete Task object
+with all associated fields.
+
+By default, the method returns the latest definition version of the task from the manager's
+perspective.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.tasks().getTask(
+ "taskId",
+ GetTaskRequest
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**taskId:** `String` — ID of task to return
+
+
+
+
+
+
+
+
+
+client.tasks.updateTaskStatus(taskId, request) -> Task
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the status of a Task as it progresses through its lifecycle.
+
+This method allows agents or operators to report the current state of a task,
+which could include changes to task status, and error information.
+
+Each status update increments the task's status_version. When updating status,
+clients must provide the current version to ensure consistency. The system rejects
+updates with mismatched versions to prevent race conditions.
+
+Terminal states (`STATUS_DONE_OK` and `STATUS_DONE_NOT_OK`) are permanent; once a task
+reaches these states, no further updates are allowed.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.tasks().updateTaskStatus(
+ "taskId",
+ TaskStatusUpdate
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**taskId:** `String` — ID of task to update status of
+
+
+
+
+
+-
+
+**statusVersion:** `Optional`
+
+The status version of the task to update. This version number increments to indicate the task's
+current stage in its status lifecycle. Specifically, whenever a task's status updates, the status
+version increments by one. Any status updates received with a lower status version number than what
+is known are considered stale and ignored.
+
+
+
+
+
+-
+
+**newStatus:** `Optional` — The new status of the task.
+
+
+
+
+
+-
+
+**author:** `Optional`
+
+
+
+
+
+
+
+
+
+client.tasks.queryTasks(request) -> TaskQueryResults
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Searches for Tasks that match specified filtering criteria and returns matching tasks in paginated form.
+
+This method allows filtering tasks based on multiple criteria including:
+- Parent task relationships
+- Task status (with inclusive or exclusive filtering)
+- Update time ranges
+- Task view (manager or agent perspective)
+- Task assignee
+- Task type (via exact URL matches or prefix matching)
+
+Results are returned in pages. When more results are available than can be returned in a single
+response, a page_token is provided that can be used in subsequent requests to retrieve the next
+set of results.
+
+By default, this returns the latest task version for each matching task from the manager's perspective.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.tasks().queryTasks(
+ TaskQuery
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**pageToken:** `Optional` — If set, returns results starting from the given pageToken.
+
+
+
+
+
+-
+
+**parentTaskId:** `Optional`
+
+If present matches Tasks with this parent Task ID.
+Note: this is mutually exclusive with all other query parameters, for example, either provide parent task ID, or
+any of the remaining parameters, but not both.
+
+
+
+
+
+-
+
+**statusFilter:** `Optional`
+
+
+
+
+
+-
+
+**updateTimeRange:** `Optional` — If provided, only provides Tasks updated within the time range.
+
+
+
+
+
+
+
+
+
+client.tasks.listenAsAgent(request) -> AgentRequest
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Establishes a server streaming connection that delivers tasks to taskable agents for execution.
+
+This method creates a persistent connection from Tasks API to an agent, allowing the server
+to push tasks to the agent as they become available. The agent receives a stream of tasks that
+match its selector criteria (entity IDs).
+
+The stream delivers three types of requests:
+- ExecuteRequest: Contains a new task for the agent to execute
+- CancelRequest: Indicates a task should be canceled
+- CompleteRequest: Indicates a task should be completed
+
+This is the primary method for taskable agents to receive and process tasks in real-time.
+Agents should maintain this connection and process incoming tasks according to their capabilities.
+
+When an agent receives a task, it should update the task status using the UpdateStatus endpoint
+to provide progress information back to Tasks API.
+
+This is a long polling API that will block until a new task is ready for delivery. If no new task is
+available then the server will hold on to your request for up to 5 minutes, after that 5 minute timeout
+period you will be expected to reinitiate a new request.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.tasks().listenAsAgent(
+ AgentListener
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**agentSelector:** `Optional` — Selector criteria to determine which Agent Tasks the agent receives
+
+
+
+
+
+
+
+
+
+client.objects.listObjects() -> SyncPagingIterable<PathMetadata>
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Lists objects in your environment. You can define a prefix to list a subset of your objects. If you do not set a prefix, Lattice returns all available objects. By default this endpoint will list local objects only.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.objects().listObjects(
+ ListObjectsRequest
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**prefix:** `Optional` — Filters the objects based on the specified prefix path. If no path is specified, all objects are returned.
+
+
+
+
+
+-
+
+**sinceTimestamp:** `Optional` — Sets the age for the oldest objects to query across the environment.
+
+
+
+
+
+-
+
+**pageToken:** `Optional` — Base64 and URL-encoded cursor returned by the service to continue paging.
+
+
+
+
+
+-
+
+**allObjectsInMesh:** `Optional` — Lists objects across all environment nodes in a Lattice Mesh.
+
+
+
+
+
+
+
+
+
+client.objects.getObject(objectPath) -> InputStream
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Fetches an object from your environment using the objectPath path parameter.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.objects().getObject(
+ "objectPath",
+ GetObjectRequest
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**objectPath:** `String` — The path of the object to fetch.
+
+
+
+
+
+-
+
+**acceptEncoding:** `Optional` — If set, Lattice will compress the response using the specified compression method. If the header is not defined, or the compression method is set to `identity`, no compression will be applied to the response.
+
+
+
+
+
+-
+
+**priority:** `Optional` — Indicates a client's preference for the priority of the response. The value is a structured header as defined in RFC 9218. If you do not set the header, Lattice uses the default priority set for the environment. Incremental delivery directives are not supported and will be ignored.
+
+
+
+
+
+
+
+
+
+client.objects.uploadObject(objectPath, request) -> PathMetadata
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Uploads an object. The object must be 1 GiB or smaller.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.objects().uploadObject("".getBytes());
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**objectPath:** `String` — Path of the Object that is to be uploaded.
+
+
+
+
+
+
+
+
+
+client.objects.deleteObject(objectPath)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes an object from your environment given the objectPath path parameter.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.objects().deleteObject(
+ "objectPath",
+ DeleteObjectRequest
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**objectPath:** `String` — The path of the object to delete.
+
+
+
+
+
+
+
+
+
+client.objects.getObjectMetadata(objectPath)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns metadata for a specified object path. Use this to fetch metadata such as object size (size_bytes), its expiry time (expiry_time), or its latest update timestamp (last_updated_at).
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```java
+client.objects().getObjectMetadata(
+ "objectPath",
+ GetObjectMetadataRequest
+ .builder()
+ .build()
+);
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**objectPath:** `String` — The path of the object to query.
+
+
+
+
+
+
+
+
+
+