Interface Activity.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Activity.Builder,Activity>, SdkBuilder<Activity.Builder,Activity>, SdkPojo
Enclosing class:
Activity
@Mutable @NotThreadSafe public static interface Activity.Builder extends SdkPojo, CopyableBuilder<Activity.Builder,Activity>

  • Method Details

    • type

      Activity.Builder type(String type)

      The activity type.

      Parameters:
      type - The activity type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      Activity.Builder type(ActivityType type)

      The activity type.

      Parameters:
      type - The activity type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timeStamp

      Activity.Builder timeStamp(Instant timeStamp)

      The timestamp when the action was performed.

      Parameters:
      timeStamp - The timestamp when the action was performed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isIndirectActivity

      Activity.Builder isIndirectActivity(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • organizationId

      Activity.Builder organizationId(String organizationId)

      The ID of the organization.

      Parameters:
      organizationId - The ID of the organization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initiator

      Activity.Builder initiator(UserMetadata initiator)

      The user who performed the action.

      Parameters:
      initiator - The user who performed the action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initiator

      default Activity.Builder initiator(Consumer<UserMetadata.Builder> initiator)

      The user who performed the action.

      This is a convenience method that creates an instance of the UserMetadata.Builder avoiding the need to create one manually via UserMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to initiator(UserMetadata).

      Parameters:
      initiator - a consumer that will call methods on UserMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • participants

      Activity.Builder participants(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • participants

      default Activity.Builder participants(Consumer<Participants.Builder> 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.

      This is a convenience method that creates an instance of the Participants.Builder avoiding the need to create one manually via Participants.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to participants(Participants).

      Parameters:
      participants - a consumer that will call methods on Participants.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceMetadata

      Activity.Builder resourceMetadata(ResourceMetadata resourceMetadata)

      The metadata of the resource involved in the user action.

      Parameters:
      resourceMetadata - The metadata of the resource involved in the user action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceMetadata

      default Activity.Builder resourceMetadata(Consumer<ResourceMetadata.Builder> resourceMetadata)

      The metadata of the resource involved in the user action.

      This is a convenience method that creates an instance of the ResourceMetadata.Builder avoiding the need to create one manually via ResourceMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceMetadata(ResourceMetadata).

      Parameters:
      resourceMetadata - a consumer that will call methods on ResourceMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • originalParent

      Activity.Builder originalParent(ResourceMetadata originalParent)

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

      Parameters:
      originalParent - The original parent of the resource. This is an optional field and is filled for move activities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originalParent

      default Activity.Builder originalParent(Consumer<ResourceMetadata.Builder> originalParent)

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

      This is a convenience method that creates an instance of the ResourceMetadata.Builder avoiding the need to create one manually via ResourceMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to originalParent(ResourceMetadata).

      Parameters:
      originalParent - a consumer that will call methods on ResourceMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • commentMetadata

      Activity.Builder commentMetadata(CommentMetadata commentMetadata)

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

      Parameters:
      commentMetadata - Metadata of the commenting activity. This is an optional field and is filled for commenting activities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • commentMetadata

      default Activity.Builder commentMetadata(Consumer<CommentMetadata.Builder> commentMetadata)

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

      This is a convenience method that creates an instance of the CommentMetadata.Builder avoiding the need to create one manually via CommentMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to commentMetadata(CommentMetadata).

      Parameters:
      commentMetadata - a consumer that will call methods on CommentMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: