BucketWebsiteConfiguration (IBM COS SDK for Java 2.13.6 API)

java.lang.Object
- com.ibm.cloud.objectstorage.services.s3.model.BucketWebsiteConfiguration

All Implemented Interfaces:

Serializable
```
public class BucketWebsiteConfiguration
extends Object
implements Serializable
```
Bucket configuration options for hosting static websites entirely out of Amazon S3.
To host a static website in Amazon S3, create a bucket, upload your files, and set the bucket website configuration. Once your bucket has been configured as a website, you can access all your content via the Amazon S3 website endpoint. To ensure that the existing Amazon S3 REST API will continue to behave the same, regardless of whether or not your bucket has been configured to host a website, a new HTTP endpoint has been introduced where you can access your website content. The bucket content you want to make available via the website must be publicly readable.
To enable hosting websites, Amazon S3 introduces the following concepts/features:
- Website endpoints - When you configure a bucket as a website, the website is available via the the region-specific website endpoint where the bucket resides.
- Index document support - When configuring a bucket as a website you must provide an index document name. This is the webpage that Amazon S3 returns when it receives a request to the root of your website, or one of its subdirectories. Amazon S3 supports index documents in subdirectories.
- Error document support - Should an error occur, Amazon S3 will return an HTML error document, instead of an XML document.You can optionally provide your own error document that contains HTML, or any other static content specific to your website. You provide the error document name when you configure a bucket as a website. If you provide the custom error document, Amazon S3 returns your custom error document when an HTTP 4XX class error occurs. For other error non-4XX class errors, Amazon S3 will return its own error document.
For more information on how to host a website on Amazon S3, see: http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.html.
See Also:

AmazonS3Client.setBucketWebsiteConfiguration(String, BucketWebsiteConfiguration), AmazonS3Client.getBucketWebsiteConfiguration(String), AmazonS3Client.deleteBucketWebsiteConfiguration(String), Serialized Form

Constructor Summary

Constructors
Constructor and Description
`BucketWebsiteConfiguration()` Creates a new BucketWebsiteConfiguration.
`BucketWebsiteConfiguration(String indexDocumentSuffix)` Creates a new BucketWebsiteConfiguration with the specified index document suffix.
`BucketWebsiteConfiguration(String indexDocumentSuffix, String errorDocument)` Creates a new BucketWebsiteConfiguration with the specified index document suffix and error document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getErrorDocument()` Returns the complete path to the document to serve for 4xx errors, or null if no error document has been configured.
`String`	`getIndexDocumentSuffix()` Returns the document to serve when a directory is specified (ex: index.html).
`RedirectRule`	`getRedirectAllRequestsTo()` Return the redirect information where all requests will be redirect to.
`List<RoutingRule>`	`getRoutingRules()` Return the list of routing rules that can be used for configuring redirects if certain conditions are meet.
`void`	`setErrorDocument(String errorDocument)` Sets the complete path to the document to serve for 4xx errors.
`void`	`setIndexDocumentSuffix(String indexDocumentSuffix)` Sets the document to serve when a directory is specified (ex: index.html).
`void`	`setRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)` Sets the redirect information where all requests will be redirect to.
`void`	`setRoutingRules(List<RoutingRule> routingRules)` Set the list of routing rules that can be used for configuring redirects if certain conditions are meet.
`BucketWebsiteConfiguration`	`withIndexDocumentSuffix(String indexDocumentSuffix)` Sets the document to serve when a directory is specified (ex: index.html).
`BucketWebsiteConfiguration`	`withRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)` Sets the redirect information where all requests will be redirect to and returns a reference to this object(BucketWebsiteConfiguration) for method chaining.
`BucketWebsiteConfiguration`	`withRoutingRules(List<RoutingRule> routingRules)` Set the list of routing rules that can be used for configuring redirects if certain conditions are meet and returns a reference to this object(BucketWebsiteConfiguration) for method chaining.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BucketWebsiteConfiguration
```
public BucketWebsiteConfiguration()
```
    Creates a new BucketWebsiteConfiguration.
  - BucketWebsiteConfiguration
```
public BucketWebsiteConfiguration(String indexDocumentSuffix)
```
    Creates a new BucketWebsiteConfiguration with the specified index document suffix.
    
    Parameters:
    
    indexDocumentSuffix - The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
  - BucketWebsiteConfiguration
```
public BucketWebsiteConfiguration(String indexDocumentSuffix,
                                  String errorDocument)
