com.qcloud.cos.model

Class BucketWebsiteConfiguration

java.lang.Object

com.qcloud.cos.model.BucketWebsiteConfiguration

All Implemented Interfaces:

Serializable

public class BucketWebsiteConfiguration
extends Object
implements Serializable

Bucket configuration options for hosting static websites entirely out of COS

See Also:

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

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

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.