Skip to main content

swagger-java-client

Estuary API

  • API version: 0.0.0
    • Build date: 2022-10-25T22:52:57.283Z

This is the API for the Estuary application.

For more information, please visit https://docs.estuary.tech/feedback

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

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>io.swagger</groupId>
<artifactId>swagger-java-client</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/swagger-java-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

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


import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");

AdminApi apiInstance = new AdminApi();
List<String> body = Arrays.asList(new List<String>()); // List<String> | Peer ids
try {
apiInstance.adminPeeringPeersDelete(body);
} catch (ApiException e) {
System.err.println("Exception when calling AdminApi#adminPeeringPeersDelete");
e.printStackTrace();
}
}
}

Documentation for API Endpoints

All URIs are relative to https://api.estuary.tech

ClassMethodHTTP requestDescription
AdminApiadminPeeringPeersDeleteDELETE /admin/peering/peersRemove peers on Peering Service
AdminApiadminPeeringPeersGetGET /admin/peering/peersList all Peering peers
AdminApiadminPeeringPeersPostPOST /admin/peering/peersAdd peers on Peering Service
AdminApiadminPeeringStartPostPOST /admin/peering/startStart Peering
AdminApiadminPeeringStatusGetGET /admin/peering/statusCheck Peering Status
AdminApiadminPeeringStopPostPOST /admin/peering/stopStop Peering
AdminApiadminSystemConfigGetGET /admin/system/configGet systems(estuary/shuttle) config
AdminApiadminUsersGetGET /admin/usersGet all users
AutoretrieveApiadminAutoretrieveInitPostPOST /admin/autoretrieve/initRegister autoretrieve server
AutoretrieveApiadminAutoretrieveListGetGET /admin/autoretrieve/listList autoretrieve servers
AutoretrieveApiautoretrieveHeartbeatPostPOST /autoretrieve/heartbeatMarks autoretrieve server as up
CollectionsApicollectionsColuuidCommitPostPOST /collections/{coluuid}/commitProduce a CID of the collection contents
CollectionsApicollectionsColuuidContentsDeleteDELETE /collections/{coluuid}/contentsDeletes a content from a collection
CollectionsApicollectionsColuuidDeleteDELETE /collections/{coluuid}Deletes a collection
CollectionsApicollectionsColuuidGetGET /collections/{coluuid}Get contents in a collection
CollectionsApicollectionsColuuidPostPOST /collections/{coluuid}Add contents to a collection
CollectionsApicollectionsFsAddPostPOST /collections/fs/addAdd a file to a collection
CollectionsApicollectionsGetGET /collections/List all collections
CollectionsApicollectionsPostPOST /collections/Create a new collection
ContentApicontentAddCarPostPOST /content/add-carAdd Car object
ContentApicontentAddIpfsPostPOST /content/add-ipfsAdd IPFS object
ContentApicontentAddPostPOST /content/addAdd new content
ContentApicontentAggregatedContentGetGET /content/aggregated/{content}Get aggregated content stats
ContentApicontentAllDealsGetGET /content/all-dealsGet all deals for a user
ContentApicontentBwUsageContentGetGET /content/bw-usage/{content}Get content bandwidth
ContentApicontentCreatePostPOST /content/createAdd a new content
ContentApicontentDealsGetGET /content/dealsContent with deals
ContentApicontentEnsureReplicationDatacidGetGET /content/ensure-replication/{datacid}Ensure Replication
ContentApicontentFailuresContentGetGET /content/failures/{content}List all failures for a content
ContentApicontentIdGetGET /content/{id}Content
ContentApicontentImportdealPostPOST /content/importdealImport a deal
ContentApicontentListGetGET /content/listList all pinned content
ContentApicontentReadContGetGET /content/read/{cont}Read content
ContentApicontentStagingZonesGetGET /content/staging-zonesGet staging zone for user
ContentApicontentStatsGetGET /content/statsGet content statistics
ContentApicontentStatusIdGetGET /content/status/{id}Content Status
DealsApidealEstimatePostPOST /deal/estimateEstimate the cost of a deal
DealsApidealInfoDealidGetGET /deal/info/{dealid}Get Deal Info
DealsApidealProposalPropcidGetGET /deal/proposal/{propcid}Get Proposal
DealsApidealQueryMinerGetGET /deal/query/{miner}Query Ask
DealsApidealStatusByProposalPropcidGetGET /deal/status-by-proposal/{propcid}Get Deal Status by PropCid
DealsApidealStatusMinerPropcidGetGET /deal/status/{miner}/{propcid}Deal Status
DealsApidealTransferInProgressGetGET /deal/transfer/in-progressTransfer In Progress
DealsApidealsFailuresGetGET /deals/failuresGet storage failures for user
DealsApidealsMakeMinerPostPOST /deals/make/{miner}Make Deal
DealsApidealsStatusDealGetGET /deals/status/{deal}Get Deal Status
DealsApipublicDealsFailuresGetGET /public/deals/failuresGet storage failures
DealsApipublicMinersStorageQueryMinerGetGET /public/miners/storage/query/{miner}Query Ask
DefaultApidealTransferStatusPostPOST /deal/transfer/status
MetricsApipublicMetricsDealsOnChainGetGET /public/metrics/deals-on-chainGet deal metrics
MinerApipublicMinersDealsMinerGetGET /public/miners/deals/{miner}Get all miners deals
MinerApipublicMinersStatsMinerGetGET /public/miners/stats/{miner}Get miner stats
NetApinetAddrsGetGET /net/addrsNet Addrs
NetApipublicMinersFailuresMinerGetGET /public/miners/failures/{miner}Get all miners
NetApipublicMinersGetGET /public/minersGet all miners
NetApipublicNetAddrsGetGET /public/net/addrsNet Addrs
NetApipublicNetPeersGetGET /public/net/peersNet Peers
PeeringApiadminPeeringPeersDeleteDELETE /admin/peering/peersRemove peers on Peering Service
PeeringApiadminPeeringPeersGetGET /admin/peering/peersList all Peering peers
PeeringApiadminPeeringPeersPostPOST /admin/peering/peersAdd peers on Peering Service
PeeringApiadminPeeringStartPostPOST /admin/peering/startStart Peering
PeeringApiadminPeeringStatusGetGET /admin/peering/statusCheck Peering Status
PeeringApiadminPeeringStopPostPOST /admin/peering/stopStop Peering
PeersApiadminPeeringPeersDeleteDELETE /admin/peering/peersRemove peers on Peering Service
PeersApiadminPeeringPeersGetGET /admin/peering/peersList all Peering peers
PeersApiadminPeeringPeersPostPOST /admin/peering/peersAdd peers on Peering Service
PeersApiadminPeeringStartPostPOST /admin/peering/startStart Peering
PeersApiadminPeeringStatusGetGET /admin/peering/statusCheck Peering Status
PeersApiadminPeeringStopPostPOST /admin/peering/stopStop Peering
PinningApipinningPinsGetGET /pinning/pinsList all pin status objects
PinningApipinningPinsPinidDeleteDELETE /pinning/pins/{pinid}Delete a pinned object
PinningApipinningPinsPinidGetGET /pinning/pins/{pinid}Get a pin status object
PinningApipinningPinsPinidPostPOST /pinning/pins/{pinid}Replace a pinned object
PinningApipinningPinsPostPOST /pinning/pinsAdd and pin object
PublicApipublicByCidCidGetGET /public/by-cid/{cid}Get Content by Cid
PublicApipublicInfoGetGET /public/infoGet public node info
PublicApipublicMetricsDealsOnChainGetGET /public/metrics/deals-on-chainGet deal metrics
PublicApipublicMinersDealsMinerGetGET /public/miners/deals/{miner}Get all miners deals
PublicApipublicMinersFailuresMinerGetGET /public/miners/failures/{miner}Get all miners
PublicApipublicMinersGetGET /public/minersGet all miners
PublicApipublicMinersStatsMinerGetGET /public/miners/stats/{miner}Get miner stats
PublicApipublicNetAddrsGetGET /public/net/addrsNet Addrs
PublicApipublicNetPeersGetGET /public/net/peersNet Peers
PublicApipublicStatsGetGET /public/statsPublic stats
UserApiuserApiKeysGetGET /user/api-keysGet API keys for a user
UserApiuserApiKeysKeyDeleteDELETE /user/api-keys/{key}Revoke a User API Key.
UserApiuserApiKeysPostPOST /user/api-keysCreate API keys for a user
UserApiuserExportGetGET /user/exportExport user data
UserApiuserStatsGetGET /user/statsCreate API keys for a user

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Recommendation

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

Author