io.datahubproject.openapi.generated

Class DatahubIngestionRunSummary

java.lang.Object

io.datahubproject.openapi.generated.DatahubIngestionRunSummary

All Implemented Interfaces:

OneOfEnvelopedAspectValue, OneOfGenericAspectValue

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

Summary of a datahub ingestion run for a given platform.

Constructor Summary

Constructors

Constructor and Description
DatahubIngestionRunSummary()

Method Summary

Modifier and Type	Method and Description
DatahubIngestionRunSummary	availableMemory(java.lang.Long availableMemory)
DatahubIngestionRunSummary	config(java.lang.String config)
DatahubIngestionRunSummary	customSummary(java.lang.String customSummary)
boolean	equals(java.lang.Object o)
DatahubIngestionRunSummary	eventGranularity(TimeWindowSize eventGranularity)
@NotNull java.lang.String	get__type() Name of this subclass in SimpleClassName format
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getAvailableMemory() The available memory on the host the ingestion pipeline ran on.
java.lang.String	getConfig() The non-sensitive key-value pairs of the yaml config used as json string.
java.lang.String	getCustomSummary() Custom value.
@Valid TimeWindowSize	getEventGranularity() Get eventGranularity
java.lang.String	getMessageId() The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumAspects() The total number of aspects produced across all entities.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumEntities() The total number of entities produced (unique entity urns).
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumEntitiesSkipped() Number of entities skipped.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumErrors() Number of errors generated.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumEvents() The number of events produced (MCE + MCP).
@Min(value=-2147483648L) @Max(value=2147483647L) java.lang.Integer	getNumProcessors() The number of processors on the host the ingestion pipeline ran on.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumSinkAPICalls() Total number of sink API calls.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumSourceAPICalls() Total number of source API calls.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumWarnings() Number of warnings generated.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumWorkUnitsCommitted() The number of workunits written to sink.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getNumWorkUnitsCreated() The number of workunits that are produced.
java.lang.String	getOperatingSystemName() The os the ingestion pipeline ran on.
@NotNull @Valid PartitionSpec	getPartitionSpec() Get partitionSpec
@NotNull java.lang.String	getPipelineName() The name of the pipeline that ran ingestion, a stable unique user provided identifier.
@NotNull java.lang.String	getPlatformInstanceId() The id of the instance against which the ingestion pipeline ran.
@NotNull java.lang.String	getRunId() The runId for this pipeline instance.
@NotNull @Valid JobStatus	getRunStatus() Get runStatus
java.lang.String	getSoftwareVersion() The software version of this ingestion.
java.lang.String	getSystemHostName() The hostname the ingestion pipeline ran on.
@NotNull @Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getTimestampMillis() The event timestamp field as epoch at UTC in milli seconds.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getTotalLatencySinkAPICalls() Total latency across all sink API calls.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getTotalLatencySourceAPICalls() Total latency across all source API calls.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getTotalMemory() The total amount of memory on the host the ingestion pipeline ran on.
int	hashCode()
DatahubIngestionRunSummary	messageId(java.lang.String messageId)
DatahubIngestionRunSummary	numAspects(java.lang.Long numAspects)
DatahubIngestionRunSummary	numEntities(java.lang.Long numEntities)
DatahubIngestionRunSummary	numEntitiesSkipped(java.lang.Long numEntitiesSkipped)
DatahubIngestionRunSummary	numErrors(java.lang.Long numErrors)
DatahubIngestionRunSummary	numEvents(java.lang.Long numEvents)
DatahubIngestionRunSummary	numProcessors(java.lang.Integer numProcessors)
DatahubIngestionRunSummary	numSinkAPICalls(java.lang.Long numSinkAPICalls)
DatahubIngestionRunSummary	numSourceAPICalls(java.lang.Long numSourceAPICalls)
DatahubIngestionRunSummary	numWarnings(java.lang.Long numWarnings)
DatahubIngestionRunSummary	numWorkUnitsCommitted(java.lang.Long numWorkUnitsCommitted)
DatahubIngestionRunSummary	numWorkUnitsCreated(java.lang.Long numWorkUnitsCreated)
DatahubIngestionRunSummary	operatingSystemName(java.lang.String operatingSystemName)
DatahubIngestionRunSummary	partitionSpec(PartitionSpec partitionSpec)
DatahubIngestionRunSummary	pipelineName(java.lang.String pipelineName)
DatahubIngestionRunSummary	platformInstanceId(java.lang.String platformInstanceId)
DatahubIngestionRunSummary	runId(java.lang.String runId)
DatahubIngestionRunSummary	runStatus(JobStatus runStatus)
void	setAvailableMemory(java.lang.Long availableMemory)
void	setConfig(java.lang.String config)
void	setCustomSummary(java.lang.String customSummary)
void	setEventGranularity(TimeWindowSize eventGranularity)
void	setMessageId(java.lang.String messageId)
void	setNumAspects(java.lang.Long numAspects)
void	setNumEntities(java.lang.Long numEntities)
void	setNumEntitiesSkipped(java.lang.Long numEntitiesSkipped)
void	setNumErrors(java.lang.Long numErrors)
void	setNumEvents(java.lang.Long numEvents)
void	setNumProcessors(java.lang.Integer numProcessors)
void	setNumSinkAPICalls(java.lang.Long numSinkAPICalls)
void	setNumSourceAPICalls(java.lang.Long numSourceAPICalls)
void	setNumWarnings(java.lang.Long numWarnings)
void	setNumWorkUnitsCommitted(java.lang.Long numWorkUnitsCommitted)
void	setNumWorkUnitsCreated(java.lang.Long numWorkUnitsCreated)
void	setOperatingSystemName(java.lang.String operatingSystemName)
void	setPartitionSpec(PartitionSpec partitionSpec)
void	setPipelineName(java.lang.String pipelineName)
void	setPlatformInstanceId(java.lang.String platformInstanceId)
void	setRunId(java.lang.String runId)
void	setRunStatus(JobStatus runStatus)
void	setSoftwareVersion(java.lang.String softwareVersion)
void	setSystemHostName(java.lang.String systemHostName)
void	setTimestampMillis(java.lang.Long timestampMillis)
void	setTotalLatencySinkAPICalls(java.lang.Long totalLatencySinkAPICalls)
void	setTotalLatencySourceAPICalls(java.lang.Long totalLatencySourceAPICalls)
void	setTotalMemory(java.lang.Long totalMemory)
DatahubIngestionRunSummary	softwareVersion(java.lang.String softwareVersion)
DatahubIngestionRunSummary	systemHostName(java.lang.String systemHostName)
DatahubIngestionRunSummary	timestampMillis(java.lang.Long timestampMillis)
java.lang.String	toString()
DatahubIngestionRunSummary	totalLatencySinkAPICalls(java.lang.Long totalLatencySinkAPICalls)
DatahubIngestionRunSummary	totalLatencySourceAPICalls(java.lang.Long totalLatencySourceAPICalls)
DatahubIngestionRunSummary	totalMemory(java.lang.Long totalMemory)

