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

Class GetBucketLocationResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetBucketLocationResponse.Builder,GetBucketLocationResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetBucketLocationResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetBucketLocationResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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()
BucketLocationConstraint	locationConstraint() Specifies the Region where the bucket resides.
String	locationConstraintAsString() Specifies the Region where the bucket resides.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetBucketLocationResponse.Builder>	serializableBuilderClass()
GetBucketLocationResponse.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

locationConstraint

public final BucketLocationConstraint locationConstraint()

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints.

Buckets in Region us-east-1 have a LocationConstraint of null. Buckets with a LocationConstraint of EU reside in eu-west-1.

If the service returns an enum value that is not available in the current SDK version, locationConstraint will return BucketLocationConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationConstraintAsString().

Returns:

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints.

Buckets in Region us-east-1 have a LocationConstraint of null. Buckets with a LocationConstraint of EU reside in eu-west-1.

See Also:

BucketLocationConstraint

locationConstraintAsString

public final String locationConstraintAsString()

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints.

Buckets in Region us-east-1 have a LocationConstraint of null. Buckets with a LocationConstraint of EU reside in eu-west-1.

If the service returns an enum value that is not available in the current SDK version, locationConstraint will return BucketLocationConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from locationConstraintAsString().

Returns:

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints.

Buckets in Region us-east-1 have a LocationConstraint of null. Buckets with a LocationConstraint of EU reside in eu-west-1.

See Also:

BucketLocationConstraint

toBuilder

public GetBucketLocationResponse.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<GetBucketLocationResponse.Builder,GetBucketLocationResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static GetBucketLocationResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetBucketLocationResponse.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.