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(value="software.amazon.awssdk:codegen")
public final class DescribeActivitiesRequest
extends WorkDocsRequest
implements ToCopyableBuilder<DescribeActivitiesRequest.Builder,DescribeActivitiesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeActivitiesRequest.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeActivitiesRequest.Builder>	serializableBuilderClass()
Instant	startTime() The timestamp that determines the starting time of the activities.
DescribeActivitiesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

authenticationToken

public String authenticationToken()

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

Returns:

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

startTime

public 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 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 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 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 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 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 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 Integer limit()

The maximum number of items to return.

Returns:

The maximum number of items to return.

marker

public 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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