Methods inherited from class java.lang.Object

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

Constructor Detail

DatahubIngestionRunSummary

public DatahubIngestionRunSummary()

Method Detail

get__type

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

Name of this subclass in SimpleClassName format

Returns:

__type

timestampMillis

public DatahubIngestionRunSummary timestampMillis(java.lang.Long timestampMillis)

getTimestampMillis

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

The event timestamp field as epoch at UTC in milli seconds. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

timestampMillis

setTimestampMillis

public void setTimestampMillis(java.lang.Long timestampMillis)

eventGranularity

public DatahubIngestionRunSummary eventGranularity(TimeWindowSize eventGranularity)

getEventGranularity

@Valid
public @Valid TimeWindowSize getEventGranularity()

Get eventGranularity

Returns:

eventGranularity

setEventGranularity

public void setEventGranularity(TimeWindowSize eventGranularity)

partitionSpec

public DatahubIngestionRunSummary partitionSpec(PartitionSpec partitionSpec)

getPartitionSpec

@NotNull
 @Valid
public @NotNull @Valid PartitionSpec getPartitionSpec()

Get partitionSpec

Returns:

partitionSpec

setPartitionSpec

public void setPartitionSpec(PartitionSpec partitionSpec)

messageId

public DatahubIngestionRunSummary messageId(java.lang.String messageId)

