com.ibm.cos.v2.services.s3.model

Class Progress

java.lang.Object

com.ibm.cos.v2.services.s3.model.Progress

All Implemented Interfaces:

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

@Generated(value="com.ibm.cos.v2:codegen")
public final class Progress
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Progress.Builder,Progress>

This data type contains information about progress of an operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Progress.Builder

Method Summary

Modifier and Type	Method and Description
static Progress.Builder	builder()
Long	bytesProcessed() The current number of uncompressed object bytes processed.
Long	bytesReturned() The current number of bytes of records payload data returned.
Long	bytesScanned() The current number of object bytes scanned.
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()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Progress.Builder>	serializableBuilderClass()
Progress.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

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

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

bytesScanned

public final Long bytesScanned()

The current number of object bytes scanned.

Returns:

The current number of object bytes scanned.

bytesProcessed

public final Long bytesProcessed()

The current number of uncompressed object bytes processed.

Returns:

The current number of uncompressed object bytes processed.

bytesReturned

public final Long bytesReturned()

The current number of bytes of records payload data returned.

Returns:

The current number of bytes of records payload data returned.

toBuilder

public Progress.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<Progress.Builder,Progress>

Returns:

a builder for type T

builder

public static Progress.Builder builder()

serializableBuilderClass

public static Class<? extends Progress.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.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.