Class: Google::Apis::DriveV2::About

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

Overview

An item with user information and settings.

Defined Under Namespace

Classes: AdditionalRoleInfo, DriveTheme, ExportFormat, Feature, ImportFormat, MaxUploadSize, QuotaBytesByService, TeamDriveTheme

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) ⇒ About

Returns a new instance of About.


183
184
185
# File 'generated/google/apis/drive_v2/classes.rb', line 183

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

Instance Attribute Details

#additional_role_infoArray<Google::Apis::DriveV2::About::AdditionalRoleInfo>

Information about supported additional roles per file type. The most specific type takes precedence. Corresponds to the JSON property additionalRoleInfo


33
34
35
# File 'generated/google/apis/drive_v2/classes.rb', line 33

def additional_role_info
  @additional_role_info
end

#can_create_drivesBoolean Also known as: can_create_drives?

Whether the user can create shared drives. Corresponds to the JSON property canCreateDrives

Returns:

  • (Boolean)

38
39
40
# File 'generated/google/apis/drive_v2/classes.rb', line 38

def can_create_drives
  @can_create_drives
end

#can_create_team_drivesBoolean Also known as: can_create_team_drives?

Deprecated - use canCreateDrives instead. Corresponds to the JSON property canCreateTeamDrives

Returns:

  • (Boolean)

44
45
46
# File 'generated/google/apis/drive_v2/classes.rb', line 44

def can_create_team_drives
  @can_create_team_drives
end

#domain_sharing_policyString

The domain sharing policy for the current user. Possible values are:

  • allowed
  • allowedWithWarning
  • incomingOnly
  • disallowed Corresponds to the JSON property domainSharingPolicy

Returns:

  • (String)

54
55
56
# File 'generated/google/apis/drive_v2/classes.rb', line 54

def domain_sharing_policy
  @domain_sharing_policy
end

#drive_themesArray<Google::Apis::DriveV2::About::DriveTheme>

A list of themes that are supported for shared drives. Corresponds to the JSON property driveThemes


59
60
61
# File 'generated/google/apis/drive_v2/classes.rb', line 59

def drive_themes
  @drive_themes
end

#etagString

The ETag of the item. Corresponds to the JSON property etag

Returns:

  • (String)

64
65
66
# File 'generated/google/apis/drive_v2/classes.rb', line 64

def etag
  @etag
end

#export_formatsArray<Google::Apis::DriveV2::About::ExportFormat>

The allowable export formats. Corresponds to the JSON property exportFormats


69
70
71
# File 'generated/google/apis/drive_v2/classes.rb', line 69

def export_formats
  @export_formats
end

#featuresArray<Google::Apis::DriveV2::About::Feature>

List of additional features enabled on this account. Corresponds to the JSON property features


74
75
76
# File 'generated/google/apis/drive_v2/classes.rb', line 74

def features
  @features
end

#folder_color_paletteArray<String>

The palette of allowable folder colors as RGB hex strings. Corresponds to the JSON property folderColorPalette

Returns:

  • (Array<String>)

79
80
81
# File 'generated/google/apis/drive_v2/classes.rb', line 79

def folder_color_palette
  @folder_color_palette
end

#import_formatsArray<Google::Apis::DriveV2::About::ImportFormat>

The allowable import formats. Corresponds to the JSON property importFormats


84
85
86
# File 'generated/google/apis/drive_v2/classes.rb', line 84

def import_formats
  @import_formats
end

#is_current_app_installedBoolean Also known as: is_current_app_installed?

A boolean indicating whether the authenticated app is installed by the authenticated user. Corresponds to the JSON property isCurrentAppInstalled

Returns:

  • (Boolean)

90
91
92
# File 'generated/google/apis/drive_v2/classes.rb', line 90

def is_current_app_installed
  @is_current_app_installed
end

#kindString

This is always drive#about. Corresponds to the JSON property kind

Returns:

  • (String)

96
97
98
# File 'generated/google/apis/drive_v2/classes.rb', line 96

def kind
  @kind
end

#language_codeString

The user's language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/). Corresponds to the JSON property languageCode

Returns:

  • (String)

102
103
104
# File 'generated/google/apis/drive_v2/classes.rb', line 102

def language_code
  @language_code
end

#largest_change_idFixnum

The largest change id. Corresponds to the JSON property largestChangeId

Returns:

  • (Fixnum)

107
108
109
# File 'generated/google/apis/drive_v2/classes.rb', line 107

def largest_change_id
  @largest_change_id
end

#max_upload_sizesArray<Google::Apis::DriveV2::About::MaxUploadSize>

List of max upload sizes for each file type. The most specific type takes precedence. Corresponds to the JSON property maxUploadSizes


113
114
115
# File 'generated/google/apis/drive_v2/classes.rb', line 113

def max_upload_sizes
  @max_upload_sizes
end

#nameString

The name of the current user. Corresponds to the JSON property name

Returns:

  • (String)

118
119
120
# File 'generated/google/apis/drive_v2/classes.rb', line 118

def name
  @name
end

#permission_idString

The current user's ID as visible in the permissions collection. Corresponds to the JSON property permissionId

Returns:

  • (String)

123
124
125
# File 'generated/google/apis/drive_v2/classes.rb', line 123

def permission_id
  @permission_id
end

#quota_bytes_by_serviceArray<Google::Apis::DriveV2::About::QuotaBytesByService>

The amount of storage quota used by different Google services. Corresponds to the JSON property quotaBytesByService


128
129
130
# File 'generated/google/apis/drive_v2/classes.rb', line 128