getMessageId

public java.lang.String getMessageId()

The optional messageId, if provided serves as a custom user-defined unique identifier for an aspect value.

Returns:

messageId

setMessageId

public void setMessageId(java.lang.String messageId)

pipelineName

public DatahubIngestionRunSummary pipelineName(java.lang.String pipelineName)

getPipelineName

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

The name of the pipeline that ran ingestion, a stable unique user provided identifier. e.g. my_snowflake1-to-datahub.

Returns:

pipelineName

setPipelineName

public void setPipelineName(java.lang.String pipelineName)

platformInstanceId

public DatahubIngestionRunSummary platformInstanceId(java.lang.String platformInstanceId)

getPlatformInstanceId

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

The id of the instance against which the ingestion pipeline ran. e.g.: Bigquery project ids, MySQL hostnames etc.

Returns:

platformInstanceId

setPlatformInstanceId

public void setPlatformInstanceId(java.lang.String platformInstanceId)

runId

public DatahubIngestionRunSummary runId(java.lang.String runId)

getRunId

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

The runId for this pipeline instance.

Returns:

runId

setRunId

public void setRunId(java.lang.String runId)

runStatus

public DatahubIngestionRunSummary runStatus(JobStatus runStatus)

getRunStatus

@NotNull
 @Valid
public @NotNull @Valid JobStatus getRunStatus()

Get runStatus

Returns:

runStatus

setRunStatus

public void setRunStatus(JobStatus runStatus)

numWorkUnitsCommitted

public DatahubIngestionRunSummary numWorkUnitsCommitted(java.lang.Long numWorkUnitsCommitted)

getNumWorkUnitsCommitted

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

The number of workunits written to sink. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numWorkUnitsCommitted

setNumWorkUnitsCommitted

public void setNumWorkUnitsCommitted(java.lang.Long numWorkUnitsCommitted)

numWorkUnitsCreated

public DatahubIngestionRunSummary numWorkUnitsCreated(java.lang.Long numWorkUnitsCreated)

getNumWorkUnitsCreated

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

The number of workunits that are produced. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numWorkUnitsCreated

setNumWorkUnitsCreated

public void setNumWorkUnitsCreated(java.lang.Long numWorkUnitsCreated)

numEvents

public DatahubIngestionRunSummary numEvents(java.lang.Long numEvents)

getNumEvents

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

The number of events produced (MCE + MCP). minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numEvents

setNumEvents

public void setNumEvents(java.lang.Long numEvents)

numEntities

public DatahubIngestionRunSummary numEntities(java.lang.Long numEntities)

getNumEntities

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

The total number of entities produced (unique entity urns). minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numEntities

setNumEntities

public void setNumEntities(java.lang.Long numEntities)

numAspects

public DatahubIngestionRunSummary numAspects(java.lang.Long numAspects)

getNumAspects

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

The total number of aspects produced across all entities. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numAspects

setNumAspects

public void setNumAspects(java.lang.Long numAspects)

numSourceAPICalls

public DatahubIngestionRunSummary numSourceAPICalls(java.lang.Long numSourceAPICalls)

getNumSourceAPICalls

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

Total number of source API calls. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numSourceAPICalls

setNumSourceAPICalls

public void setNumSourceAPICalls(java.lang.Long numSourceAPICalls)

totalLatencySourceAPICalls

public DatahubIngestionRunSummary totalLatencySourceAPICalls(java.lang.Long totalLatencySourceAPICalls)

getTotalLatencySourceAPICalls

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

Total latency across all source API calls. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

totalLatencySourceAPICalls

setTotalLatencySourceAPICalls

public void setTotalLatencySourceAPICalls(java.lang.Long totalLatencySourceAPICalls)

