/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the workdocs-2016-05-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.WorkDocs.Model
{
///
/// Container for the parameters to the DescribeActivities operation.
/// Describes the user activities in a specified time period.
///
public partial class DescribeActivitiesRequest : AmazonWorkDocsRequest
{
private string _activityTypes;
private string _authenticationToken;
private DateTime? _endTimeUtc;
private bool? _includeIndirectActivities;
private int? _limit;
private string _marker;
private string _organizationId;
private string _resourceId;
private DateTime? _startTimeUtc;
private string _userId;
///
/// Gets and sets the property ActivityTypes.
///
/// Specifies which activity types to include in the response. If this field is left empty,
/// all activity types are returned.
///
///
[AWSProperty(Min=1, Max=1024)]
public string ActivityTypes
{
get { return this._activityTypes; }
set { this._activityTypes = value; }
}
// Check to see if ActivityTypes property is set
internal bool IsSetActivityTypes()
{
return this._activityTypes != null;
}
///
/// Gets and sets the property AuthenticationToken.
///
/// Amazon WorkDocs authentication token. Not required when using Amazon Web Services
/// administrator credentials to access the API.
///
///
[AWSProperty(Sensitive=true, Min=1, Max=8199)]
public string AuthenticationToken
{
get { return this._authenticationToken; }
set { this._authenticationToken = value; }
}
// Check to see if AuthenticationToken property is set
internal bool IsSetAuthenticationToken()
{
return this._authenticationToken != null;
}
///
/// Gets and sets the property EndTimeUtc.
///
/// The timestamp that determines the end time of the activities. The response includes
/// the activities performed before the specified timestamp.
///
///
public DateTime EndTimeUtc
{
get { return this._endTimeUtc.GetValueOrDefault(); }
set { this._endTime = this._endTimeUtc = value; }
}
// Check to see if EndTimeUtc property is set
internal bool IsSetEndTimeUtc()
{
return this._endTimeUtc.HasValue;
}
///
/// Gets and sets the property 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).
///
///
public bool IncludeIndirectActivities
{
get { return this._includeIndirectActivities.GetValueOrDefault(); }
set { this._includeIndirectActivities = value; }
}
// Check to see if IncludeIndirectActivities property is set
internal bool IsSetIncludeIndirectActivities()
{
return this._includeIndirectActivities.HasValue;
}
///
/// Gets and sets the property Limit.
///
/// The maximum number of items to return.
///
///
[AWSProperty(Min=1, Max=999)]
public int Limit
{
get { return this._limit.GetValueOrDefault(); }
set { this._limit = value; }
}
// Check to see if Limit property is set
internal bool IsSetLimit()
{
return this._limit.HasValue;
}
///
/// Gets and sets the property Marker.
///
/// The marker for the next set of results.
///
///
[AWSProperty(Min=1, Max=12288)]
public string Marker
{
get { return this._marker; }
set { this._marker = value; }
}
// Check to see if Marker property is set
internal bool IsSetMarker()
{
return this._marker != null;
}
///
/// Gets and sets the property OrganizationId.
///
/// The ID of the organization. This is a mandatory parameter when using administrative
/// API (SigV4) requests.
///
///
[AWSProperty(Min=1, Max=256)]
public string OrganizationId
{
get { return this._organizationId; }
set { this._organizationId = value; }
}
// Check to see if OrganizationId property is set
internal bool IsSetOrganizationId()
{
return this._organizationId != null;
}
///
/// Gets and sets the property ResourceId.
///
/// The document or folder ID for which to describe activity types.
///
///
[AWSProperty(Min=1, Max=256)]
public string ResourceId
{
get { return this._resourceId; }
set { this._resourceId = value; }
}
// Check to see if ResourceId property is set
internal bool IsSetResourceId()
{
return this._resourceId != null;
}
///
/// Gets and sets the property StartTimeUtc.
///
/// The timestamp that determines the starting time of the activities. The response includes
/// the activities performed after the specified timestamp.
///
///
public DateTime StartTimeUtc
{
get { return this._startTimeUtc.GetValueOrDefault(); }
set { this._startTime = this._startTimeUtc = value; }
}
// Check to see if StartTimeUtc property is set
internal bool IsSetStartTimeUtc()
{
return this._startTimeUtc.HasValue;
}
///
/// Gets and sets the property 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.
///
///
[AWSProperty(Min=1, Max=256)]
public string UserId
{
get { return this._userId; }
set { this._userId = value; }
}
// Check to see if UserId property is set
internal bool IsSetUserId()
{
return this._userId != null;
}
#region Backwards compatible properties
private DateTime? _endTime;
private DateTime? _startTime;
///
/// Gets and sets the property EndTimeUtc.
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc
/// results in both EndTime and EndTimeUtc being assigned, the latest assignment to either
/// one of the two property is reflected in the value of both. EndTime is provided for
/// backwards compatibility only and assigning a non-Utc DateTime to it results in the
/// wrong timestamp being passed to the service.
///
///
///
/// The timestamp that determines the end time of the activities. The response includes
/// the activities performed before the specified timestamp.
///
///
[Obsolete("Setting this property results in non-UTC DateTimes not being marshalled correctly. " +
"Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc results in both EndTime and " +
"EndTimeUtc being assigned, the latest assignment to either one of the two property is " +
"reflected in the value of both. EndTime is provided for backwards compatibility only and " +
"assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.", false)]
public DateTime EndTime
{
get { return this._endTime.GetValueOrDefault(); }
set
{
this._endTime = value;
this._endTimeUtc = new DateTime(value.Ticks, DateTimeKind.Utc);
}
}
///
/// Gets and sets the property StartTimeUtc.
///
/// This property is deprecated. Setting this property results in non-UTC DateTimes not
/// being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or
/// StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest
/// assignment to either one of the two property is reflected in the value of both. StartTime
/// is provided for backwards compatibility only and assigning a non-Utc DateTime to it
/// results in the wrong timestamp being passed to the service.
///
///
///
/// The timestamp that determines the starting time of the activities. The response includes
/// the activities performed after the specified timestamp.
///
///
[Obsolete("Setting this property results in non-UTC DateTimes not being marshalled correctly. " +
"Use StartTimeUtc instead. Setting either StartTime or StartTimeUtc results in both StartTime and " +
"StartTimeUtc being assigned, the latest assignment to either one of the two property is " +
"reflected in the value of both. StartTime is provided for backwards compatibility only and " +
"assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.", false)]
public DateTime StartTime
{
get { return this._startTime.GetValueOrDefault(); }
set
{
this._startTime = value;
this._startTimeUtc = new DateTime(value.Ticks, DateTimeKind.Utc);
}
}
#endregion
}
}