com.influxdb.client

Interface SourcesApi

@ThreadSafe
public interface SourcesApi

The client of the InfluxDB 2.0 that implement Source HTTP API endpoint.

Author:

Jakub Bednar (bednar@github) (18/09/2018 09:01)

Method Summary

Modifier and Type	Method and Description
Source	cloneSource(String clonedName, Source source) Clone a source.
Source	cloneSource(String clonedName, String sourceID) Clone a source.
Source	createSource(Source source) Creates a Source, sets the sources ID and stores it.
void	deleteSource(Source source) Delete a source.
void	deleteSource(String sourceID) Delete a source.
List<Bucket>	findBucketsBySource(Source source) Get a sources buckets (will return dbrps in the form of buckets if it is a v1 source).
List<Bucket>	findBucketsBySourceID(String sourceID) Get a sources buckets (will return dbrps in the form of buckets if it is a v1 source).
Source	findSourceByID(String sourceID) Retrieve a source.
List<Source>	findSources() Get all sources.
HealthCheck	health(Source source) Get a sources health.
HealthCheck	health(String sourceID) Get a sources health.
Source	updateSource(Source source) Update the source.

Method Detail

createSource

@Nonnull
Source createSource(@Nonnull
                             Source source)

Creates a Source, sets the sources ID and stores it.

Parameters:

source - to create

Returns:

created source

updateSource

@Nonnull
Source updateSource(@Nonnull
                             Source source)

Update the source.

Parameters:

source - to update

Returns:

updated source

deleteSource

void deleteSource(@Nonnull
                  Source source)

Delete a source.

Parameters:

source - source to delete

deleteSource

void deleteSource(@Nonnull
                  String sourceID)

Delete a source.

Parameters:

sourceID - ID of source to delete

cloneSource

@Nonnull
Source cloneSource(@Nonnull
                            String clonedName,
                            @Nonnull
                            String sourceID)

Clone a source.

Parameters:

clonedName - name of cloned source

sourceID - ID of source to clone

Returns:

cloned source

cloneSource

@Nonnull
Source cloneSource(@Nonnull
                            String clonedName,
                            @Nonnull
                            Source source)

Clone a source.

Parameters:

clonedName - name of cloned source

source - source to clone

Returns:

cloned source

findSourceByID

@Nonnull
Source findSourceByID(@Nonnull
                               String sourceID)

Retrieve a source.

Parameters:

sourceID - ID of source to get

Returns:

source details

findSources

@Nonnull
List<Source> findSources()

Get all sources.

Returns:

A list of sources

findBucketsBySource

@Nullable
List<Bucket> findBucketsBySource(@Nonnull
                                           Source source)

Get a sources buckets (will return dbrps in the form of buckets if it is a v1 source).

Parameters:

source - filter buckets to a specific source

Returns:

buckets for source. If source does not exist than return null.

findBucketsBySourceID

@Nonnull
List<Bucket> findBucketsBySourceID(@Nonnull
                                            String sourceID)

Get a sources buckets (will return dbrps in the form of buckets if it is a v1 source).

Parameters:

sourceID - filter buckets to a specific source ID

Returns:

buckets for source. If source does not exist than return null.

health

@Nonnull
HealthCheck health(@Nonnull
                            Source source)

Get a sources health.

Parameters:

source - to check health

Returns:

health of source

health

@Nonnull
HealthCheck health(@Nonnull
                            String sourceID)

Get a sources health.

Parameters:

sourceID - to check health

Returns:

health of source