Package software.amazon.awssdk.services.workdocs.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeActivitiesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	activityTypes()	Specifies which activity types to include in the response.
String	authenticationToken()	Amazon WorkDocs authentication token.
static DescribeActivitiesRequest.Builder	builder()
Instant	endTime()	The timestamp that determines the end time of the activities.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeIndirectActivities()	Includes indirect activities.
Integer	limit()	The maximum number of items to return.
String	marker()	The marker for the next set of results.
String	organizationId()	The ID of the organization.
String	resourceId()	The document or folder ID for which to describe activity types.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeActivitiesRequest.Builder>	serializableBuilderClass()
Instant	startTime()	The timestamp that determines the starting time of the activities.
DescribeActivitiesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The ID of the user who performed the action.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeActivitiesRequest.Builder,DescribeActivitiesRequest>

Specified by:

toBuilder in class WorkDocsRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo