io.datahubproject.openapi.generated

Class KafkaAuditHeader

java.lang.Object

io.datahubproject.openapi.generated.KafkaAuditHeader

@Validated
 @Generated(value="io.swagger.codegen.v3.generators.java.SpringCodegen",
           date="2022-09-21T05:34:26.783Z[Etc/UTC]")
public class KafkaAuditHeader
extends java.lang.Object

This header records information about the context of an event as it is emitted into kafka and is intended to be used by the kafka audit application. For more information see go/kafkaauditheader

Constructor Summary

Constructors

Constructor and Description
KafkaAuditHeader()

Method Summary

Modifier and Type	Method and Description
KafkaAuditHeader	appName(java.lang.String appName)
KafkaAuditHeader	auditVersion(java.lang.Integer auditVersion)
KafkaAuditHeader	clusterConnectionString(java.lang.String clusterConnectionString)
boolean	equals(java.lang.Object o)
KafkaAuditHeader	fabricUrn(java.lang.String fabricUrn)
@NotNull java.lang.String	getAppName() The name of the application from which the event is being emitted.
@Min(value=-2147483648L) @Max(value=2147483647L) java.lang.Integer	getAuditVersion() The version that is being used for auditing.
java.lang.String	getClusterConnectionString() This is a String that the client uses to establish some kind of connection with the Kafka cluster.
java.lang.String	getFabricUrn() The fabricUrn of the host from which the event is being emitted.
java.lang.String	getInstance() The instance on the server from which the event is being emitted.
@NotNull @Pattern(regexp="^[\u0000-\u00ff]*$") @Size(min=16,max=16) java.lang.String	getMessageId() Get messageId
@NotNull java.lang.String	getServer() The fully qualified name of the host from which the event is being emitted.
@NotNull @Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getTime() The time at which the event was emitted into kafka.
int	hashCode()
KafkaAuditHeader	instance(java.lang.String instance)
KafkaAuditHeader	messageId(java.lang.String messageId)
KafkaAuditHeader	server(java.lang.String server)
void	setAppName(java.lang.String appName)
void	setAuditVersion(java.lang.Integer auditVersion)
void	setClusterConnectionString(java.lang.String clusterConnectionString)
void	setFabricUrn(java.lang.String fabricUrn)
void	setInstance(java.lang.String instance)
void	setMessageId(java.lang.String messageId)
void	setServer(java.lang.String server)
void	setTime(java.lang.Long time)
KafkaAuditHeader	time(java.lang.Long time)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KafkaAuditHeader

public KafkaAuditHeader()

Method Detail

time

public KafkaAuditHeader time(java.lang.Long time)

getTime

@NotNull
 @Min(value=-9223372036854775808L)
 @Max(value=9223372036854775807L)
public @NotNull @Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long getTime()

The time at which the event was emitted into kafka. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

time

setTime

public void setTime(java.lang.Long time)

server

public KafkaAuditHeader server(java.lang.String server)

getServer

@NotNull
public @NotNull java.lang.String getServer()

The fully qualified name of the host from which the event is being emitted.

Returns:

server

setServer

public void setServer(java.lang.String server)

instance

public KafkaAuditHeader instance(java.lang.String instance)

getInstance

public java.lang.String getInstance()

The instance on the server from which the event is being emitted. e.g. i001

Returns:

instance

setInstance

public void setInstance(java.lang.String instance)

appName

public KafkaAuditHeader appName(java.lang.String appName)

getAppName

@NotNull
public @NotNull java.lang.String getAppName()

The name of the application from which the event is being emitted. see go/appname

Returns:

appName

setAppName

public void setAppName(java.lang.String appName)

messageId

public KafkaAuditHeader messageId(java.lang.String messageId)

getMessageId

@NotNull
 @Pattern(regexp="^[\u0000-\u00ff]*$")
 @Size(min=16,
      max=16)
public @NotNull @Pattern(regexp="^[\u0000-\u00ff]*$") @Size(min=16,max=16) java.lang.String getMessageId()

Get messageId

Returns:

messageId

setMessageId

public void setMessageId(java.lang.String messageId)

auditVersion

public KafkaAuditHeader auditVersion(java.lang.Integer auditVersion)

getAuditVersion

@Min(value=-2147483648L)
 @Max(value=2147483647L)
public @Min(value=-2147483648L) @Max(value=2147483647L) java.lang.Integer getAuditVersion()

The version that is being used for auditing. In version 0, the audit trail buckets events into 10 minute audit windows based on the EventHeader timestamp. In version 1, the audit trail buckets events as follows: if the schema has an outer KafkaAuditHeader, use the outer audit header timestamp for bucketing; else if the EventHeader has an inner KafkaAuditHeader use that inner audit header's timestamp for bucketing minimum: -2147483648 maximum: 2147483647

Returns:

auditVersion

setAuditVersion

public void setAuditVersion(java.lang.Integer auditVersion)

fabricUrn

public KafkaAuditHeader fabricUrn(java.lang.String fabricUrn)

getFabricUrn

public java.lang.String getFabricUrn()

The fabricUrn of the host from which the event is being emitted. Fabric Urn in the format of urn:li:fabric:{fabric_name}. See go/fabric.

Returns:

fabricUrn

setFabricUrn

public void setFabricUrn(java.lang.String fabricUrn)

clusterConnectionString

public KafkaAuditHeader clusterConnectionString(java.lang.String clusterConnectionString)

getClusterConnectionString

public java.lang.String getClusterConnectionString()

This is a String that the client uses to establish some kind of connection with the Kafka cluster. The exact format of it depends on specific versions of clients and brokers. This information could potentially identify the fabric and cluster with which the client is producing to or consuming from.

Returns:

clusterConnectionString

setClusterConnectionString

public void setClusterConnectionString(java.lang.String clusterConnectionString)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object