cosmotech-api-java-client

Cosmo Tech Platform API

• API version: 3.0.3-SNAPSHOT
  • Build date: 2024-02-02T14:49:51.764844674Z[Etc/UTC]

Cosmo Tech Platform API

For more information, please visit https://github.com/Cosmo-Tech/cosmotech-api

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
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

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.cosmotech</groupId>
  <artifactId>cosmotech-api-java-client</artifactId>
  <version>3.0.3-SNAPSHOT</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

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

  dependencies {
     implementation "com.cosmotech:cosmotech-api-java-client:3.0.3-SNAPSHOT"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/cosmotech-api-java-client-3.0.3-SNAPSHOT.jar
• target/lib/*.jar

Getting Started

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

// Import classes:
import com.cosmotech.client.ApiClient;
import com.cosmotech.client.ApiException;
import com.cosmotech.client.Configuration;
import com.cosmotech.client.auth.*;
import com.cosmotech.client.models.*;
import com.cosmotech.client.api.ConnectorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://dev.api.cosmotech.com");
    
    // Configure OAuth2 access token for authorization: oAuth2AuthCode
    OAuth oAuth2AuthCode = (OAuth) defaultClient.getAuthentication("oAuth2AuthCode");
    oAuth2AuthCode.setAccessToken("YOUR ACCESS TOKEN");

    ConnectorApi apiInstance = new ConnectorApi(defaultClient);
    Integer page = 56; // Integer | page number to query
    Integer size = 56; // Integer | amount of result by page
    try {
      List<Connector> result = apiInstance.findAllConnectors(page, size);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConnectorApi#findAllConnectors");
      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://dev.api.cosmotech.com

Documentation for Models

• ComponentRolePermissions
• Connector
• ConnectorParameter
• ConnectorParameterGroup
• ContainerResourceSizeInfo
• ContainerResourceSizing
• Dataset
• DatasetAccessControl
• DatasetCompatibility
• DatasetConnector
• DatasetCopyParameters
• DatasetRole
• DatasetSearch
• DatasetSecurity
• DatasetSourceType
• DatasetTwinGraphHash
• DatasetTwinGraphInfo
• DatasetTwinGraphQuery
• DeleteHistoricalData
• FileUploadMetadata
• FileUploadValidation
• GraphProperties
• Organization
• OrganizationAccessControl
• OrganizationRole
• OrganizationSecurity
• OrganizationService
• OrganizationServices
• ResourceSizeInfo
• RunTemplate
• RunTemplateHandlerId
• RunTemplateOrchestrator
• RunTemplateParameter
• RunTemplateParameterGroup
• RunTemplateParameterValue
• RunTemplateResourceSizing
• RunTemplateStepSource
• Scenario
• ScenarioAccessControl
• ScenarioChangedParameterValue
• ScenarioComparisonResult
• ScenarioDataDownloadInfo
• ScenarioDataDownloadJob
• ScenarioJobState
• ScenarioLastRun
• ScenarioResourceSizing
• ScenarioRole
• ScenarioRun
• ScenarioRunContainer
• ScenarioRunContainerArtifact
• ScenarioRunContainerLogs
• ScenarioRunLogs
• ScenarioRunResourceRequested
• ScenarioRunResult
• ScenarioRunSearch
• ScenarioRunStartContainers
• ScenarioRunState
• ScenarioRunStatus
• ScenarioRunStatusNode
• ScenarioRunTemplateParameterValue
• ScenarioSecurity
• ScenarioValidationStatus
• Solution
• SolutionAccessControl
• SolutionRole
• SolutionSecurity
• SourceInfo
• SubDatasetGraphQuery
• TwinGraphBatchResult
• TwinGraphHash
• TwinGraphQuery
• Validator
• ValidatorRun
• Workspace
• WorkspaceAccessControl
• WorkspaceFile
• WorkspaceRole
• WorkspaceSecret
• WorkspaceSecurity
• WorkspaceSolution
• WorkspaceWebApp

Documentation for Authorization

Authentication schemes defined for the API:

oAuth2AuthCode

• Type: OAuth
• Flow: implicit
• Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
• Scopes:
  • http://dev.api.cosmotech.com/platform: Platform scope

Recommendation

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

Author

[email protected]