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

Interface IndexDocument.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IndexDocument.Builder,IndexDocument>, SdkBuilder<IndexDocument.Builder,IndexDocument>, SdkPojo

Enclosing class:

IndexDocument

@Mutable
 @NotThreadSafe
public static interface IndexDocument.Builder
extends SdkPojo, CopyableBuilder<IndexDocument.Builder,IndexDocument>

Method Summary

Modifier and Type	Method and Description
IndexDocument.Builder	suffix(String suffix) A suffix that is appended to a request that is for a directory on the website endpoint.

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

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

copy

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

applyMutation, build

Method Detail

suffix

IndexDocument.Builder suffix(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.