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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<Activity.Builder,Activity>
      Returns:
      a builder for type T

    • 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)
      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.