mirror of
https://github.com/datahub-project/datahub.git
synced 2025-12-28 10:28:22 +00:00
bfb903cfb8
* feat(ingest): add async option to ingest proposal endpoint * small tweak to validate before write to K, also keep existing path for timeseries aspects * avoid double convert Co-authored-by: Shirshanka Das <shirshanka@apache.org>
79 lines
2.8 KiB
Java
79 lines
2.8 KiB
Java
package com.linkedin.metadata.event;
|
|
|
|
import com.linkedin.common.urn.Urn;
|
|
import com.linkedin.data.template.RecordTemplate;
|
|
import com.linkedin.metadata.models.AspectSpec;
|
|
import com.linkedin.metadata.snapshot.Snapshot;
|
|
import com.linkedin.mxe.MetadataChangeLog;
|
|
import com.linkedin.mxe.MetadataAuditOperation;
|
|
import com.linkedin.mxe.MetadataChangeProposal;
|
|
import com.linkedin.mxe.PlatformEvent;
|
|
import com.linkedin.mxe.SystemMetadata;
|
|
import io.opentelemetry.extension.annotations.WithSpan;
|
|
import javax.annotation.Nonnull;
|
|
import javax.annotation.Nullable;
|
|
|
|
|
|
/**
|
|
* Interface implemented by producers of {@link com.linkedin.mxe.MetadataAuditEvent}s.
|
|
*/
|
|
public interface EventProducer {
|
|
|
|
/**
|
|
* Deprecated! Replaced by {@link #produceMetadataChangeLog(Urn, AspectSpec, MetadataChangeLog)}
|
|
*
|
|
* Produces a {@link com.linkedin.mxe.MetadataAuditEvent} from a
|
|
* new & previous Entity {@link Snapshot}.
|
|
* @param urn the urn associated with the entity changed
|
|
* @param oldSnapshot a {@link RecordTemplate} corresponding to the old snapshot.
|
|
* @param newSnapshot a {@link RecordTemplate} corresponding to the new snapshot.
|
|
* @param oldSystemMetadata
|
|
* @param newSystemMetadata
|
|
*/
|
|
@Deprecated
|
|
void produceMetadataAuditEvent(
|
|
@Nonnull final Urn urn,
|
|
@Nullable final Snapshot oldSnapshot,
|
|
@Nonnull final Snapshot newSnapshot,
|
|
@Nullable SystemMetadata oldSystemMetadata,
|
|
@Nullable SystemMetadata newSystemMetadata,
|
|
MetadataAuditOperation operation
|
|
);
|
|
|
|
/**
|
|
* Produces a {@link com.linkedin.mxe.MetadataChangeLog} from a
|
|
* new & previous aspect.
|
|
*
|
|
* @param urn the urn associated with the entity changed
|
|
* @param aspectSpec aspect spec of the aspect being updated
|
|
* @param metadataChangeLog metadata change log to push into MCL kafka topic
|
|
*/
|
|
void produceMetadataChangeLog(
|
|
@Nonnull final Urn urn,
|
|
@Nonnull AspectSpec aspectSpec,
|
|
@Nonnull final MetadataChangeLog metadataChangeLog
|
|
);
|
|
|
|
/**
|
|
* Produces a {@link com.linkedin.mxe.MetadataChangeProposal}
|
|
* as an async update to an entity
|
|
*
|
|
* @param metadataChangeProposal metadata change proposal to push into MCP kafka topic
|
|
*/
|
|
@WithSpan
|
|
void produceMetadataChangeProposal(@Nonnull MetadataChangeProposal metadataChangeProposal);
|
|
|
|
/**
|
|
* Produces a generic platform "event".
|
|
*
|
|
* @param name the name, or type, of the event to produce, as defined in the {@link EntityRegistry}.
|
|
* @param key an optional partitioning key for the event. If not provided, the name of the event will be used.
|
|
* @param payload the event payload itself. This will be serialized to JSON and produced as a system event.
|
|
*/
|
|
void producePlatformEvent(
|
|
@Nonnull String name,
|
|
@Nullable String key,
|
|
@Nonnull PlatformEvent payload
|
|
);
|
|
}
|