Class Bucket.Website.Builder (2.62.1)

public static final class Bucket.Website.Builder extends GeneratedMessage.Builder<Bucket.Website.Builder> implements Bucket.WebsiteOrBuilder

Properties of a bucket related to accessing the contents as a static website. For details, see hosting a static website using Cloud Storage.

Protobuf type google.storage.v2.Bucket.Website

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public Bucket.Website build()
Returns
Type Description
Bucket.Website

buildPartial()

public Bucket.Website buildPartial()
Returns
Type Description
Bucket.Website

clear()

public Bucket.Website.Builder clear()
Returns
Type Description
Bucket.Website.Builder
Overrides

clearMainPageSuffix()

public Bucket.Website.Builder clearMainPageSuffix()

Optional. If the requested object path is missing, the service ensures the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.

string main_page_suffix = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Website.Builder

This builder for chaining.

clearNotFoundPage()

public Bucket.Website.Builder clearNotFoundPage()

Optional. If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service returns the named object from this bucket as the content for a 404 Not Found result.

string not_found_page = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Bucket.Website.Builder

This builder for chaining.

getDefaultInstanceForType()

public Bucket.Website getDefaultInstanceForType()
Returns
Type Description
Bucket.Website

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMainPageSuffix()

public String getMainPageSuffix()

Optional. If the requested object path is missing, the service ensures the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.

string main_page_suffix = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The mainPageSuffix.

getMainPageSuffixBytes()

public ByteString getMainPageSuffixBytes()

Optional. If the requested object path is missing, the service ensures the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.

string main_page_suffix = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for mainPageSuffix.

getNotFoundPage()

public String getNotFoundPage()

Optional. If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service returns the named object from this bucket as the content for a 404 Not Found result.

string not_found_page = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The notFoundPage.

getNotFoundPageBytes()

public ByteString getNotFoundPageBytes()

Optional. If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service returns the named object from this bucket as the content for a 404 Not Found result.

string not_found_page = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for notFoundPage.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Bucket.Website.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Bucket.Website.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Bucket.Website.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Bucket.Website.Builder
Overrides

mergeFrom(Bucket.Website other)

public Bucket.Website.Builder mergeFrom(Bucket.Website other)
Parameter
Name Description
other Bucket.Website
Returns
Type Description
Bucket.Website.Builder

setMainPageSuffix(String value)

public Bucket.Website.Builder setMainPageSuffix(String value)

Optional. If the requested object path is missing, the service ensures the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.

string main_page_suffix = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The mainPageSuffix to set.

Returns
Type Description
Bucket.Website.Builder

This builder for chaining.

setMainPageSuffixBytes(ByteString value)

public Bucket.Website.Builder setMainPageSuffixBytes(ByteString value)

Optional. If the requested object path is missing, the service ensures the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.

string main_page_suffix = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for mainPageSuffix to set.

Returns
Type Description
Bucket.Website.Builder

This builder for chaining.

setNotFoundPage(String value)

public Bucket.Website.Builder setNotFoundPage(String value)

Optional. If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service returns the named object from this bucket as the content for a 404 Not Found result.

string not_found_page = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The notFoundPage to set.

Returns
Type Description
Bucket.Website.Builder

This builder for chaining.

setNotFoundPageBytes(ByteString value)

public Bucket.Website.Builder setNotFoundPageBytes(ByteString value)

Optional. If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service returns the named object from this bucket as the content for a 404 Not Found result.

string not_found_page = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for notFoundPage to set.

Returns
Type Description
Bucket.Website.Builder

This builder for chaining.