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

Class SelectParameters

java.lang.Object

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

All Implemented Interfaces:

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

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

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

Describes the parameters for Select job types.

Learn How to optimize querying your data in Amazon S3 using Amazon Athena, S3 Object Lambda, or client-side filtering.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SelectParameters.Builder

Method Summary

Modifier and Type	Method and Description
static SelectParameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	expression()
ExpressionType	expressionType() The type of the provided expression (for example, SQL).
String	expressionTypeAsString() The type of the provided expression (for example, SQL).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputSerialization	inputSerialization() Describes the serialization format of the object.
OutputSerialization	outputSerialization() Describes how the results of the Select job are serialized.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SelectParameters.Builder>	serializableBuilderClass()
SelectParameters.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

inputSerialization

public final InputSerialization inputSerialization()

Describes the serialization format of the object.

Returns:

Describes the serialization format of the object.

expressionType

public final ExpressionType expressionType()

The type of the provided expression (for example, SQL).

If the service returns an enum value that is not available in the current SDK version, expressionType will return ExpressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expressionTypeAsString().

Returns:

The type of the provided expression (for example, SQL).

See Also:

ExpressionType

expressionTypeAsString

public final String expressionTypeAsString()

The type of the provided expression (for example, SQL).

If the service returns an enum value that is not available in the current SDK version, expressionType will return ExpressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expressionTypeAsString().

Returns:

The type of the provided expression (for example, SQL).

See Also:

ExpressionType

expression

public final String expression()

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

The expression that is used to query the object.

Returns:

Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

The expression that is used to query the object.

outputSerialization

public final OutputSerialization outputSerialization()

Describes how the results of the Select job are serialized.

Returns:

Describes how the results of the Select job are serialized.

toBuilder

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

Returns:

a builder for type T

builder

public static SelectParameters.Builder builder()

serializableBuilderClass

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