com.amazonaws.services.workdocs.model

Class DescribeActivitiesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workdocs.model.DescribeActivitiesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeActivitiesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeActivitiesRequest()

Method Summary

Modifier and Type	Method and Description
DescribeActivitiesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getActivityTypes() Specifies which activity types to include in the response.
String	getAuthenticationToken() Amazon WorkDocs authentication token.
Date	getEndTime() The timestamp that determines the end time of the activities.
Boolean	getIncludeIndirectActivities() Includes indirect activities.
Integer	getLimit() The maximum number of items to return.
String	getMarker() The marker for the next set of results.
String	getOrganizationId() The ID of the organization.
String	getResourceId() The document or folder ID for which to describe activity types.
Date	getStartTime() The timestamp that determines the starting time of the activities.
String	getUserId() The ID of the user who performed the action.
int	hashCode()
Boolean	isIncludeIndirectActivities() Includes indirect activities.
void	setActivityTypes(String activityTypes) Specifies which activity types to include in the response.
void	setAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
void	setEndTime(Date endTime) The timestamp that determines the end time of the activities.
void	setIncludeIndirectActivities(Boolean includeIndirectActivities) Includes indirect activities.
void	setLimit(Integer limit) The maximum number of items to return.
void	setMarker(String marker) The marker for the next set of results.
void	setOrganizationId(String organizationId) The ID of the organization.
void	setResourceId(String resourceId) The document or folder ID for which to describe activity types.
void	setStartTime(Date startTime) The timestamp that determines the starting time of the activities.
void	setUserId(String userId) The ID of the user who performed the action.
String	toString() Returns a string representation of this object.
DescribeActivitiesRequest	withActivityTypes(String activityTypes) Specifies which activity types to include in the response.
DescribeActivitiesRequest	withAuthenticationToken(String authenticationToken) Amazon WorkDocs authentication token.
DescribeActivitiesRequest	withEndTime(Date endTime) The timestamp that determines the end time of the activities.
DescribeActivitiesRequest	withIncludeIndirectActivities(Boolean includeIndirectActivities) Includes indirect activities.
DescribeActivitiesRequest	withLimit(Integer limit) The maximum number of items to return.
DescribeActivitiesRequest	withMarker(String marker) The marker for the next set of results.
DescribeActivitiesRequest	withOrganizationId(String organizationId) The ID of the organization.
DescribeActivitiesRequest	withResourceId(String resourceId) The document or folder ID for which to describe activity types.
DescribeActivitiesRequest	withStartTime(Date startTime) The timestamp that determines the starting time of the activities.
DescribeActivitiesRequest	withUserId(String userId) The ID of the user who performed the action.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeActivitiesRequest

public DescribeActivitiesRequest()

Method Detail

setAuthenticationToken

public void setAuthenticationToken(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.

getAuthenticationToken

public String getAuthenticationToken()

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.

withAuthenticationToken

public DescribeActivitiesRequest withAuthenticationToken(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.

setStartTime

public void setStartTime(Date 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.

getStartTime

public Date getStartTime()

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.

withStartTime

public DescribeActivitiesRequest withStartTime(Date 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.

setEndTime

public void setEndTime(Date 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.

getEndTime

public Date getEndTime()

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.

withEndTime

public DescribeActivitiesRequest withEndTime(Date 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.

setOrganizationId

public void setOrganizationId(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.

getOrganizationId

public String getOrganizationId()

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.

withOrganizationId

public DescribeActivitiesRequest withOrganizationId(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.

setActivityTypes

public void setActivityTypes(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.

getActivityTypes

public String getActivityTypes()

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.

withActivityTypes

public DescribeActivitiesRequest withActivityTypes(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.

setResourceId

public void setResourceId(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.

getResourceId

public String getResourceId()

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

Returns:

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

withResourceId

public DescribeActivitiesRequest withResourceId(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.

setUserId

public void setUserId(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.

getUserId

public String getUserId()

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.

withUserId

public DescribeActivitiesRequest withUserId(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.

setIncludeIndirectActivities

public void setIncludeIndirectActivities(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).

getIncludeIndirectActivities

public Boolean getIncludeIndirectActivities()

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

withIncludeIndirectActivities

public DescribeActivitiesRequest withIncludeIndirectActivities(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.

isIncludeIndirectActivities

public Boolean isIncludeIndirectActivities()

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

setLimit

public void setLimit(Integer limit)

The maximum number of items to return.

Parameters:

limit - The maximum number of items to return.

getLimit

public Integer getLimit()

The maximum number of items to return.

Returns:

The maximum number of items to return.

withLimit

public DescribeActivitiesRequest withLimit(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.

setMarker

public void setMarker(String marker)

The marker for the next set of results.

Parameters:

marker - The marker for the next set of results.

getMarker

public String getMarker()

The marker for the next set of results.

Returns:

The marker for the next set of results.

withMarker

public DescribeActivitiesRequest withMarker(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeActivitiesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()