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

Class IndexDocument

java.lang.Object

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

All Implemented Interfaces:

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

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

Container for the Suffix element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	IndexDocument.Builder

Method Summary

Modifier and Type	Method and Description
static IndexDocument.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends IndexDocument.Builder>	serializableBuilderClass()
String	suffix() A suffix that is appended to a request that is for a directory on the website endpoint.
IndexDocument.Builder	toBuilder()
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

suffix

public final String suffix()

A suffix that is appended to a request that is for a directory on the website endpoint. (For example, if the suffix is index.html and you make a request to samplebucket/images/, the data that is returned will be for the object with the key name images/index.html.) The suffix must not be empty and must not include a slash character.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

Returns:

A suffix that is appended to a request that is for a directory on the website endpoint. (For example, if the suffix is index.html and you make a request to samplebucket/images/, the data that is returned will be for the object with the key name images/index.html.) The suffix must not be empty and must not include a slash character.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

toBuilder

public IndexDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IndexDocument.Builder,IndexDocument>

builder

public static IndexDocument.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo