lamin-api-client-java

FastAPI

• API version: 0.1.0
  • Build date: 2025-04-02T14:30:56.360640930+02:00[Europe/Brussels]
  • Generator version: 7.12.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy -P deployment

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.data-intuitive</groupId>
  <artifactId>lamin-api-client-java</artifactId>
  <version>0.0.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'lamin-api-client-java' jar has been published to maven central.
    mavenLocal()       // Needed if the 'lamin-api-client-java' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.data-intuitive:lamin-api-client-java:0.0.1"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/lamin-api-client-java-0.0.1.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.data_intuitive.lamin_api_client_java.ApiClient;
import com.data_intuitive.lamin_api_client_java.ApiException;
import com.data_intuitive.lamin_api_client_java.Configuration;
import com.data_intuitive.lamin_api_client_java.model.*;
import com.data_intuitive.lamin_api_client_java.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://aws.us-east-1.lamin.ai/api");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    UUID instanceId = UUID.randomUUID(); // UUID | 
    AddCollaboratorRequestBody addCollaboratorRequestBody = new AddCollaboratorRequestBody(); // AddCollaboratorRequestBody | 
    String authorization = "authorization_example"; // String | 
    try {
      Object result = apiInstance.addCollaboratorAccessV2InstancesInstanceIdCollaboratorsPut(instanceId, addCollaboratorRequestBody, authorization);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#addCollaboratorAccessV2InstancesInstanceIdCollaboratorsPut");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://aws.us-east-1.lamin.ai/api

Class	Method	HTTP request	Description
DefaultApi	addCollaboratorAccessV2InstancesInstanceIdCollaboratorsPut	PUT /access_v2/instances/{instance_id}/collaborators	Add Collaborator
DefaultApi	addCollaboratorInstancesInstanceIdCollaboratorsAccountIdPut	PUT /instances/{instance_id}/collaborators/{account_id}	Add Collaborator
DefaultApi	addSpaceCollaboratorAccessV2SpacesSpaceIdCollaboratorsPut	PUT /access_v2/spaces/{space_id}/collaborators	Add Space Collaborator
DefaultApi	addTeamMemberAccessV2TeamsTeamIdMembersAccountIdPut	PUT /access_v2/teams/{team_id}/members/{account_id}	Add Team Member
DefaultApi	attachLabelInstancesInstanceIdModulesModuleNameModelNameIdLabelFieldLabelIdPut	PUT /instances/{instance_id}/modules/{module_name}/{model_name}/{id}/{label_field}/{label_id}	Attach Label
DefaultApi	attachSpaceToInstanceAccessV2SpacesSpaceIdInstancesInstanceIdPut	PUT /access_v2/spaces/{space_id}/instances/{instance_id}	Attach Space To Instance
DefaultApi	createInstanceInstancesPut	PUT /instances	Create Instance
DefaultApi	createRecordInstancesInstanceIdModulesModuleNameModelNamePut	PUT /instances/{instance_id}/modules/{module_name}/{model_name}	Create Record
DefaultApi	createSpaceAccessV2SpacesPut	PUT /access_v2/spaces	Create Space
DefaultApi	createTeamAccessV2TeamsPut	PUT /access_v2/teams	Create Team
DefaultApi	deleteCollaboratorInstancesInstanceIdCollaboratorsAccountIdDelete	DELETE /instances/{instance_id}/collaborators/{account_id}	Delete Collaborator
DefaultApi	deleteInstanceInstancesInstanceIdDelete	DELETE /instances/{instance_id}	Delete Instance
DefaultApi	deleteRecordInstancesInstanceIdModulesModuleNameModelNameUidDelete	DELETE /instances/{instance_id}/modules/{module_name}/{model_name}/{uid}	Delete Record
DefaultApi	deleteSpaceAccessV2SpacesSpaceIdDelete	DELETE /access_v2/spaces/{space_id}	Delete Space
DefaultApi	deleteTeamAccessV2TeamsTeamIdDelete	DELETE /access_v2/teams/{team_id}	Delete Team
DefaultApi	detachLabelInstancesInstanceIdModulesModuleNameModelNameIdLabelFieldLabelIdDelete	DELETE /instances/{instance_id}/modules/{module_name}/{model_name}/{id}/{label_field}/{label_id}	Detach Label
DefaultApi	detachSpaceFromInstanceAccessV2SpacesSpaceIdInstancesInstanceIdDelete	DELETE /access_v2/spaces/{space_id}/instances/{instance_id}	Detach Space From Instance
DefaultApi	getDbTokenAccessV2InstancesInstanceIdDbTokenGet	GET /access_v2/instances/{instance_id}/db_token	Get Db Token
DefaultApi	getInstanceStatisticsInstancesInstanceIdStatisticsGet	GET /instances/{instance_id}/statistics	Get Instance Statistics
DefaultApi	getNonEmptyTablesInstancesInstanceIdNonEmptyTablesGet	GET /instances/{instance_id}/non_empty_tables	Get Non Empty Tables
DefaultApi	getRecordInstancesInstanceIdModulesModuleNameModelNameIdOrUidPost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/{id_or_uid}	Get Record
DefaultApi	getRecordsInstancesInstanceIdModulesModuleNameModelNamePost	POST /instances/{instance_id}/modules/{module_name}/{model_name}	Get Records
DefaultApi	getRelationCountsInstancesInstanceIdModulesModuleNameModelNameIdCountsGet	GET /instances/{instance_id}/modules/{module_name}/{model_name}/{id}/counts	Get Relation Counts
DefaultApi	getRelationsInstancesInstanceIdSchemaModuleNameModelNameGet	GET /instances/{instance_id}/schema/{module_name}/{model_name}	Get Relations
DefaultApi	getSchemaInstancesInstanceIdSchemaGet	GET /instances/{instance_id}/schema	Get Schema
DefaultApi	getSpaceAccessV2SpacesSpaceIdGet	GET /access_v2/spaces/{space_id}	Get Space
DefaultApi	getTeamAccessV2TeamsTeamIdGet	GET /access_v2/teams/{team_id}	Get Team
DefaultApi	getValuesInstancesInstanceIdModulesModuleNameModelNameFieldsFieldPathPost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/fields/{field_path}	Get Values
DefaultApi	grantS3PermissionsStoragesS3BucketNamePermissionsPut	PUT /storages/s3/{bucket_name}/permissions	Grant S3 Permissions
DefaultApi	groupByInstancesInstanceIdModulesModuleNameModelNameGroupByPost	POST /instances/{instance_id}/modules/{module_name}/{model_name}/group-by	Group By
DefaultApi	listCollaboratorsAccessV2InstancesInstanceIdCollaboratorsGet	GET /access_v2/instances/{instance_id}/collaborators	List Collaborators
DefaultApi	listInstanceSpacesAccessV2SpacesInstancesInstanceIdGet	GET /access_v2/spaces/instances/{instance_id}	List Instance Spaces
DefaultApi	listInstancesUsingSpaceAccessV2SpacesSpaceIdInstancesGet	GET /access_v2/spaces/{space_id}/instances	List Instances Using Space
DefaultApi	listOrganizationSpacesAccessV2SpacesOrganizationsOrganizationIdGet	GET /access_v2/spaces/organizations/{organization_id}	List Organization Spaces
DefaultApi	listOrganizationTeamsAccessV2TeamsOrganizationsOrganizationIdGet	GET /access_v2/teams/organizations/{organization_id}	List Organization Teams
DefaultApi	listSpaceCollaboratorsAccessV2SpacesSpaceIdCollaboratorsGet	GET /access_v2/spaces/{space_id}/collaborators	List Space Collaborators
DefaultApi	listTeamMembersAccessV2TeamsTeamIdMembersGet	GET /access_v2/teams/{team_id}/members	List Team Members
DefaultApi	moveRecordToSpaceAccessV2SpacesSpaceIdRecordAttachmentsPut	PUT /access_v2/spaces/{space_id}/record-attachments	Move Record To Space
DefaultApi	proxyS3S3PathGet	GET /s3/{path}	Proxy S3
DefaultApi	proxyS3S3PathGet_0	HEAD /s3/{path}	Proxy S3
DefaultApi	proxyS3S3PathGet_1	PUT /s3/{path}	Proxy S3
DefaultApi	proxyS3S3PathGet_2	POST /s3/{path}	Proxy S3
DefaultApi	proxyS3S3PathGet_3	DELETE /s3/{path}	Proxy S3
DefaultApi	removeCollaboratorAccessV2InstancesInstanceIdCollaboratorsDelete	DELETE /access_v2/instances/{instance_id}/collaborators	Remove Collaborator
DefaultApi	removeSpaceCollaboratorAccessV2SpacesSpaceIdCollaboratorsDelete	DELETE /access_v2/spaces/{space_id}/collaborators	Remove Space Collaborator
DefaultApi	removeTeamMemberAccessV2TeamsTeamIdMembersAccountIdDelete	DELETE /access_v2/teams/{team_id}/members/{account_id}	Remove Team Member
DefaultApi	transferOwnershipInstancesInstanceIdOwnerHandlePatch	PATCH /instances/{instance_id}/owner/{handle}	Transfer Ownership
DefaultApi	updateCollaboratorAccessV2InstancesInstanceIdCollaboratorsPatch	PATCH /access_v2/instances/{instance_id}/collaborators	Update Collaborator
DefaultApi	updateCollaboratorInstancesInstanceIdCollaboratorsAccountIdPatch	PATCH /instances/{instance_id}/collaborators/{account_id}	Update Collaborator
DefaultApi	updateRecordInstancesInstanceIdModulesModuleNameModelNameUidPatch	PATCH /instances/{instance_id}/modules/{module_name}/{model_name}/{uid}	Update Record
DefaultApi	updateSpaceAccessV2SpacesSpaceIdPatch	PATCH /access_v2/spaces/{space_id}	Update Space
DefaultApi	updateSpaceCollaboratorAccessV2SpacesSpaceIdCollaboratorsPatch	PATCH /access_v2/spaces/{space_id}/collaborators	Update Space Collaborator
DefaultApi	updateTeamAccessV2TeamsTeamIdPatch	PATCH /access_v2/teams/{team_id}	Update Team
DefaultApi	updateTeamMemberAccessV2TeamsTeamIdMembersAccountIdPatch	PATCH /access_v2/teams/{team_id}/members/{account_id}	Update Team Member

Documentation for Models

• AddCollaboratorRequestBody
• AddSpaceCollaboratorRequestBody
• AddTeamMemberRequestBody
• AttachSpaceToRecordRequestBody
• CreateSpaceRequestBody
• CreateTeamRequestBody
• Dimension
• GetRecordRequestBody
• GetRecordsRequestBody
• GetValuesRequestBody
• GroupByRequestBody
• HTTPValidationError
• Measure
• OrderByColumn
• S3PermissionsRequest
• UpdateCollaboratorRequestBody
• UpdateSpaceCollaboratorRequestBody
• UpdateSpaceRequestBody
• UpdateTeamMemberRequestBody
• UpdateTeamRequestBody
• ValidationError
• ValidationErrorLocInner

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author