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

Class ProgressEvent

java.lang.Object

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

All Implemented Interfaces:

SdkPojo, SelectObjectContentEventStream, ToCopyableBuilder<ProgressEvent.Builder,ProgressEvent>, Serializable

Direct Known Subclasses:

DefaultProgress

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

This data type contains information about the progress event of an operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProgressEvent.Builder
protected static class	ProgressEvent.BuilderImpl

Nested classes/interfaces inherited from interface com.ibm.cos.v2.services.s3.model.SelectObjectContentEventStream

SelectObjectContentEventStream.EventType

Field Summary

Fields inherited from interface com.ibm.cos.v2.services.s3.model.SelectObjectContentEventStream

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProgressEvent(ProgressEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method and Description
void	accept(SelectObjectContentResponseHandler.Visitor visitor) Calls the appropriate visit method depending on the subtype of ProgressEvent.
static ProgressEvent.Builder	builder()
ProgressEvent	copy(Consumer<? super ProgressEvent.Builder> modifier) A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build().
Progress	details() The Progress event details.
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 ProgressEvent.Builder>	serializableBuilderClass()
ProgressEvent.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.services.s3.model.SelectObjectContentEventStream

contBuilder, endBuilder, progressBuilder, recordsBuilder, sdkEventType, statsBuilder

Constructor Detail

ProgressEvent

protected ProgressEvent(ProgressEvent.BuilderImpl builder)

Method Detail

details

public final Progress details()

The Progress event details.

Returns:

The Progress event details.

toBuilder

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

Returns:

a builder for type T

builder

public static ProgressEvent.Builder builder()

serializableBuilderClass

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

copy

public final ProgressEvent copy(Consumer<? super ProgressEvent.Builder> modifier)

Description copied from interface: ToCopyableBuilder

A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.

Specified by:

copy in interface ToCopyableBuilder<ProgressEvent.Builder,ProgressEvent>

Parameters:

modifier - A function that mutates this immutable object using the provided builder.

Returns:

A new copy of this object with the requested modifications.

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.

accept

public void accept(SelectObjectContentResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of ProgressEvent.

Specified by:

accept in interface SelectObjectContentEventStream

Parameters:

visitor - Visitor to invoke.