Class: Google::Apis::DriveactivityV2::QueryDriveActivityRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/driveactivity_v2/classes.rb,
generated/google/apis/driveactivity_v2/representations.rb,
generated/google/apis/driveactivity_v2/representations.rb

Overview

The request message for querying Drive activity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ QueryDriveActivityRequest

Returns a new instance of QueryDriveActivityRequest.


1143
1144
1145
# File 'generated/google/apis/driveactivity_v2/classes.rb', line 1143

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#ancestor_nameString

Return activities for this Drive folder and all children and descendants. The format is “items/ITEM_ID”. Corresponds to the JSON property ancestorName

Returns:

  • (String)

1098
1099
1100
# File 'generated/google/apis/driveactivity_v2/classes.rb', line 1098

def ancestor_name
  @ancestor_name
end

#consolidation_strategyGoogle::Apis::DriveactivityV2::ConsolidationStrategy

How the individual activities are consolidated. A set of activities may be consolidated into one combined activity if they are related in some way, such as one actor performing the same action on multiple targets, or multiple actors performing the same action on a single target. The strategy defines the rules for which activities are related. Corresponds to the JSON property consolidationStrategy


1107
1108
1109
# File 'generated/google/apis/driveactivity_v2/classes.rb', line 1107

def consolidation_strategy
  @consolidation_strategy
end

#filterString

The filtering for items returned from this query request. The format of the filter string is a sequence of expressions, joined by an optional “AND”, where each expression is of the form “field operator value”. Supported fields: - time: Uses numerical operators on date values either in terms of milliseconds since Jan 1, 1970 or in RFC 3339 format. Examples: - time > 1452409200000 AND time <= 1492812924310 - time >= “2016-01-10T01:02:03-05:00” - detail. action_detail_case: Uses the “has” operator (:) and either a singular value or a list of allowed action types enclosed in parentheses. Examples: - detail. action_detail_case: RENAME - detail.action_detail_case:(CREATE EDIT) - -detail. action_detail_case:MOVE Corresponds to the JSON property filter

Returns:

  • (String)

1121
1122
1123
# File 'generated/google/apis/driveactivity_v2/classes.rb', line 1121

def filter
  @filter
end

#item_nameString

Return activities for this Drive item. The format is “items/ITEM_ID”. Corresponds to the JSON property itemName

Returns:

  • (String)

1126
1127
1128
# File 'generated/google/apis/driveactivity_v2/classes.rb', line 1126

def item_name
  @item_name
end

#page_sizeFixnum

The miminum number of activities desired in the response; the server will attempt to return at least this quanitity. The server may also return fewer activities if it has a partial response ready before the request times out. If not set, a default value is used. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum)

1134
1135
1136
# File 'generated/google/apis/driveactivity_v2/classes.rb', line 1134

def page_size
  @page_size
end

#page_tokenString

The token identifying which page of results to return. Set this to the next_page_token value returned from a previous query to obtain the following page of results. If not set, the first page of results will be returned. Corresponds to the JSON property pageToken

Returns:

  • (String)

1141
1142
1143
# File 'generated/google/apis/driveactivity_v2/classes.rb', line 1141

def page_token
  @page_token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1148
1149
1150
1151
1152
1153
1154
1155
# File 'generated/google/apis/driveactivity_v2/classes.rb', line 1148

def update!(**args)
  @ancestor_name = args[:ancestor_name] if args.key?(:ancestor_name)
  @consolidation_strategy = args[:consolidation_strategy] if args.key?(:consolidation_strategy)
  @filter = args[:filter] if args.key?(:filter)
  @item_name = args[:item_name] if args.key?(:item_name)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
end