Package io.getstream.client

Class QueryAuditLogsFilters

java.lang.Object
io.getstream.client.QueryAuditLogsFilters
public class QueryAuditLogsFilters extends Object
Filters for querying audit logs. Either entityType+entityID pair OR userID is required by the API. Common entity types in Stream include: - "activity" - for feed activities - "reaction" - for activity reactions - "user" - for Stream users - "feed" - for feed configurations

  • Method Details

    • builder

      public static QueryAuditLogsFilters.Builder builder()
      Creates a new builder for QueryAuditLogsFilters.
      Returns:
      a new QueryAuditLogsFilters.Builder

    • forUser

      public static QueryAuditLogsFilters forUser(String userID)
      Creates a new filter for user ID queries.
      Parameters:
      userID - The ID of the user
      Returns:
      a new QueryAuditLogsFilters with the user ID set

    • forEntity

      public static QueryAuditLogsFilters forEntity(String entityType, String entityID)
      Creates a new filter for entity type and ID queries.
      Parameters:
      entityType - The type of entity (e.g., "activity", "reaction", "user", "feed")
      entityID - The ID of the entity
      Returns:
      a new QueryAuditLogsFilters with the entity type and ID set

    • forActivity

      public static QueryAuditLogsFilters forActivity(String activityID)
      Convenience method to create a filter for activity entities.
      Parameters:
      activityID - The ID of the activity
      Returns:
      a new QueryAuditLogsFilters for the activity

    • forReaction

      public static QueryAuditLogsFilters forReaction(String reactionID)
      Convenience method to create a filter for reaction entities.
      Parameters:
      reactionID - The ID of the reaction
      Returns:
      a new QueryAuditLogsFilters for the reaction

    • getEntityType

      public String getEntityType()

    • getEntityID

      public String getEntityID()

    • getUserID

      public String getUserID()

    • setEntityType

      public QueryAuditLogsFilters setEntityType(String entityType)
      Set the entity type for existing filter instance.
      Parameters:
      entityType - The type of entity (e.g., "activity", "reaction")
      Returns:
      this instance for method chaining

    • setEntityID

      public QueryAuditLogsFilters setEntityID(String entityID)
      Set the entity ID for existing filter instance.
      Parameters:
      entityID - The ID of the entity
      Returns:
      this instance for method chaining

    • setUserID

      public QueryAuditLogsFilters setUserID(String userID)
      Set the user ID for existing filter instance.
      Parameters:
      userID - The ID of the user
      Returns:
      this instance for method chaining

    • validate

      public void validate() throws StreamException
      Validates that the filters contain the required fields. Either (entityType AND entityID) OR userID must be set.
      Throws:
      StreamException - if the required fields are not set

    • isValid

      public boolean isValid()
      Checks if the filter is valid according to API requirements.
      Returns:
      true if either (entityType AND entityID) OR userID is set