```
    Creates a new BucketWebsiteConfiguration with the specified index document suffix and error document.
    
    Parameters:
    
    indexDocumentSuffix - The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
    
    errorDocument - The complete path to the document to serve for 4xx errors.
- Method Detail
  - getIndexDocumentSuffix
```
public String getIndexDocumentSuffix()
```
    Returns the document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
    
    Returns:
    
    The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
  - withIndexDocumentSuffix
```
public BucketWebsiteConfiguration withIndexDocumentSuffix(String indexDocumentSuffix)
```
    Sets the document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
    
    Parameters:
    
    indexDocumentSuffix - The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
    
    Returns:
  - setIndexDocumentSuffix
```
public void setIndexDocumentSuffix(String indexDocumentSuffix)
```
    Sets the document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
    
    Parameters:
    
    indexDocumentSuffix - The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
  - getErrorDocument
```
public String getErrorDocument()
```
    Returns the complete path to the document to serve for 4xx errors, or null if no error document has been configured.
    
    Returns:
    
    The complete path to the document to serve for 4xx errors, or null if no error document has been configured.
  - setErrorDocument
```
public void setErrorDocument(String errorDocument)
```
    Sets the complete path to the document to serve for 4xx errors.
    
    Parameters:
    
    errorDocument - The complete path to the document to serve for 4xx errors.
  - setRedirectAllRequestsTo
```
public void setRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)
```
    Sets the redirect information where all requests will be redirect to.
    
    Parameters:
    
    redirectAllRequestsTo - The Redirect information where all requests will be redirect to.
  - getRedirectAllRequestsTo
```
public RedirectRule getRedirectAllRequestsTo()
```
    Return the redirect information where all requests will be redirect to.
  - withRedirectAllRequestsTo
```
public BucketWebsiteConfiguration withRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)
```
    Sets the redirect information where all requests will be redirect to and returns a reference to this object(BucketWebsiteConfiguration) for method chaining.
    
    Parameters:
    
    redirectAllRequestsTo - The Redirect information where all requests will be redirect to.
    
    Returns:
    
    a reference to this object(BucketWebsiteConfiguration) for method chaining.
  - setRoutingRules
```
public void setRoutingRules(List<RoutingRule> routingRules)
```
    Set the list of routing rules that can be used for configuring redirects if certain conditions are meet.
    
    Parameters:
    
    routingRules - The list of routing rules that can be used for configuring redirects.
  - getRoutingRules
```
public List<RoutingRule> getRoutingRules()
```
    Return the list of routing rules that can be used for configuring redirects if certain conditions are meet.
  - withRoutingRules
```
public BucketWebsiteConfiguration withRoutingRules(List<RoutingRule> routingRules)
```
    Set the list of routing rules that can be used for configuring redirects if certain conditions are meet and returns a reference to this object(BucketWebsiteConfiguration) for method chaining.
    
    Parameters:
    
    routingRules - The list of routing rules that can be used for configuring redirects.
    
    Returns:
    
    A reference to this object(BucketWebsiteConfiguration) for method chaining.

Class BucketWebsiteConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BucketWebsiteConfiguration

BucketWebsiteConfiguration

BucketWebsiteConfiguration

Method Detail

getIndexDocumentSuffix

withIndexDocumentSuffix

setIndexDocumentSuffix

getErrorDocument

setErrorDocument

setRedirectAllRequestsTo

getRedirectAllRequestsTo

withRedirectAllRequestsTo

setRoutingRules

getRoutingRules

withRoutingRules