Class DescribeActivitiesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.workdocs.model.WorkDocsRequest
software.amazon.awssdk.services.workdocs.model.DescribeActivitiesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeActivitiesRequest.Builder,DescribeActivitiesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeActivitiesRequest extends WorkDocsRequest implements ToCopyableBuilder<DescribeActivitiesRequest.Builder,DescribeActivitiesRequest>

  • Method Details

    • authenticationToken

      public final String authenticationToken()

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

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

    • startTime

      public final Instant startTime()

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

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

    • endTime

      public final Instant endTime()

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

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

    • organizationId

      public final String organizationId()

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

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

    • activityTypes

      public final String activityTypes()

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

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

    • resourceId

      public final String resourceId()

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

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

    • userId

      public final 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.

      Returns:
      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.

    • includeIndirectActivities

      public final 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).

      Returns:
      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).

    • limit

      public final Integer limit()

      The maximum number of items to return.

      Returns:
      The maximum number of items to return.

    • marker

      public final String marker()

      The marker for the next set of results.

      Returns:
      The marker for the next set of results.

    • toBuilder

      public DescribeActivitiesRequest.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<DescribeActivitiesRequest.Builder,DescribeActivitiesRequest>
      Specified by:
      toBuilder in class WorkDocsRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeActivitiesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeActivitiesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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