Package com.oracle.bmc.datacatalog.model

Class JobMetric

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.datacatalog.model.JobMetric

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class JobMetric
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A set of metrics are collected periodically to assess the state and performance characteristics of the execution instance of a job.

The metrics are grouped based on their category and sub categories and aggregated based on their batch information.
Note: Objects should always be created or deserialized using the JobMetric.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the JobMetric.Builder, which maintain a set of all explicitly set fields called JobMetric.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JobMetric.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
JobMetric(String key, String description, String jobExecutionKey, Date timeInserted, String category, String displayName, String subCategory, String unit, String value, String batchKey, String uri, Date timeCreated, Date timeUpdated, String createdById, String updatedById)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static JobMetric.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getBatchKey()	Batch key for grouping, may be null.
String	getCategory()	Category of this metric.
String	getCreatedById()	OCID of the user who created the metric for this job.
String	getDescription()	Detailed description of the metric.
String	getDisplayName()	A user-friendly display name.
String	getJobExecutionKey()	The unique key of the parent job execution for which the job metric resource is being created.
String	getKey()	Key of the job metric that is immutable.
String	getSubCategory()	Sub category of this metric under the category.
Date	getTimeCreated()	The date and time the job metric was created, in the format defined by RFC3339.
Date	getTimeInserted()	The time the metric was logged or captured in the system where the job executed.
Date	getTimeUpdated()	The last time that this metric was updated.
String	getUnit()	Unit of this metric.
String	getUpdatedById()	OCID of the user who created the metric for this job.
String	getUri()	URI to the job metric instance in the API.
String	getValue()	Value of this metric.
int	hashCode()
JobMetric.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

JobMetric

@Deprecated
@ConstructorProperties({"key","description","jobExecutionKey","timeInserted","category","displayName","subCategory","unit","value","batchKey","uri","timeCreated","timeUpdated","createdById","updatedById"})
public JobMetric(String key,
                 String description,
                 String jobExecutionKey,
                 Date timeInserted,
                 String category,
                 String displayName,
                 String subCategory,
                 String unit,
                 String value,
                 String batchKey,
                 String uri,
                 Date timeCreated,
                 Date timeUpdated,
                 String createdById,
                 String updatedById)

Deprecated.

Method Detail

builder

public static JobMetric.Builder builder()

Create a new builder.

toBuilder

public JobMetric.Builder toBuilder()

getKey

public String getKey()

Key of the job metric that is immutable.

Returns:

the value

getDescription

public String getDescription()

Detailed description of the metric.

Returns:

the value

getJobExecutionKey

public String getJobExecutionKey()

The unique key of the parent job execution for which the job metric resource is being created.

Returns:

the value

getTimeInserted

public Date getTimeInserted()

The time the metric was logged or captured in the system where the job executed.

An RFC3339 formatted datetime string.

Returns:

the value

getCategory

public String getCategory()

Category of this metric.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getSubCategory

public String getSubCategory()

Sub category of this metric under the category.

Used for aggregating values. May be null.

Returns:

the value

getUnit

public String getUnit()

Unit of this metric.

Returns:

the value

getValue

public String getValue()

Value of this metric.

Returns:

the value

getBatchKey

public String getBatchKey()

Batch key for grouping, may be null.

Returns:

the value

getUri

public String getUri()

URI to the job metric instance in the API.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the job metric was created, in the format defined by RFC3339.

Example: 2019-03-25T21:10:29.600Z

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The last time that this metric was updated.

An RFC3339 formatted datetime string.

Returns:

the value

getCreatedById

public String getCreatedById()

OCID of the user who created the metric for this job.

Usually the executor of the job instance.

Returns:

the value

getUpdatedById

public String getUpdatedById()

OCID of the user who created the metric for this job.

Usually the executor of the job instance.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel