Package datahub.client.rest

Class RestEmitter

java.lang.Object

datahub.client.rest.RestEmitter

All Implemented Interfaces:

Emitter, Closeable, AutoCloseable

@ThreadSafe
public class RestEmitter
extends Object
implements Emitter

Constructor Summary

Constructors

Constructor	Description
RestEmitter(RestEmitterConfig config)	The default constructor, prefer using the `create` factory method.

Method Summary

Modifier and Type	Method	Description
void	close()
static RestEmitter	create(Consumer<RestEmitterConfig.RestEmitterConfigBuilder> builderSupplier)	Constructing a REST Emitter follows a lambda-based fluent builder pattern using the `create` method.
static RestEmitter	createWithDefaults()	Creates a RestEmitter with default settings.
Future<MetadataWriteResponse>	emit(com.linkedin.mxe.MetadataChangeProposal mcp, Callback callback)	Asynchronously emit a MetadataChangeProposal event.
Future<MetadataWriteResponse>	emit(datahub.event.MetadataChangeProposalWrapper mcpw, Callback callback)	Asynchronously emit a MetadataChangeProposalWrapper event.
Future<MetadataWriteResponse>	emit(List<datahub.event.UpsertAspectRequest> request, Callback callback)	Asynchronously emit a UpsertAspectRequest.
boolean	testConnection()	Test that the emitter can establish a valid connection to the DataHub platform

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface datahub.client.Emitter

emit, emit

Constructor Details

RestEmitter

public RestEmitter(RestEmitterConfig config)

The default constructor, prefer using the `create` factory method.

Parameters:

config -

Method Details

create

public static RestEmitter create(Consumer<RestEmitterConfig.RestEmitterConfigBuilder> builderSupplier)

Constructing a REST Emitter follows a lambda-based fluent builder pattern using the `create` method. e.g. RestEmitter emitter = RestEmitter.create(b :: b .server("http://localhost:8080") // coordinates of gms server .extraHeaders(Collections.singletonMap("Custom-Header", "custom-val") ); You can also customize the underlying http client by calling the `customizeHttpAsyncClient` method on the builder. e.g. RestEmitter emitter = RestEmitter.create(b :: b .server("http://localhost:8080") .extraHeaders(Collections.singletonMap("Custom-Header", "custom-val") .customizeHttpAsyncClient(c :: c.setConnectionTimeToLive(30, TimeUnit.SECONDS)) );

Parameters:

builderSupplier -

Returns:

a constructed RestEmitter. Call #testConnection to make sure this emitter has a valid connection to the server

createWithDefaults

public static RestEmitter createWithDefaults()

Creates a RestEmitter with default settings.

Returns:

a constructed RestEmitter. Call #test_connection to validate that this emitter can communicate with the server.

emit

public Future<MetadataWriteResponse> emit(datahub.event.MetadataChangeProposalWrapper mcpw,
 Callback callback)
                                   throws IOException

Description copied from interface: Emitter

Asynchronously emit a MetadataChangeProposalWrapper event.

Specified by:

emit in interface Emitter

callback - if not null, is called from the IO thread. Should be a quick operation.

Returns:

a Future for callers to inspect the result of the operation or block until one is available

Throws:

IOException

emit

public Future<MetadataWriteResponse> emit(com.linkedin.mxe.MetadataChangeProposal mcp,
 Callback callback)
                                   throws IOException

Description copied from interface: Emitter

Asynchronously emit a MetadataChangeProposal event. Prefer using the sibling method that accepts a MetadataChangeProposalWrapper event as those are friendlier to construct.

Specified by:

emit in interface Emitter

callback - if not null, is called from the IO thread. Should be a quick operation.

Returns:

a Future for callers to inspect the result of the operation or block until one is available

Throws:

IOException

testConnection

public boolean testConnection()
                       throws IOException,
ExecutionException,
InterruptedException

Description copied from interface: Emitter

Test that the emitter can establish a valid connection to the DataHub platform

Specified by:

testConnection in interface Emitter

Returns:

true if a valid connection can be established, false or throws one of the exceptions otherwise

Throws:

IOException

ExecutionException

InterruptedException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

emit

public Future<MetadataWriteResponse> emit(List<datahub.event.UpsertAspectRequest> request,
 Callback callback)
                                   throws IOException

Description copied from interface: Emitter

Asynchronously emit a UpsertAspectRequest.

Specified by:

emit in interface Emitter

Parameters:

request - request with with metadata aspect to upsert into DataHub

Returns:

a Future for callers to inspect the result of the operation or block until one is available

Throws:

IOException