Class: Google::Apis::DriveV2::Drive

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

Representation of a shared drive.

Defined Under Namespace

Classes: BackgroundImageFile, Capabilities, Restrictions

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

Returns a new instance of Drive



1412
1413
1414
# File 'generated/google/apis/drive_v2/classes.rb', line 1412

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

Instance Attribute Details

#background_image_fileGoogle::Apis::DriveV2::Drive::BackgroundImageFile

An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive. drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set. Corresponds to the JSON property backgroundImageFile



1352
1353
1354
# File 'generated/google/apis/drive_v2/classes.rb', line 1352

def background_image_file
  @background_image_file
end

A short-lived link to this shared drive's background image. Corresponds to the JSON property backgroundImageLink

Returns:

  • (String)


1357
1358
1359
# File 'generated/google/apis/drive_v2/classes.rb', line 1357

def background_image_link
  @background_image_link
end

#capabilitiesGoogle::Apis::DriveV2::Drive::Capabilities

Capabilities the current user has on this shared drive. Corresponds to the JSON property capabilities



1362
1363
1364
# File 'generated/google/apis/drive_v2/classes.rb', line 1362

def capabilities
  @capabilities
end

#color_rgbString

The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId. Corresponds to the JSON property colorRgb

Returns:

  • (String)


1368
1369
1370
# File 'generated/google/apis/drive_v2/classes.rb', line 1368

def color_rgb
  @color_rgb
end

#created_dateDateTime

The time at which the shared drive was created (RFC 3339 date-time). Corresponds to the JSON property createdDate

Returns:

  • (DateTime)


1373
1374
1375
# File 'generated/google/apis/drive_v2/classes.rb', line 1373

def created_date
  @created_date
end

#hiddenBoolean Also known as: hidden?

Whether the shared drive is hidden from default view. Corresponds to the JSON property hidden

Returns:

  • (Boolean)


1378
1379
1380
# File 'generated/google/apis/drive_v2/classes.rb', line 1378

def hidden
  @hidden
end

#idString

The ID of this shared drive which is also the ID of the top level folder of this shared drive. Corresponds to the JSON property id

Returns:

  • (String)


1385
1386
1387
# File 'generated/google/apis/drive_v2/classes.rb', line 1385

def id
  @id
end

#kindString

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

Returns:

  • (String)


1390
1391
1392
# File 'generated/google/apis/drive_v2/classes.rb', line 1390

def kind
  @kind
end

#nameString

The name of this shared drive. Corresponds to the JSON property name

Returns:

  • (String)


1395
1396
1397
# File 'generated/google/apis/drive_v2/classes.rb', line 1395

def name
  @name
end

#restrictionsGoogle::Apis::DriveV2::Drive::Restrictions

A set of restrictions that apply to this shared drive or items inside this shared drive. Corresponds to the JSON property restrictions



1401
1402
1403
# File 'generated/google/apis/drive_v2/classes.rb', line 1401

def restrictions
  @restrictions
end

#theme_idString

The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.insert request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile. Corresponds to the JSON property themeId

Returns:

  • (String)


1410
1411
1412
# File 'generated/google/apis/drive_v2/classes.rb', line 1410

def theme_id
  @theme_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'generated/google/apis/drive_v2/classes.rb', line 1417

def update!(**args)
  @background_image_file = args[:background_image_file] if args.key?(:background_image_file)
  @background_image_link = args[:background_image_link] if args.key?(:background_image_link)
  @capabilities = args[:capabilities] if args.key?(:capabilities)
  @color_rgb = args[:color_rgb] if args.key?(:color_rgb)
  @created_date = args[:created_date] if args.key?(:created_date)
  @hidden = args[:hidden] if args.key?(:hidden)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @restrictions = args[:restrictions] if args.key?(:restrictions)
  @theme_id = args[:theme_id] if args.key?(:theme_id)
end