com.ibm.cos.v2.services.s3.model

Class GetBucketWebsiteResponse

java.lang.Object

com.ibm.cos.v2.core.SdkResponse

com.ibm.cos.v2.awscore.AwsResponse

com.ibm.cos.v2.services.s3.model.S3Response

com.ibm.cos.v2.services.s3.model.GetBucketWebsiteResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetBucketWebsiteResponse.Builder,GetBucketWebsiteResponse>

@Generated(value="com.ibm.cos.v2:codegen")
public final class GetBucketWebsiteResponse
extends S3Response
implements ToCopyableBuilder<GetBucketWebsiteResponse.Builder,GetBucketWebsiteResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetBucketWebsiteResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetBucketWebsiteResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
ErrorDocument	errorDocument() The object key name of the website error document to use for 4XX class errors.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
boolean	hasRoutingRules() For responses, this returns true if the service returned a value for the RoutingRules property.
IndexDocument	indexDocument() The name of the index document for the website (for example index.html).
RedirectAllRequestsTo	redirectAllRequestsTo() Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
List<RoutingRule>	routingRules() Rules that define when a redirect is applied and the redirect behavior.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetBucketWebsiteResponse.Builder>	serializableBuilderClass()
GetBucketWebsiteResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response

responseMetadata

Methods inherited from class com.ibm.cos.v2.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

redirectAllRequestsTo

public final RedirectAllRequestsTo redirectAllRequestsTo()

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

Returns:

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

indexDocument

public final IndexDocument indexDocument()

The name of the index document for the website (for example index.html).

Returns:

The name of the index document for the website (for example index.html).

errorDocument

public final ErrorDocument errorDocument()

The object key name of the website error document to use for 4XX class errors.

Returns:

The object key name of the website error document to use for 4XX class errors.

hasRoutingRules

public final boolean hasRoutingRules()

For responses, this returns true if the service returned a value for the RoutingRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

routingRules

public final List<RoutingRule> routingRules()

Rules that define when a redirect is applied and the redirect behavior.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRoutingRules() method.

Returns:

Rules that define when a redirect is applied and the redirect behavior.

toBuilder

public GetBucketWebsiteResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetBucketWebsiteResponse.Builder,GetBucketWebsiteResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetBucketWebsiteResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetBucketWebsiteResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.