def quota_bytes_by_service
  @quota_bytes_by_service
end

#quota_bytes_totalFixnum

The total number of quota bytes. This is only relevant when quotaType is LIMITED. Corresponds to the JSON property quotaBytesTotal

Returns:

  • (Fixnum)

134
135
136
# File 'generated/google/apis/drive_v2/classes.rb', line 134

def quota_bytes_total
  @quota_bytes_total
end

#quota_bytes_usedFixnum

The number of quota bytes used by Google Drive. Corresponds to the JSON property quotaBytesUsed

Returns:

  • (Fixnum)

139
140
141
# File 'generated/google/apis/drive_v2/classes.rb', line 139

def quota_bytes_used
  @quota_bytes_used
end

#quota_bytes_used_aggregateFixnum

The number of quota bytes used by all Google apps (Drive, Picasa, etc.). Corresponds to the JSON property quotaBytesUsedAggregate

Returns:

  • (Fixnum)

144
145
146
# File 'generated/google/apis/drive_v2/classes.rb', line 144

def quota_bytes_used_aggregate
  @quota_bytes_used_aggregate
end

#quota_bytes_used_in_trashFixnum

The number of quota bytes used by trashed items. Corresponds to the JSON property quotaBytesUsedInTrash

Returns:

  • (Fixnum)

149
150
151
# File 'generated/google/apis/drive_v2/classes.rb', line 149

def quota_bytes_used_in_trash
  @quota_bytes_used_in_trash
end

#quota_typeString

The type of the user's storage quota. Possible values are:

  • LIMITED
  • UNLIMITED Corresponds to the JSON property quotaType

Returns:

  • (String)

156
157
158
# File 'generated/google/apis/drive_v2/classes.rb', line 156

def quota_type
  @quota_type
end

#remaining_change_idsFixnum

The number of remaining change ids, limited to no more than 2500. Corresponds to the JSON property remainingChangeIds

Returns:

  • (Fixnum)

161
162
163
# File 'generated/google/apis/drive_v2/classes.rb', line 161

def remaining_change_ids
  @remaining_change_ids
end

#root_folder_idString

The id of the root folder. Corresponds to the JSON property rootFolderId

Returns:

  • (String)

166
167
168
# File 'generated/google/apis/drive_v2/classes.rb', line 166

def root_folder_id
  @root_folder_id
end

A link back to this item. Corresponds to the JSON property selfLink

Returns:

  • (String)

171
172
173
# File 'generated/google/apis/drive_v2/classes.rb', line 171

def self_link
  @self_link
end

#team_drive_themesArray<Google::Apis::DriveV2::About::TeamDriveTheme>

Deprecated - use driveThemes instead. Corresponds to the JSON property teamDriveThemes


176
177
178
# File 'generated/google/apis/drive_v2/classes.rb', line 176

def team_drive_themes
  @team_drive_themes
end

#userGoogle::Apis::DriveV2::User

Information about a Drive user. Corresponds to the JSON property user


181
182
183
# File 'generated/google/apis/drive_v2/classes.rb', line 181

def user
  @user
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'generated/google/apis/drive_v2/classes.rb', line 188

def update!(**args)
  @additional_role_info = args[:additional_role_info] if args.key?(:additional_role_info)
  @can_create_drives = args[:can_create_drives] if args.key?(:can_create_drives)
  @can_create_team_drives = args[:can_create_team_drives] if args.key?(:can_create_team_drives)
  @domain_sharing_policy = args[:domain_sharing_policy] if args.key?(:domain_sharing_policy)
  @drive_themes = args[:drive_themes] if args.key?(:drive_themes)
  @etag = args[:etag] if args.key?(:etag)
  @export_formats = args[:export_formats] if args.key?(:export_formats)
  @features = args[:features] if args.key?(:features)
  @folder_color_palette = args[:folder_color_palette] if args.key?(:folder_color_palette)
  @import_formats = args[:import_formats] if args.key?(:import_formats)
  @is_current_app_installed = args[:is_current_app_installed] if args.key?(:is_current_app_installed)
  @kind = args[:kind] if args.key?(:kind)
  @language_code = args[:language_code] if args.key?(:language_code)
  @largest_change_id = args[:largest_change_id] if args.key?(:largest_change_id)
  @max_upload_sizes = args[:max_upload_sizes] if args.key?(:max_upload_sizes)
  @name = args[:name] if args.key?(:name)
  @permission_id = args[:permission_id] if args.key?(:permission_id)
  @quota_bytes_by_service = args[:quota_bytes_by_service] if args.key?(:quota_bytes_by_service)
  @quota_bytes_total = args[:quota_bytes_total] if args.key?(:quota_bytes_total)
  @quota_bytes_used = args[:quota_bytes_used] if args.key?(:quota_bytes_used)
  @quota_bytes_used_aggregate = args[:quota_bytes_used_aggregate] if args.key?(:quota_bytes_used_aggregate)
  @quota_bytes_used_in_trash = args[:quota_bytes_used_in_trash] if args.key?(:quota_bytes_used_in_trash)
  @quota_type = args[:quota_type] if args.key?(:quota_type)
  @remaining_change_ids = args[:remaining_change_ids] if args.key?(:remaining_change_ids)
  @root_folder_id = args[:root_folder_id] if args.key?(:root_folder_id)
  @self_link = args[:self_link] if args.key?(:self_link)
  @team_drive_themes = args[:team_drive_themes] if args.key?(:team_drive_themes)
  @user = args[:user] if args.key?(:user)
end