DeleteObjectsResponse (IBM COS Java SDK

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DeleteObjectsResponse.Builder,DeleteObjectsResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DeleteObjectsResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DeleteObjectsResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DeleteObjectsResponse.Builder`	`builder()`
`List<DeletedObject>`	`deleted()` Container element for a successful delete.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`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)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeleteObjectsResponse.Builder>`	`serializableBuilderClass()`
`DeleteObjectsResponse.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
  - 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()
```
    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<DeleteObjectsResponse.Builder,DeleteObjectsResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - 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)
```
    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.

Class DeleteObjectsResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

hasDeleted

deleted

requestCharged

requestChargedAsString

hasErrors

errors

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField