Package software.amazon.awssdk.services.s3.model

Interface IndexDocument.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IndexDocument.Builder,IndexDocument>, SdkBuilder<IndexDocument.Builder,IndexDocument>, SdkPojo
Enclosing class:
IndexDocument
public static interface IndexDocument.Builder extends SdkPojo, CopyableBuilder<IndexDocument.Builder,IndexDocument>

  • Method Summary

    Modifier and Type
    Method
    Description
    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.

    Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

    copy

    Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

    applyMutation, build

    Methods inherited from interface software.amazon.awssdk.core.SdkPojo

    equalsBySdkFields, sdkFields

  • Method Details

    • 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.