Package software.amazon.awssdk.services.s3.model

Class DeleteObjectsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.s3.model.S3Response

software.amazon.awssdk.services.s3.model.DeleteObjectsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteObjectsResponse.Builder,DeleteObjectsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DeleteObjectsResponse
extends S3Response
implements ToCopyableBuilder<DeleteObjectsResponse.Builder,DeleteObjectsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteObjectsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteObjectsResponse.Builder	builder()
List<DeletedObject>	deleted()	Container element for a successful delete.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<S3Error>	errors()	Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeleted()	For responses, this returns true if the service returned a value for the Deleted property.
boolean	hasErrors()	For responses, this returns true if the service returned a value for the Errors property.
int	hashCode()
RequestCharged	requestCharged()	Returns the value of the RequestCharged property for this object.
String	requestChargedAsString()	Returns the value of the RequestCharged property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteObjectsResponse.Builder>	serializableBuilderClass()
DeleteObjectsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.s3.model.S3Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasDeleted

public final boolean hasDeleted()

For responses, this returns true if the service returned a value for the Deleted 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.

deleted

public final List<DeletedObject> deleted()

Container element for a successful delete. It identifies the object that was successfully deleted.

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 hasDeleted() method.

Returns:

Container element for a successful delete. It identifies the object that was successfully deleted.

requestCharged

public final RequestCharged requestCharged()

Returns the value of the RequestCharged property for this object.

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

Returns:

The value of the RequestCharged property for this object.

See Also:

RequestCharged

requestChargedAsString

public final String requestChargedAsString()

Returns the value of the RequestCharged property for this object.

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

Returns:

The value of the RequestCharged property for this object.

See Also:

RequestCharged

hasErrors

public final boolean hasErrors()

For responses, this returns true if the service returned a value for the Errors 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.

errors

public final List<S3Error> errors()

Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.

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 hasErrors() method.

Returns:

Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.

toBuilder

public DeleteObjectsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteObjectsResponse.Builder,DeleteObjectsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DeleteObjectsResponse.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo