software.amazon.awssdk.services.directory.model

Class Snapshot

java.lang.Object

software.amazon.awssdk.services.directory.model.Snapshot

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class Snapshot
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Snapshot.Builder,Snapshot>

Describes a directory snapshot.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Snapshot.Builder

Method Summary

Modifier and Type	Method and Description
static Snapshot.Builder	builder()
String	directoryId() The directory identifier.
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)
int	hashCode()
String	name() The descriptive name of the snapshot.
List<SdkField<?>>	sdkFields()
static Class<? extends Snapshot.Builder>	serializableBuilderClass()
String	snapshotId() The snapshot identifier.
Instant	startTime() The date and time that the snapshot was taken.
SnapshotStatus	status() The snapshot status.
String	statusAsString() The snapshot status.
Snapshot.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.
SnapshotType	type() The snapshot type.
String	typeAsString() The snapshot type.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

directoryId

public final String directoryId()

The directory identifier.

Returns:

The directory identifier.

snapshotId

public final String snapshotId()

The snapshot identifier.

Returns:

The snapshot identifier.

type

public final SnapshotType type()

The snapshot type.

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

Returns:

The snapshot type.

See Also:

SnapshotType

typeAsString

public final String typeAsString()

The snapshot type.

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

Returns:

The snapshot type.

See Also:

SnapshotType

name

public final String name()

The descriptive name of the snapshot.

Returns:

The descriptive name of the snapshot.

status

public final SnapshotStatus status()

The snapshot status.

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

Returns:

The snapshot status.

See Also:

SnapshotStatus

statusAsString

public final String statusAsString()

The snapshot status.

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

Returns:

The snapshot status.

See Also:

SnapshotStatus

startTime

public final Instant startTime()

The date and time that the snapshot was taken.

Returns:

The date and time that the snapshot was taken.

toBuilder

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

Returns:

a builder for type T

builder

public static Snapshot.Builder builder()

serializableBuilderClass

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