software.amazon.awssdk.services.kendra.model

Class S3Path

java.lang.Object

software.amazon.awssdk.services.kendra.model.S3Path

All Implemented Interfaces:

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

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

Information required to find a specific file in an Amazon S3 bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	S3Path.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The name of the S3 bucket that contains the file.
static S3Path.Builder	builder()
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()
String	key() The name of the file.
List<SdkField<?>>	sdkFields()
static Class<? extends S3Path.Builder>	serializableBuilderClass()
S3Path.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

bucket

public final String bucket()

The name of the S3 bucket that contains the file.

Returns:

The name of the S3 bucket that contains the file.

key

public final String key()

The name of the file.

Returns:

The name of the file.

toBuilder

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

Returns:

a builder for type T

builder

public static S3Path.Builder builder()

serializableBuilderClass

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