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

Interface Redirect.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Redirect.Builder,Redirect>, SdkBuilder<Redirect.Builder,Redirect>, SdkPojo
Enclosing class:
Redirect
@Mutable @NotThreadSafe public static interface Redirect.Builder extends SdkPojo, CopyableBuilder<Redirect.Builder,Redirect>

  • Method Details

    • hostName

      Redirect.Builder hostName(String hostName)

      The host name to use in the redirect request.

      Parameters:
      hostName - The host name to use in the redirect request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpRedirectCode

      Redirect.Builder httpRedirectCode(String httpRedirectCode)

      The HTTP redirect code to use on the response. Not required if one of the siblings is present.

      Parameters:
      httpRedirectCode - The HTTP redirect code to use on the response. Not required if one of the siblings is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocol

      Redirect.Builder protocol(String protocol)

      Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

      Parameters:
      protocol - Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      Redirect.Builder protocol(Protocol protocol)

      Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

      Parameters:
      protocol - Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replaceKeyPrefixWith

      Redirect.Builder replaceKeyPrefixWith(String replaceKeyPrefixWith)

      The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

      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:
      replaceKeyPrefixWith - The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

      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.

    • replaceKeyWith

      Redirect.Builder replaceKeyWith(String replaceKeyWith)

      The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

      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:
      replaceKeyWith - The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

      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.