Interface DescribeActivitiesRequest.Builder

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

  • Method Details

    • authenticationToken

      DescribeActivitiesRequest.Builder authenticationToken(String authenticationToken)

      Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

      Parameters:
      authenticationToken - Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      DescribeActivitiesRequest.Builder startTime(Instant startTime)

      The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

      Parameters:
      startTime - The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      DescribeActivitiesRequest.Builder endTime(Instant endTime)

      The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

      Parameters:
      endTime - The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • organizationId

      DescribeActivitiesRequest.Builder organizationId(String organizationId)

      The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

      Parameters:
      organizationId - The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activityTypes

      DescribeActivitiesRequest.Builder activityTypes(String activityTypes)

      Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

      Parameters:
      activityTypes - Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceId

      DescribeActivitiesRequest.Builder resourceId(String resourceId)

      The document or folder ID for which to describe activity types.

      Parameters:
      resourceId - The document or folder ID for which to describe activity types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      DescribeActivitiesRequest.Builder userId(String userId)

      The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.

      Parameters:
      userId - The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeIndirectActivities

      DescribeActivitiesRequest.Builder includeIndirectActivities(Boolean includeIndirectActivities)

      Includes indirect activities. 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:
      includeIndirectActivities - Includes indirect activities. 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.

    • limit

      DescribeActivitiesRequest.Builder limit(Integer limit)

      The maximum number of items to return.

      Parameters:
      limit - The maximum number of items to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • marker

      DescribeActivitiesRequest.Builder marker(String marker)

      The marker for the next set of results.

      Parameters:
      marker - The marker for the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeActivitiesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeActivitiesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.