Package com.oracle.bmc.loganalytics.model

Class QueryWorkRequest

java.lang.Object

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

com.oracle.bmc.loganalytics.model.QueryWorkRequest

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

Job details outlining parameters specified when job was submitted.
Note: Objects should always be created or deserialized using the QueryWorkRequest.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 QueryWorkRequest.Builder, which maintain a set of all explicitly set fields called QueryWorkRequest.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	QueryWorkRequest.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
QueryWorkRequest(String id, String compartmentId, Date timeStarted, Date timeAccepted, Date timeFinished, Date timeExpires, Integer percentComplete, WorkRequestStatus status, QueryOperationType operationType, JobMode mode, Date timeBackgroundAt, TimeRange timeFilter, List<ScopeFilter> scopeFilters, SubSystemName subSystem, String displayQueryString, String internalQueryString)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static QueryWorkRequest.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	Compartment Identifier [OCID] (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
String	getDisplayQueryString()	Display version of the user speciified queryString.
String	getId()	Unique OCID identifier to reference this query job work Request with.
String	getInternalQueryString()	Internal version of the user specified queryString.
JobMode	getMode()	Current execution mode for the job.
QueryOperationType	getOperationType()	Asynchronous action name.
Integer	getPercentComplete()	Percentage progress completion of the query.
List<ScopeFilter>	getScopeFilters()	List of filters applied when the query executed.
WorkRequestStatus	getStatus()	Work request status.
SubSystemName	getSubSystem()	Default subsystem to qualify fields with in the queryString if not specified.
Date	getTimeAccepted()	When the work request was accepted.
Date	getTimeBackgroundAt()	When the job was put in to the background.
Date	getTimeExpires()	When the job will expire.
TimeRange	getTimeFilter()
Date	getTimeFinished()	When the job finished execution.
Date	getTimeStarted()	When the job was started.
int	hashCode()
QueryWorkRequest.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

QueryWorkRequest

@Deprecated
@ConstructorProperties({"id","compartmentId","timeStarted","timeAccepted","timeFinished","timeExpires","percentComplete","status","operationType","mode","timeBackgroundAt","timeFilter","scopeFilters","subSystem","displayQueryString","internalQueryString"})
public QueryWorkRequest(String id,
                        String compartmentId,
                        Date timeStarted,
                        Date timeAccepted,
                        Date timeFinished,
                        Date timeExpires,
                        Integer percentComplete,
                        WorkRequestStatus status,
                        QueryOperationType operationType,
                        JobMode mode,
                        Date timeBackgroundAt,
                        TimeRange timeFilter,
                        List<ScopeFilter> scopeFilters,
                        SubSystemName subSystem,
                        String displayQueryString,
                        String internalQueryString)

Deprecated.

Method Detail

builder

public static QueryWorkRequest.Builder builder()

Create a new builder.

toBuilder

public QueryWorkRequest.Builder toBuilder()

getId

public String getId()

Unique OCID identifier to reference this query job work Request with.

Returns:

the value

getCompartmentId

public String getCompartmentId()

Compartment Identifier [OCID] (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Returns:

the value

getTimeStarted

public Date getTimeStarted()

When the job was started.

Returns:

the value

getTimeAccepted

public Date getTimeAccepted()

When the work request was accepted.

Should match timeStarted in all cases.

Returns:

the value

getTimeFinished

public Date getTimeFinished()

When the job finished execution.

Returns:

the value

getTimeExpires

public Date getTimeExpires()

When the job will expire.

Returns:

the value

getPercentComplete

public Integer getPercentComplete()

Percentage progress completion of the query.

Returns:

the value

getStatus

public WorkRequestStatus getStatus()

Work request status.

Returns:

the value

getOperationType

public QueryOperationType getOperationType()

Asynchronous action name.

Returns:

the value

getMode

public JobMode getMode()

Current execution mode for the job.

Returns:

the value

getTimeBackgroundAt

public Date getTimeBackgroundAt()

When the job was put in to the background.

Returns:

the value

getTimeFilter

public TimeRange getTimeFilter()

getScopeFilters

public List<ScopeFilter> getScopeFilters()

List of filters applied when the query executed.

Returns:

the value

getSubSystem

public SubSystemName getSubSystem()

Default subsystem to qualify fields with in the queryString if not specified.

Returns:

the value

getDisplayQueryString

public String getDisplayQueryString()

Display version of the user speciified queryString.

Returns:

the value

getInternalQueryString

public String getInternalQueryString()

Internal version of the user specified queryString.

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