software.amazon.awssdk.services.timestreamquery.model

Class QueryStatus

java.lang.Object

software.amazon.awssdk.services.timestreamquery.model.QueryStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QueryStatus.Builder,QueryStatus>

@Generated(value="software.amazon.awssdk:codegen")
public final class QueryStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QueryStatus.Builder,QueryStatus>

Information about the status of the query, including progress and bytes scannned.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryStatus.Builder

Method Summary

Modifier and Type	Method and Description
static QueryStatus.Builder	builder()
Long	cumulativeBytesMetered() The amount of data scanned by the query in bytes that you will be charged for.
Long	cumulativeBytesScanned() The amount of data scanned by the query in bytes.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Double	progressPercentage() The progress of the query, expressed as a percentage.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryStatus.Builder>	serializableBuilderClass()
QueryStatus.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

progressPercentage

public final Double progressPercentage()

The progress of the query, expressed as a percentage.

Returns:

The progress of the query, expressed as a percentage.

cumulativeBytesScanned

public final Long cumulativeBytesScanned()

The amount of data scanned by the query in bytes. This is a cumulative sum and represents the total amount of bytes scanned since the query was started.

Returns:

The amount of data scanned by the query in bytes. This is a cumulative sum and represents the total amount of bytes scanned since the query was started.

cumulativeBytesMetered

public final Long cumulativeBytesMetered()

The amount of data scanned by the query in bytes that you will be charged for. This is a cumulative sum and represents the total amount of data that you will be charged for since the query was started. The charge is applied only once and is either applied when the query completes execution or when the query is cancelled.

Returns:

The amount of data scanned by the query in bytes that you will be charged for. This is a cumulative sum and represents the total amount of data that you will be charged for since the query was started. The charge is applied only once and is either applied when the query completes execution or when the query is cancelled.

toBuilder

public QueryStatus.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<QueryStatus.Builder,QueryStatus>

Returns:

a builder for type T

builder

public static QueryStatus.Builder builder()

serializableBuilderClass

public static Class<? extends QueryStatus.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.