io.smallrye.reactive.messaging.ce.OutgoingCloudEventMetadata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smallrye-reactive-messaging-api Show documentation

The newest version!

package io.smallrye.reactive.messaging.ce;

/**
 * Represents the Cloud Event metadata for an outgoing message.
 * The connector dispatching the message, if this connector supports Cloud Event, should write the outgoing message
 * as a Cloud Event using the attribute set in this metadata.
 *
 * See https://github.com/cloudevents/spec/blob/v1.0/spec.md.
 *
 * @param  the data type
 */
public interface OutgoingCloudEventMetadata extends CloudEventMetadata {

    /**
     * Gets a builder to create a new {@code OutgoingCloudEventMetadata}.
     *
     * @param  the type of data
     * @return the builder
     */
    static  OutgoingCloudEventMetadataBuilder builder() {
        return new OutgoingCloudEventMetadataBuilder<>();
    }

    /**
     * Gets a builder to create a new {@code OutgoingCloudEventMetadata}.
     * The values are copied from the given existing {@code OutgoingCloudEventMetadata}
     *
     * @param  the type of data
     * @return the builder
     */
    static  OutgoingCloudEventMetadataBuilder from(OutgoingCloudEventMetadata existing) {
        return new OutgoingCloudEventMetadataBuilder<>(existing);
    }

}