Package software.amazon.awssdk.services.workdocs.model

Class Activity

java.lang.Object

software.amazon.awssdk.services.workdocs.model.Activity

All Implemented Interfaces:

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

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

Describes the activity information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Activity.Builder

Method Summary

Modifier and Type	Method	Description
static Activity.Builder	builder()
CommentMetadata	commentMetadata()	Metadata of the commenting activity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
UserMetadata	initiator()	The user who performed the action.
Boolean	isIndirectActivity()	Indicates whether an activity is indirect or direct.
String	organizationId()	The ID of the organization.
ResourceMetadata	originalParent()	The original parent of the resource.
Participants	participants()	The list of users or groups impacted by this action.
ResourceMetadata	resourceMetadata()	The metadata of the resource involved in the user action.
List<SdkField<?>>	sdkFields()
static Class<? extends Activity.Builder>	serializableBuilderClass()
Instant	timeStamp()	The timestamp when the action was performed.
Activity.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ActivityType	type()	The activity type.
String	typeAsString()	The activity type.

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

type

public final ActivityType type()

The activity type.

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

Returns:

The activity type.

See Also:

ActivityType

typeAsString

public final String typeAsString()

The activity type.

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

Returns:

The activity type.

See Also:

ActivityType

timeStamp

public final Instant timeStamp()

The timestamp when the action was performed.

Returns:

The timestamp when the action was performed.

isIndirectActivity

public final Boolean isIndirectActivity()

Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

Returns:

Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

organizationId

public final String organizationId()

The ID of the organization.

Returns:

The ID of the organization.

initiator

public final UserMetadata initiator()

The user who performed the action.

Returns:

The user who performed the action.

participants

public final Participants participants()

The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

Returns:

The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

resourceMetadata

public final ResourceMetadata resourceMetadata()

The metadata of the resource involved in the user action.

Returns:

The metadata of the resource involved in the user action.

originalParent

public final ResourceMetadata originalParent()

The original parent of the resource. This is an optional field and is filled for move activities.

Returns:

The original parent of the resource. This is an optional field and is filled for move activities.

commentMetadata

public final CommentMetadata commentMetadata()

Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

Returns:

Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

toBuilder

public Activity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Activity.Builder,Activity>

builder

public static Activity.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo