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

Class ObjectIdentifier

java.lang.Object

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ObjectIdentifier.Builder,ObjectIdentifier>, Serializable

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

Object Identifier is unique value to identify objects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ObjectIdentifier.Builder

Method Summary

Modifier and Type	Method and Description
static ObjectIdentifier.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	eTag() An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() Key name of the object.
Instant	lastModifiedTime() If present, the objects are deleted only if its modification times matches the provided Timestamp.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ObjectIdentifier.Builder>	serializableBuilderClass()
Long	size() If present, the objects are deleted only if its size matches the provided size in bytes.
ObjectIdentifier.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.
String	versionId() Version ID for the specific version of the object to delete.

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

key

public final String key()

Key name of the object.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

Returns:

Key name of the object.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

versionId

public final String versionId()

Version ID for the specific version of the object to delete.

This functionality is not supported for directory buckets.

Returns:

Version ID for the specific version of the object to delete.

This functionality is not supported for directory buckets.

eTag

public final String eTag()

An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL. This header field makes the request method conditional on ETags.

Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object.

Returns:

An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL. This header field makes the request method conditional on ETags.

Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object.

lastModifiedTime

public final Instant lastModifiedTime()

If present, the objects are deleted only if its modification times matches the provided Timestamp.

This functionality is only supported for directory buckets.

Returns:

If present, the objects are deleted only if its modification times matches the provided Timestamp.

This functionality is only supported for directory buckets.

size

public final Long size()

If present, the objects are deleted only if its size matches the provided size in bytes.

This functionality is only supported for directory buckets.

Returns:

If present, the objects are deleted only if its size matches the provided size in bytes.

This functionality is only supported for directory buckets.

toBuilder

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

Returns:

a builder for type T

builder

public static ObjectIdentifier.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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.