numSinkAPICalls

public DatahubIngestionRunSummary numSinkAPICalls(java.lang.Long numSinkAPICalls)

getNumSinkAPICalls

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

Total number of sink API calls. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numSinkAPICalls

setNumSinkAPICalls

public void setNumSinkAPICalls(java.lang.Long numSinkAPICalls)

totalLatencySinkAPICalls

public DatahubIngestionRunSummary totalLatencySinkAPICalls(java.lang.Long totalLatencySinkAPICalls)

getTotalLatencySinkAPICalls

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

Total latency across all sink API calls. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

totalLatencySinkAPICalls

setTotalLatencySinkAPICalls

public void setTotalLatencySinkAPICalls(java.lang.Long totalLatencySinkAPICalls)

numWarnings

public DatahubIngestionRunSummary numWarnings(java.lang.Long numWarnings)

getNumWarnings

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

Number of warnings generated. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numWarnings

setNumWarnings

public void setNumWarnings(java.lang.Long numWarnings)

numErrors

public DatahubIngestionRunSummary numErrors(java.lang.Long numErrors)

getNumErrors

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

Number of errors generated. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numErrors

setNumErrors

public void setNumErrors(java.lang.Long numErrors)

numEntitiesSkipped

public DatahubIngestionRunSummary numEntitiesSkipped(java.lang.Long numEntitiesSkipped)

getNumEntitiesSkipped

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

Number of entities skipped. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

numEntitiesSkipped

setNumEntitiesSkipped

public void setNumEntitiesSkipped(java.lang.Long numEntitiesSkipped)

config

public DatahubIngestionRunSummary config(java.lang.String config)

getConfig

public java.lang.String getConfig()

The non-sensitive key-value pairs of the yaml config used as json string.

Returns:

config

setConfig

public void setConfig(java.lang.String config)

customSummary

public DatahubIngestionRunSummary customSummary(java.lang.String customSummary)

getCustomSummary

public java.lang.String getCustomSummary()

Custom value.

Returns:

customSummary

setCustomSummary

public void setCustomSummary(java.lang.String customSummary)

softwareVersion

public DatahubIngestionRunSummary softwareVersion(java.lang.String softwareVersion)

getSoftwareVersion

public java.lang.String getSoftwareVersion()

The software version of this ingestion.

Returns:

softwareVersion

setSoftwareVersion

public void setSoftwareVersion(java.lang.String softwareVersion)

systemHostName

public DatahubIngestionRunSummary systemHostName(java.lang.String systemHostName)

getSystemHostName

public java.lang.String getSystemHostName()

The hostname the ingestion pipeline ran on.

Returns:

systemHostName

setSystemHostName

public void setSystemHostName(java.lang.String systemHostName)

operatingSystemName

public DatahubIngestionRunSummary operatingSystemName(java.lang.String operatingSystemName)

getOperatingSystemName

public java.lang.String getOperatingSystemName()

The os the ingestion pipeline ran on.

Returns:

operatingSystemName

setOperatingSystemName

public void setOperatingSystemName(java.lang.String operatingSystemName)

numProcessors

public DatahubIngestionRunSummary numProcessors(java.lang.Integer numProcessors)

getNumProcessors

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

The number of processors on the host the ingestion pipeline ran on. minimum: -2147483648 maximum: 2147483647

Returns:

numProcessors

setNumProcessors

public void setNumProcessors(java.lang.Integer numProcessors)

totalMemory

public DatahubIngestionRunSummary totalMemory(java.lang.Long totalMemory)

getTotalMemory

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

The total amount of memory on the host the ingestion pipeline ran on. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

totalMemory

setTotalMemory

public void setTotalMemory(java.lang.Long totalMemory)

availableMemory

public DatahubIngestionRunSummary availableMemory(java.lang.Long availableMemory)

getAvailableMemory

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

The available memory on the host the ingestion pipeline ran on. minimum: -9223372036854775808 maximum: 9223372036854775807

Returns:

availableMemory

setAvailableMemory

public void setAvailableMemory(java.lang.Long availableMemory)

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